Package co.elastic.clients.elasticsearch.async_search

Class GetAsyncSearchRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.async_search.GetAsyncSearchRequest

public class GetAsyncSearchRequest
extends RequestBase

Retrieves the results of a previously submitted async search request given its ID.

See Also:

API specification

Nested Class Summary

Nested Classes

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

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 SimpleEndpoint<GetAsyncSearchRequest,?>	_ENDPOINT	Endpoint "async_search.get".

Method Summary

Modifier and Type	Method	Description
static <TDocument> Endpoint<GetAsyncSearchRequest,GetAsyncSearchResponse<TDocument>,ErrorResponse>	createGetEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create an "async_search.get" endpoint.
java.lang.String	id()	Required - The async search ID
Time	keepAlive()	Specify the time interval in which the results (partial or final) for this search will be available
static GetAsyncSearchRequest	of(java.util.function.Function<GetAsyncSearchRequest.Builder,ObjectBuilder<GetAsyncSearchRequest>> fn)
Time	waitForCompletionTimeout()	Specify the time that the request should block waiting for the final response

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 SimpleEndpoint<GetAsyncSearchRequest,?> _ENDPOINT

Endpoint "async_search.get".

Method Details

of

public static GetAsyncSearchRequest of(java.util.function.Function<GetAsyncSearchRequest.Builder,ObjectBuilder<GetAsyncSearchRequest>> fn)

id

public final java.lang.String id()

Required - The async search ID

API name: id

keepAlive

@Nullable
public final Time keepAlive()

Specify the time interval in which the results (partial or final) for this search will be available

API name: keep_alive

waitForCompletionTimeout

@Nullable
public final Time waitForCompletionTimeout()

Specify the time that the request should block waiting for the final response

API name: wait_for_completion_timeout

createGetEndpoint

public static <TDocument>
Endpoint<GetAsyncSearchRequest,GetAsyncSearchResponse<TDocument>,ErrorResponse> createGetEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)

Create an "async_search.get" endpoint.