Documentation
¶
Overview ¶
Deletes the data stream lifecycle of the selected data streams.
Index ¶
- Variables
- type DeleteDataLifecycle
- func (r DeleteDataLifecycle) Do(providedCtx context.Context) (*Response, error)
- func (r *DeleteDataLifecycle) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *DeleteDataLifecycle
- func (r *DeleteDataLifecycle) Header(key, value string) *DeleteDataLifecycle
- func (r *DeleteDataLifecycle) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r DeleteDataLifecycle) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *DeleteDataLifecycle) MasterTimeout(duration string) *DeleteDataLifecycle
- func (r DeleteDataLifecycle) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *DeleteDataLifecycle) Timeout(duration string) *DeleteDataLifecycle
- type NewDeleteDataLifecycle
- 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 DeleteDataLifecycle ¶
type DeleteDataLifecycle struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *DeleteDataLifecycle
Deletes the data stream lifecycle of the selected data streams.
https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-delete-lifecycle.html
func (DeleteDataLifecycle) Do ¶
func (r DeleteDataLifecycle) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a deletedatalifecycle.Response
func (*DeleteDataLifecycle) ExpandWildcards ¶
func (r *DeleteDataLifecycle) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *DeleteDataLifecycle
ExpandWildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) API name: expand_wildcards
func (*DeleteDataLifecycle) Header ¶
func (r *DeleteDataLifecycle) Header(key, value string) *DeleteDataLifecycle
Header set a key, value pair in the DeleteDataLifecycle headers map.
func (*DeleteDataLifecycle) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (DeleteDataLifecycle) IsSuccess ¶
func (r DeleteDataLifecycle) 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 (*DeleteDataLifecycle) MasterTimeout ¶
func (r *DeleteDataLifecycle) MasterTimeout(duration string) *DeleteDataLifecycle
MasterTimeout Specify timeout for connection to master API name: master_timeout
func (DeleteDataLifecycle) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*DeleteDataLifecycle) Timeout ¶
func (r *DeleteDataLifecycle) Timeout(duration string) *DeleteDataLifecycle
Timeout Explicit timestamp for the document API name: timeout
type NewDeleteDataLifecycle ¶
type NewDeleteDataLifecycle func(name string) *DeleteDataLifecycle
NewDeleteDataLifecycle type alias for index.
func NewDeleteDataLifecycleFunc ¶
func NewDeleteDataLifecycleFunc(tp elastictransport.Interface) NewDeleteDataLifecycle
NewDeleteDataLifecycleFunc returns a new instance of DeleteDataLifecycle with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files