resolveindex

package
v8.14.2 Latest Latest
Warning

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

Go to latest
Published: May 10, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Overview

Returns information about any matching indices, aliases, and data streams

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 NewResolveIndex

type NewResolveIndex func(name string) *ResolveIndex

NewResolveIndex type alias for index.

func NewResolveIndexFunc

func NewResolveIndexFunc(tp elastictransport.Interface) NewResolveIndex

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

type ResolveIndex

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

func New

Returns information about any matching indices, aliases, and data streams

https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-resolve-index-api.html

func (ResolveIndex) Do

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

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

func (*ResolveIndex) ExpandWildcards

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

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 (*ResolveIndex) Header

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

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

func (*ResolveIndex) HttpRequest

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

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

func (ResolveIndex) IsSuccess

func (r ResolveIndex) 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 (ResolveIndex) Perform

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

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

type Response

type Response struct {
	Aliases     []types.ResolveIndexAliasItem       `json:"aliases"`
	DataStreams []types.ResolveIndexDataStreamsItem `json:"data_streams"`
	Indices     []types.ResolveIndexItem            `json:"indices"`
}

Response holds the response body struct for the package resolveindex

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/indices/resolve_index/ResolveIndexResponse.ts#L22-L28

func NewResponse

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