getdatalifecycle

Documentation

Overview

Retrieves the data stream lifecycle configuration of one or more data streams.

Index

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

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

func New

func New(tp elastictransport.Interface) *GetDataLifecycle

Retrieves the data stream lifecycle configuration of one or more data streams.

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

func (GetDataLifecycle) Do

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

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

func (*GetDataLifecycle) ErrorTrace

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

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

func (*GetDataLifecycle) ExpandWildcards

func (r *GetDataLifecycle) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *GetDataLifecycle

ExpandWildcards Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. API name: expand_wildcards

func (*GetDataLifecycle) FilterPath

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

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

func (*GetDataLifecycle) Header

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

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

func (*GetDataLifecycle) HttpRequest

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

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

func (*GetDataLifecycle) Human

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

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

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

IncludeDefaults If `true`, return all default settings in the response. API name: include_defaults

func (GetDataLifecycle) IsSuccess

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

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

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

func (*GetDataLifecycle) Pretty

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

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

type NewGetDataLifecycle

type NewGetDataLifecycle func(name string) *GetDataLifecycle

NewGetDataLifecycle type alias for index.

func NewGetDataLifecycleFunc

func NewGetDataLifecycleFunc(tp elastictransport.Interface) NewGetDataLifecycle

NewGetDataLifecycleFunc returns a new instance of GetDataLifecycle 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 {
	DataStreams []types.DataStreamWithLifecycle `json:"data_streams"`
}

Response holds the response body struct for the package getdatalifecycle

https://github.com/elastic/elasticsearch-specification/blob/19027dbdd366978ccae41842a040a636730e7c10/specification/indices/get_data_lifecycle/IndicesGetDataLifecycleResponse.ts#L23-L25

func NewResponse

func NewResponse() *Response

NewResponse returns a Response