type NewRecovery func() *Recovery

funcNewRecoveryFunc¶

func NewRecoveryFunc(tpelastictransport.Interface)NewRecovery

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

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

funcNew¶

func New(tpelastictransport.Interface) *Recovery

Get shard recovery information.

Get information about ongoing and completed shard recoveries.Shard recovery is the process of initializing a shard copy, such as restoringa primary shard from a snapshot or syncing a replica shard from a primaryshard. When a shard recovery completes, the recovered shard is available forsearch and indexing.For data streams, the API returns information about the stream’s backingindices.IMPORTANT: cat APIs are only intended for human consumption using the commandline or Kibana console. They are not intended for use by applications. Forapplication consumption, use the index recovery API.

https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-recovery.html

func (*Recovery)ActiveOnly¶

func (r *Recovery) ActiveOnly(activeonlybool) *Recovery

ActiveOnly If `true`, the response only includes ongoing shard recoveries.API name: active_only

func (*Recovery)Bytes¶

func (r *Recovery) Bytes(bytesbytes.Bytes) *Recovery

Bytes The unit used to display byte values.API name: bytes

func (*Recovery)Detailed¶

func (r *Recovery) Detailed(detailedbool) *Recovery

Detailed If `true`, the response includes detailed information about shard recoveries.API name: detailed

func (Recovery)Do¶

func (rRecovery) Do(providedCtxcontext.Context) (Response,error)

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

func (*Recovery)ErrorTrace¶added inv8.14.0

func (r *Recovery) ErrorTrace(errortracebool) *Recovery

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

func (*Recovery)FilterPath¶added inv8.14.0

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

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

func (*Recovery)Format¶added inv8.14.0

func (r *Recovery) Format(formatstring) *Recovery

Format Specifies the format to return the columnar data in, can be set to`text`, `json`, `cbor`, `yaml`, or `smile`.API name: format

func (*Recovery)H¶added inv8.14.0

func (r *Recovery) H(catrecoverycolumns ...catrecoverycolumn.CatRecoveryColumn) *Recovery

H A comma-separated list of columns names to display.It supports simple wildcards.API name: h

func (*Recovery)Header¶

func (r *Recovery) Header(key, valuestring) *Recovery

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

func (*Recovery)Help¶added inv8.14.0

func (r *Recovery) Help(helpbool) *Recovery

Help When set to `true` will output available columns. This optioncan't be combined with any other query string option.API name: help

func (*Recovery)HttpRequest¶

func (r *Recovery) HttpRequest(ctxcontext.Context) (*http.Request,error)

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

func (*Recovery)Human¶added inv8.14.0

func (r *Recovery) Human(humanbool) *Recovery

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 humanreadable values will be omitted. This makes sense for responses beingconsumedonly by machines.API name: human

func (*Recovery)Index¶

func (r *Recovery) Index(indexstring) *Recovery

Index A comma-separated list of data streams, indices, and aliases used to limitthe request.Supports wildcards (`*`). To target all data streams and indices, omit thisparameter or use `*` or `_all`.API Name: index

func (Recovery)IsSuccess¶

func (rRecovery) IsSuccess(providedCtxcontext.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 (Recovery)Perform¶added inv8.7.0

func (rRecovery) Perform(providedCtxcontext.Context) (*http.Response,error)

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

func (*Recovery)Pretty¶added inv8.14.0

func (r *Recovery) Pretty(prettybool) *Recovery

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

func (*Recovery)S¶added inv8.14.0

func (r *Recovery) S(names ...string) *Recovery

S A comma-separated list of column names or aliases that determines the sortorder.Sorting defaults to ascending and can be changed by setting `:asc`or `:desc` as a suffix to the column name.API name: s

func (*Recovery)Time¶added inv8.18.0

func (r *Recovery) Time(timetimeunit.TimeUnit) *Recovery

Time The unit used to display time values.API name: time

func (*Recovery)V¶added inv8.14.0

func (r *Recovery) V(vbool) *Recovery

V When set to `true` will enable verbose output.API name: v

type Response []types.RecoveryRecord

funcNewResponse¶added inv8.7.0

func NewResponse()Response

NewResponse returns a Response