removepolicy

Documentation

Overview

Removes the assigned lifecycle policy and stops managing the specified index

Index

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

Removes the assigned lifecycle policy and stops managing the specified index

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

func (RemovePolicy) Do

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

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

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

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

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

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

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/5fea44e006349579bf3561a82e997002e5716117/specification/ilm/remove_policy/RemovePolicyResponse.ts#L22-L27

func NewResponse

func NewResponse() *Response

NewResponse returns a Response