Package co.elastic.clients.elasticsearch.async_search

Class AsyncSearchStatusRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.async_search.AsyncSearchStatusRequest

public class AsyncSearchStatusRequest
extends RequestBase

Get the async search status.

Get the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:

• The user or API key that submitted the original async search request.
• Users that have the monitor cluster privilege or greater privileges.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<AsyncSearchStatusRequest,AsyncSearchStatusResponse,ErrorResponse>	_ENDPOINT	Endpoint "async_search.status".

Method Summary

Modifier and Type	Method	Description
final String	id()	Required - A unique identifier for the async search.
final Time	keepAlive()	The length of time that the async search needs to be available.
static AsyncSearchStatusRequest	of(Function<AsyncSearchStatusRequest.Builder,ObjectBuilder<AsyncSearchStatusRequest>> 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<AsyncSearchStatusRequest,AsyncSearchStatusResponse,ErrorResponse> _ENDPOINT

Endpoint "async_search.status".

Method Details

of

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

id

public final String id()

Required - A unique identifier for the async search.

API name: id

keepAlive

@Nullable
public final Time keepAlive()

The length of time that the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period.

API name: keep_alive