explainlifecycle

Documentation

Overview

Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.

Index

• Variables
• type ExplainLifecycle
  • func New(tp elastictransport.Interface) *ExplainLifecycle
  • func (r ExplainLifecycle) Do(providedCtx context.Context) (*Response, error)
  • func (r *ExplainLifecycle) ErrorTrace(errortrace bool) *ExplainLifecycle
  • func (r *ExplainLifecycle) FilterPath(filterpaths ...string) *ExplainLifecycle
  • func (r *ExplainLifecycle) Header(key, value string) *ExplainLifecycle
  • func (r *ExplainLifecycle) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ExplainLifecycle) Human(human bool) *ExplainLifecycle
  • func (r ExplainLifecycle) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *ExplainLifecycle) MasterTimeout(duration string) *ExplainLifecycle
  • func (r *ExplainLifecycle) OnlyErrors(onlyerrors bool) *ExplainLifecycle
  • func (r *ExplainLifecycle) OnlyManaged(onlymanaged bool) *ExplainLifecycle
  • func (r ExplainLifecycle) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *ExplainLifecycle) Pretty(pretty bool) *ExplainLifecycle
  • func (r *ExplainLifecycle) Timeout(duration string) *ExplainLifecycle
• type NewExplainLifecycle
  • func NewExplainLifecycleFunc(tp elastictransport.Interface) NewExplainLifecycle
• type Response
  • func NewResponse() *Response
  • func (s *Response) UnmarshalJSON(data []byte) 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 ExplainLifecycle

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

func New

func New(tp elastictransport.Interface) *ExplainLifecycle

Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.

https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html

func (ExplainLifecycle) Do

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

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

func (*ExplainLifecycle) ErrorTrace

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

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

func (*ExplainLifecycle) FilterPath

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

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

func (*ExplainLifecycle) Header

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

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

func (*ExplainLifecycle) HttpRequest

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

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

func (*ExplainLifecycle) Human

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

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

func (r ExplainLifecycle) 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 (*ExplainLifecycle) MasterTimeout

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

MasterTimeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout

func (*ExplainLifecycle) OnlyErrors

func (r *ExplainLifecycle) OnlyErrors(onlyerrors bool) *ExplainLifecycle

OnlyErrors Filters the returned indices to only indices that are managed by ILM and are in an error state, either due to an encountering an error while executing the policy, or attempting to use a policy that does not exist. API name: only_errors

func (*ExplainLifecycle) OnlyManaged

func (r *ExplainLifecycle) OnlyManaged(onlymanaged bool) *ExplainLifecycle

OnlyManaged Filters the returned indices to only indices that are managed by ILM. API name: only_managed

func (ExplainLifecycle) Perform

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

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

func (*ExplainLifecycle) Pretty

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

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

func (*ExplainLifecycle) Timeout

func (r *ExplainLifecycle) Timeout(duration string) *ExplainLifecycle

Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout

type NewExplainLifecycle

type NewExplainLifecycle func(index string) *ExplainLifecycle

NewExplainLifecycle type alias for index.

func NewExplainLifecycleFunc

func NewExplainLifecycleFunc(tp elastictransport.Interface) NewExplainLifecycle

NewExplainLifecycleFunc returns a new instance of ExplainLifecycle 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 {
	Indices map[string]types.LifecycleExplain `json:"indices"`
}

Response holds the response body struct for the package explainlifecycle

https://github.com/elastic/elasticsearch-specification/blob/07bf82537a186562d8699685e3704ea338b268ef/specification/ilm/explain_lifecycle/ExplainLifecycleResponse.ts#L24-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

func (*Response) UnmarshalJSON

func (s *Response) UnmarshalJSON(data []byte) error