stop

Documentation

Overview

Stop the ILM plugin. Halt all lifecycle management operations and stop the index lifecycle management plugin. This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices.

The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped. Use the get ILM status API to check whether ILM is running.

Index

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

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 NewStop

type NewStop func() *Stop

NewStop type alias for index.

func NewStopFunc

func NewStopFunc(tp elastictransport.Interface) NewStop

NewStopFunc returns a new instance of Stop 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 stop

https://github.com/elastic/elasticsearch-specification/blob/907d11a72a6bfd37b777d526880c56202889609e/specification/ilm/stop/StopIlmResponse.ts#L22-L25

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type Stop

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

func New

func New(tp elastictransport.Interface) *Stop

Stop the ILM plugin. Halt all lifecycle management operations and stop the index lifecycle management plugin. This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices.

The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped. Use the get ILM status API to check whether ILM is running.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-stop

func (Stop) Do

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

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

func (*Stop) ErrorTrace

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

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

func (*Stop) FilterPath

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

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

func (*Stop) Header

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

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

func (*Stop) HttpRequest

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

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

func (*Stop) Human

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

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"exists_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 (Stop) IsSuccess

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

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

MasterTimeout 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. API name: master_timeout

func (Stop) Perform

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

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

func (*Stop) Pretty

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

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

func (*Stop) Timeout

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

Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout