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(b bool) *ExistsAlias
  • func (r ExistsAlias) Do(ctx context.Context) (*Response, error)
  • func (r *ExistsAlias) ExpandWildcards(v string) *ExistsAlias
  • func (r *ExistsAlias) Header(key, value string) *ExistsAlias
  • func (r *ExistsAlias) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ExistsAlias) IgnoreUnavailable(b bool) *ExistsAlias
  • func (r *ExistsAlias) Index(v string) *ExistsAlias
  • func (r ExistsAlias) IsSuccess(ctx context.Context) (bool, error)
  • func (r *ExistsAlias) Local(b bool) *ExistsAlias
  • func (r *ExistsAlias) Name(v string) *ExistsAlias
  • func (r ExistsAlias) Perform(ctx context.Context) (*http.Response, error)
• type NewExistsAlias
  • func NewExistsAliasFunc(tp elastictransport.Interface) NewExistsAlias
• 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 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/master/indices-aliases.html

func (*ExistsAlias) AllowNoIndices

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

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

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

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

func (*ExistsAlias) ExpandWildcards

func (r *ExistsAlias) ExpandWildcards(v string) *ExistsAlias

ExpandWildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. 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(b bool) *ExistsAlias

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

func (*ExistsAlias) Index

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

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

func (ExistsAlias) IsSuccess

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

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

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

func (*ExistsAlias) Name

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

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

func (ExistsAlias) Perform

func (r ExistsAlias) Perform(ctx 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.

type Response

type Response struct {
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response