The highest tagged major version is
Documentation
¶
Overview ¶
Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error.
Index ¶
- Variables
- type DeleteLifecycle
- func (r DeleteLifecycle) Do(providedCtx context.Context) (*Response, error)
- func (r *DeleteLifecycle) ErrorTrace(errortrace bool) *DeleteLifecycle
- func (r *DeleteLifecycle) FilterPath(filterpaths ...string) *DeleteLifecycle
- func (r *DeleteLifecycle) Header(key, value string) *DeleteLifecycle
- func (r *DeleteLifecycle) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *DeleteLifecycle) Human(human bool) *DeleteLifecycle
- func (r DeleteLifecycle) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *DeleteLifecycle) MasterTimeout(duration string) *DeleteLifecycle
- func (r DeleteLifecycle) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *DeleteLifecycle) Pretty(pretty bool) *DeleteLifecycle
- func (r *DeleteLifecycle) Timeout(duration string) *DeleteLifecycle
- type NewDeleteLifecycle
- 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 DeleteLifecycle ¶
type DeleteLifecycle struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *DeleteLifecycle
Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error.
https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html
func (DeleteLifecycle) Do ¶
func (r DeleteLifecycle) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a deletelifecycle.Response
func (*DeleteLifecycle) ErrorTrace ¶ added in v8.14.0
func (r *DeleteLifecycle) ErrorTrace(errortrace bool) *DeleteLifecycle
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*DeleteLifecycle) FilterPath ¶ added in v8.14.0
func (r *DeleteLifecycle) FilterPath(filterpaths ...string) *DeleteLifecycle
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*DeleteLifecycle) Header ¶
func (r *DeleteLifecycle) Header(key, value string) *DeleteLifecycle
Header set a key, value pair in the DeleteLifecycle headers map.
func (*DeleteLifecycle) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*DeleteLifecycle) Human ¶ added in v8.14.0
func (r *DeleteLifecycle) Human(human bool) *DeleteLifecycle
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 (DeleteLifecycle) IsSuccess ¶
func (r DeleteLifecycle) 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 (*DeleteLifecycle) MasterTimeout ¶
func (r *DeleteLifecycle) MasterTimeout(duration string) *DeleteLifecycle
MasterTimeout 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 (DeleteLifecycle) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*DeleteLifecycle) Pretty ¶ added in v8.14.0
func (r *DeleteLifecycle) Pretty(pretty bool) *DeleteLifecycle
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*DeleteLifecycle) Timeout ¶
func (r *DeleteLifecycle) Timeout(duration string) *DeleteLifecycle
Timeout 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 NewDeleteLifecycle ¶
type NewDeleteLifecycle func(policy string) *DeleteLifecycle
NewDeleteLifecycle type alias for index.
func NewDeleteLifecycleFunc ¶
func NewDeleteLifecycleFunc(tp elastictransport.Interface) NewDeleteLifecycle
NewDeleteLifecycleFunc returns a new instance of DeleteLifecycle with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files