deletedatalifecycle

Documentation

Overview

Delete data stream lifecycles. Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.

Index

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

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

func New

func New(tp elastictransport.Interface) *DeleteDataLifecycle

Delete data stream lifecycles. Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.

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

func (DeleteDataLifecycle) Do

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

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

func (*DeleteDataLifecycle) ErrorTrace

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

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

func (*DeleteDataLifecycle) ExpandWildcards

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

ExpandWildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) API name: expand_wildcards

func (*DeleteDataLifecycle) FilterPath

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

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

func (*DeleteDataLifecycle) Header

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

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

func (*DeleteDataLifecycle) HttpRequest

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

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

func (*DeleteDataLifecycle) Human

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

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

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

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

MasterTimeout Specify timeout for connection to master API name: master_timeout

func (DeleteDataLifecycle) Perform

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

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

func (*DeleteDataLifecycle) Pretty

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

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

func (*DeleteDataLifecycle) Timeout

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

Timeout Explicit timestamp for the document API name: timeout

type NewDeleteDataLifecycle

type NewDeleteDataLifecycle func(name string) *DeleteDataLifecycle

NewDeleteDataLifecycle type alias for index.

func NewDeleteDataLifecycleFunc

func NewDeleteDataLifecycleFunc(tp elastictransport.Interface) NewDeleteDataLifecycle

NewDeleteDataLifecycleFunc returns a new instance of DeleteDataLifecycle 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 deletedatalifecycle

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response