retry

Documentation

Overview

Retry a policy. Retry running the lifecycle policy for an index that is in the ERROR step. The API sets the policy back to the step where the error occurred and runs the step. Use the explain lifecycle state API to determine whether an index is in the ERROR step.

Index

• Variables
• type NewRetry
  • func NewRetryFunc(tp elastictransport.Interface) NewRetry
• type Response
  • func NewResponse() *Response
• type Retry
  • func New(tp elastictransport.Interface) *Retry
  • func (r Retry) Do(providedCtx context.Context) (*Response, error)
  • func (r *Retry) ErrorTrace(errortrace bool) *Retry
  • func (r *Retry) FilterPath(filterpaths ...string) *Retry
  • func (r *Retry) Header(key, value string) *Retry
  • func (r *Retry) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Retry) Human(human bool) *Retry
  • func (r Retry) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r Retry) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Retry) Pretty(pretty bool) *Retry

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 NewRetry

type NewRetry func(index string) *Retry

NewRetry type alias for index.

func NewRetryFunc

func NewRetryFunc(tp elastictransport.Interface) NewRetry

NewRetryFunc returns a new instance of Retry 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 {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package retry

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ilm/retry/RetryIlmResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type Retry

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

func New

func New(tp elastictransport.Interface) *Retry

Retry a policy. Retry running the lifecycle policy for an index that is in the ERROR step. The API sets the policy back to the step where the error occurred and runs the step. Use the explain lifecycle state API to determine whether an index is in the ERROR step.

https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy.html

func (Retry) Do

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

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

func (*Retry) ErrorTrace

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

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

func (*Retry) FilterPath

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

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

func (*Retry) Header

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

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

func (*Retry) HttpRequest

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

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

func (*Retry) Human

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

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 (Retry) IsSuccess

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

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

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

func (*Retry) Pretty

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

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