executeretention

Documentation

Overview

Deletes any snapshots that are expired according to the policy's retention rules.

Index

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

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

func New

func New(tp elastictransport.Interface) *ExecuteRetention

Deletes any snapshots that are expired according to the policy's retention rules.

https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html

func (ExecuteRetention) Do

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

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

func (*ExecuteRetention) Header

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

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

func (*ExecuteRetention) HttpRequest

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

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

func (ExecuteRetention) IsSuccess

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

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

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

type NewExecuteRetention

type NewExecuteRetention func() *ExecuteRetention

NewExecuteRetention type alias for index.

func NewExecuteRetentionFunc

func NewExecuteRetentionFunc(tp elastictransport.Interface) NewExecuteRetention

NewExecuteRetentionFunc returns a new instance of ExecuteRetention 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 executeretention

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/slm/execute_retention/ExecuteRetentionResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response