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