Documentation
¶
Overview ¶
Run a policy. Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.
Index ¶
- Variables
- type ExecuteLifecycle
- func (r ExecuteLifecycle) Do(providedCtx context.Context) (*Response, error)
- func (r *ExecuteLifecycle) ErrorTrace(errortrace bool) *ExecuteLifecycle
- func (r *ExecuteLifecycle) FilterPath(filterpaths ...string) *ExecuteLifecycle
- func (r *ExecuteLifecycle) Header(key, value string) *ExecuteLifecycle
- func (r *ExecuteLifecycle) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *ExecuteLifecycle) Human(human bool) *ExecuteLifecycle
- func (r ExecuteLifecycle) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *ExecuteLifecycle) MasterTimeout(duration string) *ExecuteLifecycle
- func (r ExecuteLifecycle) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *ExecuteLifecycle) Pretty(pretty bool) *ExecuteLifecycle
- func (r *ExecuteLifecycle) Timeout(duration string) *ExecuteLifecycle
- type NewExecuteLifecycle
- type Response
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 ExecuteLifecycle ¶
type ExecuteLifecycle struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *ExecuteLifecycle
Run a policy. Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-execute-lifecycle
func (ExecuteLifecycle) Do ¶
func (r ExecuteLifecycle) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a executelifecycle.Response
func (*ExecuteLifecycle) ErrorTrace ¶
func (r *ExecuteLifecycle) ErrorTrace(errortrace bool) *ExecuteLifecycle
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*ExecuteLifecycle) FilterPath ¶
func (r *ExecuteLifecycle) FilterPath(filterpaths ...string) *ExecuteLifecycle
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*ExecuteLifecycle) Header ¶
func (r *ExecuteLifecycle) Header(key, value string) *ExecuteLifecycle
Header set a key, value pair in the ExecuteLifecycle headers map.
func (*ExecuteLifecycle) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*ExecuteLifecycle) Human ¶
func (r *ExecuteLifecycle) Human(human bool) *ExecuteLifecycle
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 (ExecuteLifecycle) IsSuccess ¶
func (r ExecuteLifecycle) 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 (*ExecuteLifecycle) MasterTimeout ¶
func (r *ExecuteLifecycle) MasterTimeout(duration string) *ExecuteLifecycle
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. API name: master_timeout
func (ExecuteLifecycle) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*ExecuteLifecycle) Pretty ¶
func (r *ExecuteLifecycle) Pretty(pretty bool) *ExecuteLifecycle
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*ExecuteLifecycle) Timeout ¶
func (r *ExecuteLifecycle) Timeout(duration string) *ExecuteLifecycle
Timeout The 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
type NewExecuteLifecycle ¶
type NewExecuteLifecycle func(policyid string) *ExecuteLifecycle
NewExecuteLifecycle type alias for index.
func NewExecuteLifecycleFunc ¶
func NewExecuteLifecycleFunc(tp elastictransport.Interface) NewExecuteLifecycle
NewExecuteLifecycleFunc returns a new instance of ExecuteLifecycle with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files