exists

Documentation

Overview

Returns information about whether a particular index exists.

Index

• Variables
• type Exists
  • func New(tp elastictransport.Interface) *Exists
  • func (r *Exists) AllowNoIndices(b bool) *Exists
  • func (r Exists) Do(ctx context.Context) (*http.Response, error)
  • func (r *Exists) ExpandWildcards(value string) *Exists
  • func (r *Exists) FlatSettings(b bool) *Exists
  • func (r *Exists) Header(key, value string) *Exists
  • func (r *Exists) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Exists) IgnoreUnavailable(b bool) *Exists
  • func (r *Exists) IncludeDefaults(b bool) *Exists
  • func (r *Exists) Index(v string) *Exists
  • func (r Exists) IsSuccess(ctx context.Context) (bool, error)
  • func (r *Exists) Local(b bool) *Exists
• type NewExists
  • func NewExistsFunc(tp elastictransport.Interface) NewExists

Variables

var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")

ErrBuildPath is returned in case of missing parameters within the build of the request.

Types

type Exists

type Exists struct {
	// contains filtered or unexported fields
}

func New

func New(tp elastictransport.Interface) *Exists

Returns information about whether a particular index exists.

https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html

func (*Exists) AllowNoIndices

func (r *Exists) AllowNoIndices(b bool) *Exists

AllowNoIndices Ignore if a wildcard expression resolves to no concrete indices (default: false) API name: allow_no_indices

func (Exists) Do

func (r Exists) Do(ctx context.Context) (*http.Response, error)

Do runs the http.Request through the provided transport.

func (*Exists) ExpandWildcards

func (r *Exists) ExpandWildcards(value string) *Exists

ExpandWildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) API name: expand_wildcards

func (*Exists) FlatSettings

func (r *Exists) FlatSettings(b bool) *Exists

FlatSettings Return settings in flat format (default: false) API name: flat_settings

func (*Exists) Header

func (r *Exists) Header(key, value string) *Exists

Header set a key, value pair in the Exists headers map.

func (*Exists) HttpRequest

func (r *Exists) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (*Exists) IgnoreUnavailable

func (r *Exists) IgnoreUnavailable(b bool) *Exists

IgnoreUnavailable Ignore unavailable indexes (default: false) API name: ignore_unavailable

func (*Exists) IncludeDefaults

func (r *Exists) IncludeDefaults(b bool) *Exists

IncludeDefaults Whether to return all default setting for each of the indices. API name: include_defaults

func (*Exists) Index

func (r *Exists) Index(v string) *Exists

Index A comma-separated list of index names API Name: index

func (Exists) IsSuccess

func (r Exists) IsSuccess(ctx context.Context) (bool, error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.

func (*Exists) Local

func (r *Exists) Local(b bool) *Exists

Local Return local information, do not retrieve the state from master node (default: false) API name: local

type NewExists

type NewExists func(index string) *Exists

NewExists type alias for index.

func NewExistsFunc

func NewExistsFunc(tp elastictransport.Interface) NewExists

NewExistsFunc returns a new instance of Exists with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.