deletelifecycle

package
v8.8.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 5, 2023 License: Apache-2.0 Imports: 12 Imported by: 4

Documentation

Overview

Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted.

Index

Constants

This section is empty.

Variables

View Source
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.

Functions

This section is empty.

Types

type DeleteLifecycle

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

func New

Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted.

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

func (DeleteLifecycle) Do

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

func (*DeleteLifecycle) Header

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

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

func (*DeleteLifecycle) HttpRequest

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

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

func (DeleteLifecycle) IsSuccess

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

func (r *DeleteLifecycle) MasterTimeout(v string) *DeleteLifecycle

MasterTimeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout

func (DeleteLifecycle) Perform added in v8.7.0

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

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

func (*DeleteLifecycle) Policy

func (r *DeleteLifecycle) Policy(v string) *DeleteLifecycle

Policy Identifier for the policy. API Name: policy

func (*DeleteLifecycle) Timeout

func (r *DeleteLifecycle) Timeout(v string) *DeleteLifecycle

Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout

type NewDeleteLifecycle

type NewDeleteLifecycle func(policy string) *DeleteLifecycle

NewDeleteLifecycle type alias for index.

func NewDeleteLifecycleFunc

func NewDeleteLifecycleFunc(tp elastictransport.Interface) NewDeleteLifecycle

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

type Response added in v8.7.0

type Response struct {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

func NewResponse added in v8.7.0

func NewResponse() *Response

NewResponse returns a Response

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL