Class GetAsyncSearchRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetAsyncSearchRequest.Builder>
co.elastic.clients.elasticsearch.async_search.GetAsyncSearchRequest.Builder
- All Implemented Interfaces:
WithJson<GetAsyncSearchRequest.Builder>
,ObjectBuilder<GetAsyncSearchRequest>
- Enclosing class:
- GetAsyncSearchRequest
public static class GetAsyncSearchRequest.Builder
extends RequestBase.AbstractBuilder<GetAsyncSearchRequest.Builder>
implements ObjectBuilder<GetAsyncSearchRequest>
Builder for
GetAsyncSearchRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aGetAsyncSearchRequest
.Required - A unique identifier for the async search.Specifies how long the async search should be available in the cluster.Specifies how long the async search should be available in the cluster.protected GetAsyncSearchRequest.Builder
self()
waitForCompletionTimeout
(Time value) Specifies to wait for the search to be completed up until the provided timeout.Specifies to wait for the search to be completed up until the provided timeout.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
-
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
-
waitForCompletionTimeout
public final GetAsyncSearchRequest.Builder waitForCompletionTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) 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
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<GetAsyncSearchRequest.Builder>
-
build
Builds aGetAsyncSearchRequest
.- Specified by:
build
in interfaceObjectBuilder<GetAsyncSearchRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-