exists

Documentation

Overview

Check indices. Checks if one or more indices, index aliases, or data streams exist.

Index

• Variables
• type Exists
  • func New(tp elastictransport.Interface) *Exists
  • func (r *Exists) AllowNoIndices(allownoindices bool) *Exists
  • func (r Exists) Do(ctx context.Context) (bool, error)
  • func (r *Exists) ErrorTrace(errortrace bool) *Exists
  • func (r *Exists) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Exists
  • func (r *Exists) FilterPath(filterpaths ...string) *Exists
  • func (r *Exists) FlatSettings(flatsettings bool) *Exists
  • func (r *Exists) Header(key, value string) *Exists
  • func (r *Exists) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Exists) Human(human bool) *Exists
  • func (r *Exists) IgnoreUnavailable(ignoreunavailable bool) *Exists
  • func (r *Exists) IncludeDefaults(includedefaults bool) *Exists
  • func (r Exists) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *Exists) Local(local bool) *Exists
  • func (r Exists) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Exists) Pretty(pretty 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

Check indices. Checks if one or more indices, index aliases, or data streams exist.

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

func (*Exists) AllowNoIndices

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

AllowNoIndices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. API name: allow_no_indices

func (Exists) Do

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

Do runs the request through the transport, handle the response and returns a exists.Response

func (*Exists) ErrorTrace

func (r *Exists) ErrorTrace(errortrace bool) *Exists

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*Exists) ExpandWildcards

func (r *Exists) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Exists

ExpandWildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. API name: expand_wildcards

func (*Exists) FilterPath

func (r *Exists) FilterPath(filterpaths ...string) *Exists

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*Exists) FlatSettings

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

FlatSettings If `true`, returns settings in flat format. 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) Human

func (r *Exists) Human(human bool) *Exists

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (*Exists) IgnoreUnavailable

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

IgnoreUnavailable If `false`, the request returns an error if it targets a missing or closed index. API name: ignore_unavailable

func (*Exists) IncludeDefaults

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

IncludeDefaults If `true`, return all default settings in the response. API name: include_defaults

func (Exists) IsSuccess

func (r Exists) IsSuccess(providedCtx 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(local bool) *Exists

Local If `true`, the request retrieves information from the local node only. API name: local

func (Exists) Perform

func (r Exists) Perform(providedCtx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*Exists) Pretty

func (r *Exists) Pretty(pretty bool) *Exists

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

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.