getalias

package
v8.11.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 27, 2023 License: Apache-2.0 Imports: 14 Imported by: 4

Documentation

Overview

Returns an alias.

Index

Constants

This section is empty.

Variables

View Source
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.

Functions

This section is empty.

Types

type GetAlias

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

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(ctx context.Context) (Response, error)

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

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) 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(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(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(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 added in v8.7.0

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

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

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 added in v8.7.0

type Response map[string]types.IndexAliases

func NewResponse added in v8.7.0

func NewResponse() Response

NewResponse returns a Response

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL