shardstores

Documentation

Overview

Get index shard stores. Get store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream's backing indices.

The index shard stores API returns the following information:

* The node on which each replica shard exists. * The allocation ID for each replica shard. * A unique ID for each replica shard. * Any errors encountered while opening the shard index or from an earlier failure.

By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards.

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) ErrorTrace(errortrace bool) *ShardStores
  • func (r *ShardStores) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *ShardStores
  • func (r *ShardStores) FilterPath(filterpaths ...string) *ShardStores
  • func (r *ShardStores) Header(key, value string) *ShardStores
  • func (r *ShardStores) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ShardStores) Human(human bool) *ShardStores
  • 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) Pretty(pretty bool) *ShardStores
  • 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/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/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

Get index shard stores. Get store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream's backing indices.

The index shard stores API returns the following information:

* The node on which each replica shard exists. * The allocation ID for each replica shard. * A unique ID for each replica shard. * Any errors encountered while opening the shard index or from an earlier failure.

By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards.

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

func (r *ShardStores) ErrorTrace(errortrace bool) *ShardStores

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

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

func (r *ShardStores) FilterPath(filterpaths ...string) *ShardStores

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

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

func (r *ShardStores) Human(human bool) *ShardStores

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

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

func (r *ShardStores) Pretty(pretty bool) *ShardStores

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

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