Documentation
¶
Overview ¶
Stop snapshot lifecycle management. Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. Stopping SLM does not stop any snapshots that are in progress. You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped.
The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. Use the get snapshot lifecycle management status API to see if SLM 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 ¶
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 snapshot lifecycle management. Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. Stopping SLM does not stop any snapshots that are in progress. You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped.
The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. Use the get snapshot lifecycle management status API to see if SLM is running.
https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-stop
func (Stop) Do ¶
Do runs the request through the transport, handle the response and returns a stop.Response
func (*Stop) ErrorTrace ¶
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*Stop) FilterPath ¶
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 ¶
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 ¶
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 (Stop) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
Source Files