aliases

Documentation

Overview

Shows information about currently configured aliases to indices including filter and routing infos.

Index

• Variables
• type Aliases
  • func New(tp elastictransport.Interface) *Aliases
  • func (r Aliases) Do(ctx context.Context) (Response, error)
  • func (r *Aliases) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Aliases
  • func (r *Aliases) Header(key, value string) *Aliases
  • func (r *Aliases) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r Aliases) IsSuccess(ctx context.Context) (bool, error)
  • func (r *Aliases) Name(name string) *Aliases
  • func (r Aliases) Perform(ctx context.Context) (*http.Response, error)
• 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

Shows information about currently configured aliases to indices including filter and routing infos.

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

func (Aliases) Do

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

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

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) Header

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

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

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

func (r Aliases) 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 (*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(ctx context.Context) (*http.Response, error)

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

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