recovery

Documentation

Overview

Returns information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.

Index

• Variables
• type NewRecovery
  • func NewRecoveryFunc(tp elastictransport.Interface) NewRecovery
• type Recovery
  • func New(tp elastictransport.Interface) *Recovery
  • func (r *Recovery) ActiveOnly(activeonly bool) *Recovery
  • func (r *Recovery) Bytes(bytes bytes.Bytes) *Recovery
  • func (r *Recovery) Detailed(detailed bool) *Recovery
  • func (r Recovery) Do(providedCtx context.Context) (Response, error)
  • func (r *Recovery) ErrorTrace(errortrace bool) *Recovery
  • func (r *Recovery) FilterPath(filterpaths ...string) *Recovery
  • func (r *Recovery) Format(format string) *Recovery
  • func (r *Recovery) H(names ...string) *Recovery
  • func (r *Recovery) Header(key, value string) *Recovery
  • func (r *Recovery) Help(help bool) *Recovery
  • func (r *Recovery) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Recovery) Human(human bool) *Recovery
  • func (r *Recovery) Index(index string) *Recovery
  • func (r Recovery) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *Recovery) Local(local bool) *Recovery
  • func (r *Recovery) MasterTimeout(duration string) *Recovery
  • func (r Recovery) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Recovery) Pretty(pretty bool) *Recovery
  • func (r *Recovery) S(names ...string) *Recovery
  • func (r *Recovery) V(v bool) *Recovery
• type Response
  • func NewResponse() Response

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 NewRecovery

type NewRecovery func() *Recovery

NewRecovery type alias for index.

func NewRecoveryFunc

func NewRecoveryFunc(tp elastictransport.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

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

func New

func New(tp elastictransport.Interface) *Recovery

Returns information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application 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(activeonly bool) *Recovery

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

func (*Recovery) Bytes

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

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

func (*Recovery) Detailed

func (r *Recovery) Detailed(detailed bool) *Recovery

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

func (Recovery) Do

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

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

func (*Recovery) ErrorTrace

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

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

func (*Recovery) FilterPath

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

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

func (*Recovery) Format

func (r *Recovery) Format(format string) *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

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

H List of columns to appear in the response. Supports simple wildcards. API name: h

func (*Recovery) Header

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

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

func (*Recovery) Help

func (r *Recovery) Help(help bool) *Recovery

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

func (*Recovery) HttpRequest

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

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

func (*Recovery) Human

func (r *Recovery) Human(human bool) *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 human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (*Recovery) Index

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

Index A comma-separated list of data streams, indices, and aliases 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 (Recovery) IsSuccess

func (r Recovery) 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 (*Recovery) Local

func (r *Recovery) Local(local bool) *Recovery

Local If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. API name: local

func (*Recovery) MasterTimeout

func (r *Recovery) MasterTimeout(duration string) *Recovery

MasterTimeout Period to wait for a connection to the master node. API name: master_timeout

func (Recovery) Perform

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

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

func (*Recovery) Pretty

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

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

func (*Recovery) S

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

S List of columns that determine how the table should be sorted. 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) V

func (r *Recovery) V(v bool) *Recovery

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

type Response

type Response []types.RecoveryRecord

func NewResponse

func NewResponse() Response

NewResponse returns a Response