explaindatalifecycle

Documentation

Overview

Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc.

Index

• Variables
• type ExplainDataLifecycle
  • func New(tp elastictransport.Interface) *ExplainDataLifecycle
  • func (r ExplainDataLifecycle) Do(providedCtx context.Context) (*Response, error)
  • func (r *ExplainDataLifecycle) ErrorTrace(errortrace bool) *ExplainDataLifecycle
  • func (r *ExplainDataLifecycle) FilterPath(filterpaths ...string) *ExplainDataLifecycle
  • func (r *ExplainDataLifecycle) Header(key, value string) *ExplainDataLifecycle
  • func (r *ExplainDataLifecycle) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ExplainDataLifecycle) Human(human bool) *ExplainDataLifecycle
  • func (r *ExplainDataLifecycle) IncludeDefaults(includedefaults bool) *ExplainDataLifecycle
  • func (r ExplainDataLifecycle) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *ExplainDataLifecycle) MasterTimeout(duration string) *ExplainDataLifecycle
  • func (r ExplainDataLifecycle) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *ExplainDataLifecycle) Pretty(pretty bool) *ExplainDataLifecycle
• type NewExplainDataLifecycle
  • func NewExplainDataLifecycleFunc(tp elastictransport.Interface) NewExplainDataLifecycle
• 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 ExplainDataLifecycle

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

func New

func New(tp elastictransport.Interface) *ExplainDataLifecycle

Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc.

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

func (ExplainDataLifecycle) Do

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

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

func (*ExplainDataLifecycle) ErrorTrace

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

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

func (*ExplainDataLifecycle) FilterPath

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

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

func (*ExplainDataLifecycle) Header

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

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

func (*ExplainDataLifecycle) HttpRequest

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

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

func (*ExplainDataLifecycle) Human

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

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 (*ExplainDataLifecycle) IncludeDefaults

func (r *ExplainDataLifecycle) IncludeDefaults(includedefaults bool) *ExplainDataLifecycle

IncludeDefaults indicates if the API should return the default values the system uses for the index's lifecycle API name: include_defaults

func (ExplainDataLifecycle) IsSuccess

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

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

MasterTimeout Specify timeout for connection to master API name: master_timeout

func (ExplainDataLifecycle) Perform

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

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

func (*ExplainDataLifecycle) Pretty

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

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

type NewExplainDataLifecycle

type NewExplainDataLifecycle func(index string) *ExplainDataLifecycle

NewExplainDataLifecycle type alias for index.

func NewExplainDataLifecycleFunc

func NewExplainDataLifecycleFunc(tp elastictransport.Interface) NewExplainDataLifecycle

NewExplainDataLifecycleFunc returns a new instance of ExplainDataLifecycle 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.DataStreamLifecycleExplain `json:"indices"`
}

Response holds the response body struct for the package explaindatalifecycle

https://github.com/elastic/elasticsearch-specification/blob/19027dbdd366978ccae41842a040a636730e7c10/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleResponse.ts#L25-L29

func NewResponse

func NewResponse() *Response

NewResponse returns a Response