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
- type Response
- type 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
Constants ¶
This section is empty.
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.
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
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/guide/en/elasticsearch/reference/current/ilm-stop.html
func (Stop) Do ¶
Do runs the request through the transport, handle the response and returns a stop.Response
func (*Stop) ErrorTrace ¶ added in v8.14.0
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
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*Stop) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Stop) Human ¶ added in v8.14.0
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 ¶
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 ¶
API name: master_timeout
func (Stop) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.