stop

package
v8.17.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 17, 2024 License: Apache-2.0 Imports: 11 Imported by: 4

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

Constants

This section is empty.

Variables

View Source
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.

Functions

This section is empty.

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 added in v8.7.0

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/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ilm/stop/StopIlmResponse.ts#L22-L24

func NewResponse added in v8.7.0

func NewResponse() *Response

NewResponse returns a Response

type Stop

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

func New

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/guide/en/elasticsearch/reference/current/ilm-stop.html

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 added in v8.14.0

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 added in v8.14.0

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 added in v8.14.0

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 `"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 (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

API name: master_timeout

func (Stop) Perform added in v8.7.0

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 added in v8.14.0

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

API name: timeout

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL