start

Documentation

Overview

Turns on snapshot lifecycle management (SLM).

Index

• Variables
• type NewStart
  • func NewStartFunc(tp elastictransport.Interface) NewStart
• type Start
  • func New(tp elastictransport.Interface) *Start
  • func (r Start) Do(ctx context.Context) (*http.Response, error)
  • func (r *Start) Header(key, value string) *Start
  • func (r *Start) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r Start) IsSuccess(ctx context.Context) (bool, error)

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 NewStart

type NewStart func() *Start

NewStart type alias for index.

func NewStartFunc

func NewStartFunc(tp elastictransport.Interface) NewStart

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

type Start

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

func New

func New(tp elastictransport.Interface) *Start

Turns on snapshot lifecycle management (SLM).

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

func (Start) Do

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

Do runs the http.Request through the provided transport.

func (*Start) Header

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

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

func (*Start) HttpRequest

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

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

func (Start) IsSuccess

func (r Start) 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.