getlifecycle

Documentation

Overview

Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.

Index

• Variables
• type GetLifecycle
  • func New(tp elastictransport.Interface) *GetLifecycle
  • func (r GetLifecycle) Do(providedCtx context.Context) (Response, error)
  • func (r *GetLifecycle) ErrorTrace(errortrace bool) *GetLifecycle
  • func (r *GetLifecycle) FilterPath(filterpaths ...string) *GetLifecycle
  • func (r *GetLifecycle) Header(key, value string) *GetLifecycle
  • func (r *GetLifecycle) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetLifecycle) Human(human bool) *GetLifecycle
  • func (r GetLifecycle) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r GetLifecycle) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetLifecycle) PolicyId(policyid string) *GetLifecycle
  • func (r *GetLifecycle) Pretty(pretty bool) *GetLifecycle
• type NewGetLifecycle
  • func NewGetLifecycleFunc(tp elastictransport.Interface) NewGetLifecycle
• 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 GetLifecycle

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

func New

func New(tp elastictransport.Interface) *GetLifecycle

Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.

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

func (GetLifecycle) Do

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

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

func (*GetLifecycle) ErrorTrace

func (r *GetLifecycle) ErrorTrace(errortrace bool) *GetLifecycle

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*GetLifecycle) FilterPath

func (r *GetLifecycle) FilterPath(filterpaths ...string) *GetLifecycle

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*GetLifecycle) Header

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

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

func (*GetLifecycle) HttpRequest

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

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

func (*GetLifecycle) Human

func (r *GetLifecycle) Human(human bool) *GetLifecycle

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (GetLifecycle) IsSuccess

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

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

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

func (*GetLifecycle) PolicyId

func (r *GetLifecycle) PolicyId(policyid string) *GetLifecycle

PolicyId Comma-separated list of snapshot lifecycle policies to retrieve API Name: policyid

func (*GetLifecycle) Pretty

func (r *GetLifecycle) Pretty(pretty bool) *GetLifecycle

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

type NewGetLifecycle

type NewGetLifecycle func() *GetLifecycle

NewGetLifecycle type alias for index.

func NewGetLifecycleFunc

func NewGetLifecycleFunc(tp elastictransport.Interface) NewGetLifecycle

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

type Response

type Response map[string]types.SnapshotLifecycle

func NewResponse

func NewResponse() Response

NewResponse returns a Response