Class GetAsyncSearchRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.async_search.GetAsyncSearchRequest
Retrieves the results of a previously submitted async search request given
its identifier. If the Elasticsearch security features are enabled, access to
the results of a specific async search is restricted to the user or API key
that submitted it.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final SimpleEndpoint<GetAsyncSearchRequest,
?> Endpoint "async_search.get
". -
Method Summary
Modifier and TypeMethodDescriptionstatic <TDocument>
Endpoint<GetAsyncSearchRequest,GetAsyncSearchResponse<TDocument>, ErrorResponse> createGetEndpoint
(JsonpDeserializer<TDocument> tDocumentDeserializer) Create an "async_search.get
" endpoint.final String
id()
Required - A unique identifier for the async search.final Time
Specifies how long the async search should be available in the cluster.static GetAsyncSearchRequest
final Time
Specifies to wait for the search to be completed up until the provided timeout.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "async_search.get
".
-
-
Method Details
-
of
public static GetAsyncSearchRequest of(Function<GetAsyncSearchRequest.Builder, ObjectBuilder<GetAsyncSearchRequest>> fn) -
id
Required - A unique identifier for the async search.API name:
id
-
keepAlive
Specifies how long the async search should be available in the cluster. When not specified, thekeep_alive
set with the corresponding submit async request will be used. Otherwise, it is possible to override the value and extend the validity of the request. When this period expires, the search, if still running, is cancelled. If the search is completed, its saved results are deleted.API name:
keep_alive
-
waitForCompletionTimeout
Specifies to wait for the search to be completed up until the provided timeout. Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires. By default no timeout is set meaning that the currently available results will be returned without any additional wait.API name:
wait_for_completion_timeout
-
createGetEndpoint
public static <TDocument> Endpoint<GetAsyncSearchRequest,GetAsyncSearchResponse<TDocument>, createGetEndpointErrorResponse> (JsonpDeserializer<TDocument> tDocumentDeserializer) Create an "async_search.get
" endpoint.
-