Package co.elastic.clients.elasticsearch.sql

Class DeleteAsyncRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.sql.DeleteAsyncRequest

public class DeleteAsyncRequest
extends RequestBase

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.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeleteAsyncRequest.Builder	Builder for DeleteAsyncRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<DeleteAsyncRequest,DeleteAsyncResponse,ErrorResponse>	_ENDPOINT	Endpoint "sql.delete_async".

Method Summary

Modifier and Type	Method	Description
final String	id()	Required - The identifier for the search.
static DeleteAsyncRequest	of(Function<DeleteAsyncRequest.Builder,ObjectBuilder<DeleteAsyncRequest>> fn)

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_ENDPOINT

public static final Endpoint<DeleteAsyncRequest,DeleteAsyncResponse,ErrorResponse> _ENDPOINT

Endpoint "sql.delete_async".

Method Details

of

public static DeleteAsyncRequest of(Function<DeleteAsyncRequest.Builder,ObjectBuilder<DeleteAsyncRequest>> fn)

id

public final String id()

Required - The identifier for the search.

API name: id