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