existsalias

Documentation

Overview

Returns information about whether a particular alias exists.

Index

• Variables
• type ExistsAlias
  • func New(tp elastictransport.Interface) *ExistsAlias
  • func (r *ExistsAlias) AllowNoIndices(allownoindices bool) *ExistsAlias
  • func (r ExistsAlias) Do(ctx context.Context) (bool, error)
  • func (r *ExistsAlias) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *ExistsAlias
  • func (r *ExistsAlias) Header(key, value string) *ExistsAlias
  • func (r *ExistsAlias) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ExistsAlias) IgnoreUnavailable(ignoreunavailable bool) *ExistsAlias
  • func (r *ExistsAlias) Index(index string) *ExistsAlias
  • func (r ExistsAlias) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *ExistsAlias) Local(local bool) *ExistsAlias
  • func (r ExistsAlias) Perform(providedCtx context.Context) (*http.Response, error)
• type NewExistsAlias
  • func NewExistsAliasFunc(tp elastictransport.Interface) NewExistsAlias

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 ExistsAlias

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

func New

func New(tp elastictransport.Interface) *ExistsAlias

Returns information about whether a particular alias exists.

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

func (*ExistsAlias) AllowNoIndices

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

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 (ExistsAlias) Do

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

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

func (*ExistsAlias) ExpandWildcards

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

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 (*ExistsAlias) Header

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

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

func (*ExistsAlias) HttpRequest

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

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

func (*ExistsAlias) IgnoreUnavailable

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

IgnoreUnavailable If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. API name: ignore_unavailable

func (*ExistsAlias) Index

func (r *ExistsAlias) Index(index string) *ExistsAlias

Index Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. API Name: index

func (ExistsAlias) IsSuccess

func (r ExistsAlias) 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 (*ExistsAlias) Local

func (r *ExistsAlias) Local(local bool) *ExistsAlias

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

func (ExistsAlias) Perform

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

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

type NewExistsAlias

type NewExistsAlias func(name string) *ExistsAlias

NewExistsAlias type alias for index.

func NewExistsAliasFunc

func NewExistsAliasFunc(tp elastictransport.Interface) NewExistsAlias

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