getalias

Documentation

Overview

Get aliases. Retrieves information for one or more data stream or index aliases.

Index

• Variables
• type GetAlias
  • func New(tp elastictransport.Interface) *GetAlias
  • func (r *GetAlias) AllowNoIndices(allownoindices bool) *GetAlias
  • func (r GetAlias) Do(providedCtx context.Context) (Response, error)
  • func (r *GetAlias) ErrorTrace(errortrace bool) *GetAlias
  • func (r *GetAlias) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *GetAlias
  • func (r *GetAlias) FilterPath(filterpaths ...string) *GetAlias
  • func (r *GetAlias) Header(key, value string) *GetAlias
  • func (r *GetAlias) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetAlias) Human(human bool) *GetAlias
  • func (r *GetAlias) IgnoreUnavailable(ignoreunavailable bool) *GetAlias
  • func (r *GetAlias) Index(index string) *GetAlias
  • func (r GetAlias) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *GetAlias) Local(local bool) *GetAlias
  • func (r *GetAlias) Name(name string) *GetAlias
  • func (r GetAlias) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetAlias) Pretty(pretty bool) *GetAlias
• type NewGetAlias
  • func NewGetAliasFunc(tp elastictransport.Interface) NewGetAlias
• type Response
  • func NewResponse() Response

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 GetAlias

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

func New

func New(tp elastictransport.Interface) *GetAlias

Get aliases. Retrieves information for one or more data stream or index aliases.

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

func (*GetAlias) AllowNoIndices

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

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

func (r GetAlias) Do(providedCtx context.Context) (Response, error)

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

func (*GetAlias) ErrorTrace

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

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

func (*GetAlias) ExpandWildcards

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

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 (*GetAlias) FilterPath

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

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

func (*GetAlias) Header

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

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

func (*GetAlias) HttpRequest

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

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

func (*GetAlias) Human

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

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 (*GetAlias) IgnoreUnavailable

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

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

func (*GetAlias) Index

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

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 (GetAlias) IsSuccess

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

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

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

func (*GetAlias) Name

func (r *GetAlias) Name(name string) *GetAlias

Name Comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. API Name: name

func (GetAlias) Perform

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

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

func (*GetAlias) Pretty

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

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

type NewGetAlias

type NewGetAlias func() *GetAlias

NewGetAlias type alias for index.

func NewGetAliasFunc

func NewGetAliasFunc(tp elastictransport.Interface) NewGetAlias

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

type Response

type Response map[string]types.IndexAliases

func NewResponse

func NewResponse() Response

NewResponse returns a Response