retry

Documentation

Overview

Retries executing the policy for an index that 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) Header(key, value string) *Retry
  • func (r *Retry) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r Retry) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r Retry) Perform(providedCtx context.Context) (*http.Response, error)

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/17ac39c7f9266bc303baa029f90194aecb1c3b7c/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

Retries executing the policy for an index that 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) 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) 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.