deletelifecycle

Documentation

Overview

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

Index

• Variables
• type DeleteLifecycle
  • func New(tp elastictransport.Interface) *DeleteLifecycle
  • func (r DeleteLifecycle) Do(providedCtx context.Context) (*Response, error)
  • func (r *DeleteLifecycle) Header(key, value string) *DeleteLifecycle
  • func (r *DeleteLifecycle) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r DeleteLifecycle) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *DeleteLifecycle) MasterTimeout(duration string) *DeleteLifecycle
  • func (r DeleteLifecycle) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *DeleteLifecycle) Timeout(duration string) *DeleteLifecycle
• type NewDeleteLifecycle
  • func NewDeleteLifecycleFunc(tp elastictransport.Interface) NewDeleteLifecycle
• 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 DeleteLifecycle

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

func New

func New(tp elastictransport.Interface) *DeleteLifecycle

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

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

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

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

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

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

func (*DeleteLifecycle) Timeout

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

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 deletelifecycle

https://github.com/elastic/elasticsearch-specification/blob/b2c13a00c152a97cb41193deda8ed9b37fd06796/specification/ilm/delete_lifecycle/DeleteLifecycleResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response