aliases

Documentation

Overview

Get aliases. Retrieves the cluster’s index aliases, including filter and routing information. The API does not return data stream aliases.

CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.

Index

• Variables
• type Aliases
  • func New(tp elastictransport.Interface) *Aliases
  • func (r Aliases) Do(providedCtx context.Context) (Response, error)
  • func (r *Aliases) ErrorTrace(errortrace bool) *Aliases
  • func (r *Aliases) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Aliases
  • func (r *Aliases) FilterPath(filterpaths ...string) *Aliases
  • func (r *Aliases) Format(format string) *Aliases
  • func (r *Aliases) H(names ...string) *Aliases
  • func (r *Aliases) Header(key, value string) *Aliases
  • func (r *Aliases) Help(help bool) *Aliases
  • func (r *Aliases) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Aliases) Human(human bool) *Aliases
  • func (r Aliases) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *Aliases) Local(local bool) *Aliases
  • func (r *Aliases) MasterTimeout(duration string) *Aliases
  • func (r *Aliases) Name(name string) *Aliases
  • func (r Aliases) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Aliases) Pretty(pretty bool) *Aliases
  • func (r *Aliases) S(names ...string) *Aliases
  • func (r *Aliases) V(v bool) *Aliases
• type NewAliases
  • func NewAliasesFunc(tp elastictransport.Interface) NewAliases
• 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 Aliases

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

func New

func New(tp elastictransport.Interface) *Aliases

Get aliases. Retrieves the cluster’s index aliases, including filter and routing information. The API does not return data stream aliases.

CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.

https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-alias.html

func (Aliases) Do

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

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

func (*Aliases) ErrorTrace

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

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

func (*Aliases) ExpandWildcards

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

ExpandWildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. API name: expand_wildcards

func (*Aliases) FilterPath

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

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

func (*Aliases) Format

func (r *Aliases) Format(format string) *Aliases

Format Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. API name: format

func (*Aliases) H

func (r *Aliases) H(names ...string) *Aliases

H List of columns to appear in the response. Supports simple wildcards. API name: h

func (*Aliases) Header

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

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

func (*Aliases) Help

func (r *Aliases) Help(help bool) *Aliases

Help When set to `true` will output available columns. This option can't be combined with any other query string option. API name: help

func (*Aliases) HttpRequest

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

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

func (*Aliases) Human

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

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

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

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

Local If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. API name: local

func (*Aliases) MasterTimeout

func (r *Aliases) MasterTimeout(duration string) *Aliases

MasterTimeout Period to wait for a connection to the master node. API name: master_timeout

func (*Aliases) Name

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

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

func (Aliases) Perform

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

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

func (*Aliases) Pretty

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

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

func (*Aliases) S

func (r *Aliases) S(names ...string) *Aliases

S List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. API name: s

func (*Aliases) V

func (r *Aliases) V(v bool) *Aliases

V When set to `true` will enable verbose output. API name: v

type NewAliases

type NewAliases func() *Aliases

NewAliases type alias for index.

func NewAliasesFunc

func NewAliasesFunc(tp elastictransport.Interface) NewAliases

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

type Response

type Response []types.AliasesRecord

func NewResponse

func NewResponse() Response

NewResponse returns a Response