Package co.elastic.clients.elasticsearch.async_search

Class DeleteAsyncSearchRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.async_search.DeleteAsyncSearchRequest

public class DeleteAsyncSearchRequest
extends RequestBase

Deletes an async search by identifier. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<DeleteAsyncSearchRequest,DeleteAsyncSearchResponse,ErrorResponse>	_ENDPOINT	Endpoint "async_search.delete".

Method Summary

Modifier and Type	Method	Description
final String	id()	Required - A unique identifier for the async search.
static DeleteAsyncSearchRequest	of(Function<DeleteAsyncSearchRequest.Builder,ObjectBuilder<DeleteAsyncSearchRequest>> 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<DeleteAsyncSearchRequest,DeleteAsyncSearchResponse,ErrorResponse> _ENDPOINT

Endpoint "async_search.delete".

Method Details

of

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

id

public final String id()

Required - A unique identifier for the async search.

API name: id