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(ctx context.Context) (*http.Response, error)
  • func (r *ExplainLifecycle) Header(key, value string) *ExplainLifecycle
  • func (r *ExplainLifecycle) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ExplainLifecycle) Index(v string) *ExplainLifecycle
  • func (r ExplainLifecycle) IsSuccess(ctx context.Context) (bool, error)
  • func (r *ExplainLifecycle) MasterTimeout(value string) *ExplainLifecycle
  • func (r *ExplainLifecycle) OnlyErrors(b bool) *ExplainLifecycle
  • func (r *ExplainLifecycle) OnlyManaged(b bool) *ExplainLifecycle
  • func (r *ExplainLifecycle) Timeout(value string) *ExplainLifecycle
• type NewExplainLifecycle
  • func NewExplainLifecycleFunc(tp elastictransport.Interface) NewExplainLifecycle

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(ctx context.Context) (*http.Response, error)

Do runs the http.Request through the provided transport.

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

func (r *ExplainLifecycle) Index(v string) *ExplainLifecycle

Index Comma-separated list of data streams, indices, and aliases to target. Supports wildcards (`*`). To target all data streams and indices, use `*` or `_all`. API Name: index

func (ExplainLifecycle) IsSuccess

func (r ExplainLifecycle) IsSuccess(ctx 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(value 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(b bool) *ExplainLifecycle

OnlyErrors Filters the returned indices to only indices that are managed by ILM. API name: only_errors

func (*ExplainLifecycle) OnlyManaged

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

OnlyManaged 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_managed

func (*ExplainLifecycle) Timeout

func (r *ExplainLifecycle) Timeout(value 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.