removepolicy

Documentation

Overview

Remove policies from an index. Remove the assigned lifecycle policies from an index or a data stream's backing indices. It also stops managing the indices.

Index

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

type NewRemovePolicy func(index string) *RemovePolicy

NewRemovePolicy type alias for index.

func NewRemovePolicyFunc

func NewRemovePolicyFunc(tp elastictransport.Interface) NewRemovePolicy

NewRemovePolicyFunc returns a new instance of RemovePolicy with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type RemovePolicy

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

func New

func New(tp elastictransport.Interface) *RemovePolicy

Remove policies from an index. Remove the assigned lifecycle policies from an index or a data stream's backing indices. It also stops managing the indices.

https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html

func (RemovePolicy) Do

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

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

func (*RemovePolicy) ErrorTrace

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

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

func (*RemovePolicy) FilterPath

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

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

func (*RemovePolicy) Header

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

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

func (*RemovePolicy) HttpRequest

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

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

func (*RemovePolicy) Human

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

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

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

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

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

func (*RemovePolicy) Pretty

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

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

type Response

type Response struct {
	FailedIndexes []string `json:"failed_indexes"`
	HasFailures   bool     `json:"has_failures"`
}

Response holds the response body struct for the package removepolicy

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ilm/remove_policy/RemovePolicyResponse.ts#L22-L27

func NewResponse

func NewResponse() *Response

NewResponse returns a Response