executelifecycle

package
v8.13.1 Latest Latest
Warning

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

Go to latest
Published: Apr 11, 2024 License: Apache-2.0 Imports: 11 Imported by: 3

Documentation

Overview

Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.

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 ExecuteLifecycle

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

func New

Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.

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

func (ExecuteLifecycle) Do

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

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

func (*ExecuteLifecycle) Header

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

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

func (*ExecuteLifecycle) HttpRequest

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

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

func (ExecuteLifecycle) IsSuccess

func (r ExecuteLifecycle) 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 (ExecuteLifecycle) Perform added in v8.7.0

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

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

type NewExecuteLifecycle

type NewExecuteLifecycle func(policyid string) *ExecuteLifecycle

NewExecuteLifecycle type alias for index.

func NewExecuteLifecycleFunc

func NewExecuteLifecycleFunc(tp elastictransport.Interface) NewExecuteLifecycle

NewExecuteLifecycleFunc returns a new instance of ExecuteLifecycle 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 {
	SnapshotName string `json:"snapshot_name"`
}

Response holds the response body struct for the package executelifecycle

https://github.com/elastic/elasticsearch-specification/blob/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/slm/execute_lifecycle/ExecuteSnapshotLifecycleResponse.ts#L22-L24

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