shardstores

Documentation

Overview

Provides store information for shard copies of indices.

Index

• Variables
• type NewShardStores
  • func NewShardStoresFunc(tp elastictransport.Interface) NewShardStores
• type Response
  • func NewResponse() *Response
• type ShardStores
  • func New(tp elastictransport.Interface) *ShardStores
  • func (r *ShardStores) AllowNoIndices(allownoindices bool) *ShardStores
  • func (r ShardStores) Do(providedCtx context.Context) (*Response, error)
  • func (r *ShardStores) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *ShardStores
  • func (r *ShardStores) Header(key, value string) *ShardStores
  • func (r *ShardStores) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ShardStores) IgnoreUnavailable(ignoreunavailable bool) *ShardStores
  • func (r *ShardStores) Index(index string) *ShardStores
  • func (r ShardStores) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r ShardStores) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *ShardStores) Status(statuses ...shardstorestatus.ShardStoreStatus) *ShardStores

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 NewShardStores

type NewShardStores func() *ShardStores

NewShardStores type alias for index.

func NewShardStoresFunc

func NewShardStoresFunc(tp elastictransport.Interface) NewShardStores

NewShardStoresFunc returns a new instance of ShardStores 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 {
	Indices map[string]types.IndicesShardStores `json:"indices"`
}

Response holds the response body struct for the package shardstores

https://github.com/elastic/elasticsearch-specification/blob/17ac39c7f9266bc303baa029f90194aecb1c3b7c/specification/indices/shard_stores/IndicesShardStoresResponse.ts#L24-L26

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type ShardStores

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

func New

func New(tp elastictransport.Interface) *ShardStores

Provides store information for shard copies of indices.

https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-shards-stores.html

func (*ShardStores) AllowNoIndices

func (r *ShardStores) AllowNoIndices(allownoindices bool) *ShardStores

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

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

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

func (*ShardStores) ExpandWildcards

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

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. API name: expand_wildcards

func (*ShardStores) Header

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

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

func (*ShardStores) HttpRequest

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

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

func (*ShardStores) IgnoreUnavailable

func (r *ShardStores) IgnoreUnavailable(ignoreunavailable bool) *ShardStores

IgnoreUnavailable If true, missing or closed indices are not included in the response. API name: ignore_unavailable

func (*ShardStores) Index

func (r *ShardStores) Index(index string) *ShardStores

Index List of data streams, indices, and aliases used to limit the request. API Name: index

func (ShardStores) IsSuccess

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

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

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

func (*ShardStores) Status

func (r *ShardStores) Status(statuses ...shardstorestatus.ShardStoreStatus) *ShardStores

Status List of shard health statuses used to limit the request. API name: status