getalias

Documentation

Overview

Returns an alias.

Index

• Variables
• type GetAlias
  • func New(tp elastictransport.Interface) *GetAlias
  • func (r *GetAlias) AllowNoIndices(b bool) *GetAlias
  • func (r GetAlias) Do(ctx context.Context) (*http.Response, error)
  • func (r *GetAlias) ExpandWildcards(value string) *GetAlias
  • func (r *GetAlias) Header(key, value string) *GetAlias
  • func (r *GetAlias) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetAlias) IgnoreUnavailable(b bool) *GetAlias
  • func (r *GetAlias) Index(v string) *GetAlias
  • func (r GetAlias) IsSuccess(ctx context.Context) (bool, error)
  • func (r *GetAlias) Local(b bool) *GetAlias
  • func (r *GetAlias) Name(v string) *GetAlias
• type NewGetAlias
  • func NewGetAliasFunc(tp elastictransport.Interface) NewGetAlias

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

Returns an alias.

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

func (*GetAlias) AllowNoIndices

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

AllowNoIndices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) API name: allow_no_indices

func (GetAlias) Do

func (r GetAlias) Do(ctx context.Context) (*http.Response, error)

Do runs the http.Request through the provided transport.

func (*GetAlias) ExpandWildcards

func (r *GetAlias) ExpandWildcards(value string) *GetAlias

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

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

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

IgnoreUnavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) API name: ignore_unavailable

func (*GetAlias) Index

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

Index A comma-separated list of index names to filter aliases API Name: index

func (GetAlias) IsSuccess

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

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

Local Return local information, do not retrieve the state from master node (default: false) API name: local

func (*GetAlias) Name

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

Name A comma-separated list of alias names to return API Name: name

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.