recovery

Documentation

Overview

Returns information about index shard recoveries, both on-going completed.

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) Header(key, value string) *Recovery
  • func (r *Recovery) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Recovery) Index(index string) *Recovery
  • func (r Recovery) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r Recovery) Perform(providedCtx context.Context) (*http.Response, error)
• 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 index shard recoveries, both on-going completed.

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

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

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

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

type Response

type Response []types.RecoveryRecord

func NewResponse

func NewResponse() Response

NewResponse returns a Response