start

Documentation

Overview

Start snapshot lifecycle management. Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. Manually starting SLM is necessary only if it has been stopped using the stop SLM API.

Index

• Variables
• type NewStart
  • func NewStartFunc(tp elastictransport.Interface) NewStart
• type Response
  • func NewResponse() *Response
• type Start
  • func New(tp elastictransport.Interface) *Start
  • func (r Start) Do(providedCtx context.Context) (*Response, error)
  • func (r *Start) ErrorTrace(errortrace bool) *Start
  • func (r *Start) FilterPath(filterpaths ...string) *Start
  • func (r *Start) Header(key, value string) *Start
  • func (r *Start) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Start) Human(human bool) *Start
  • func (r Start) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *Start) MasterTimeout(duration string) *Start
  • func (r Start) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Start) Pretty(pretty bool) *Start
  • func (r *Start) Timeout(duration string) *Start

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 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 start

https://github.com/elastic/elasticsearch-specification/blob/52c473efb1fb5320a5bac12572d0b285882862fb/specification/slm/start/StartSnapshotLifecycleManagementResponse.ts#L22-L25

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type Start

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

func New

func New(tp elastictransport.Interface) *Start

Start snapshot lifecycle management. Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. Manually starting SLM is necessary only if it has been stopped using the stop SLM API.

https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-start

func (Start) Do

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

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

func (*Start) ErrorTrace

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

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

func (*Start) FilterPath

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

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

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) Human

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

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 (Start) IsSuccess

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

func (r *Start) MasterTimeout(duration string) *Start

MasterTimeout The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. API name: master_timeout

func (Start) Perform

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

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

func (*Start) Pretty

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

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

func (*Start) Timeout

func (r *Start) Timeout(duration string) *Start

Timeout The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. API name: timeout