Documentation
¶
Overview ¶
Delete an async ES|QL query. If the query is still running, it is cancelled. Otherwise, the stored results are deleted.
If the Elasticsearch security features are enabled, only the following users can use this API to delete a query:
* The authenticated user that submitted the original query request * Users with the `cancel_task` cluster privilege
Index ¶
- Variables
- type AsyncQueryDelete
- func (r AsyncQueryDelete) Do(providedCtx context.Context) (*Response, error)
- func (r *AsyncQueryDelete) ErrorTrace(errortrace bool) *AsyncQueryDelete
- func (r *AsyncQueryDelete) FilterPath(filterpaths ...string) *AsyncQueryDelete
- func (r *AsyncQueryDelete) Header(key, value string) *AsyncQueryDelete
- func (r *AsyncQueryDelete) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *AsyncQueryDelete) Human(human bool) *AsyncQueryDelete
- func (r AsyncQueryDelete) IsSuccess(providedCtx context.Context) (bool, error)
- func (r AsyncQueryDelete) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *AsyncQueryDelete) Pretty(pretty bool) *AsyncQueryDelete
- type NewAsyncQueryDelete
- 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 AsyncQueryDelete ¶
type AsyncQueryDelete struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *AsyncQueryDelete
Delete an async ES|QL query. If the query is still running, it is cancelled. Otherwise, the stored results are deleted.
If the Elasticsearch security features are enabled, only the following users can use this API to delete a query:
* The authenticated user that submitted the original query request * Users with the `cancel_task` cluster privilege
https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-esql-async-query-delete
func (AsyncQueryDelete) Do ¶
func (r AsyncQueryDelete) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a asyncquerydelete.Response
func (*AsyncQueryDelete) ErrorTrace ¶
func (r *AsyncQueryDelete) ErrorTrace(errortrace bool) *AsyncQueryDelete
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*AsyncQueryDelete) FilterPath ¶
func (r *AsyncQueryDelete) FilterPath(filterpaths ...string) *AsyncQueryDelete
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*AsyncQueryDelete) Header ¶
func (r *AsyncQueryDelete) Header(key, value string) *AsyncQueryDelete
Header set a key, value pair in the AsyncQueryDelete headers map.
func (*AsyncQueryDelete) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*AsyncQueryDelete) Human ¶
func (r *AsyncQueryDelete) Human(human bool) *AsyncQueryDelete
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 (AsyncQueryDelete) IsSuccess ¶
func (r AsyncQueryDelete) 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 (AsyncQueryDelete) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*AsyncQueryDelete) Pretty ¶
func (r *AsyncQueryDelete) Pretty(pretty bool) *AsyncQueryDelete
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
type NewAsyncQueryDelete ¶
type NewAsyncQueryDelete func(id string) *AsyncQueryDelete
NewAsyncQueryDelete type alias for index.
func NewAsyncQueryDeleteFunc ¶
func NewAsyncQueryDeleteFunc(tp elastictransport.Interface) NewAsyncQueryDelete
NewAsyncQueryDeleteFunc returns a new instance of AsyncQueryDelete with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files