getstatus

Documentation

Overview

Retrieves the status of snapshot lifecycle management (SLM).

Index

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

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

func New

func New(tp elastictransport.Interface) *GetStatus

Retrieves the status of snapshot lifecycle management (SLM).

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

func (GetStatus) Do

func (r GetStatus) Do(ctx context.Context) (*Response, error)

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

func (*GetStatus) Header

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

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

func (*GetStatus) HttpRequest

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

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

func (GetStatus) IsSuccess

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

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

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

type NewGetStatus

type NewGetStatus func() *GetStatus

NewGetStatus type alias for index.

func NewGetStatusFunc

func NewGetStatusFunc(tp elastictransport.Interface) NewGetStatus

NewGetStatusFunc returns a new instance of GetStatus 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 {
	OperationMode lifecycleoperationmode.LifecycleOperationMode `json:"operation_mode"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response