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
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description GetAsyncSearchRequest
build()
Builds aGetAsyncSearchRequest
.GetAsyncSearchRequest.Builder
id(java.lang.String value)
Required - The async search IDGetAsyncSearchRequest.Builder
keepAlive(Time value)
Specify the time interval in which the results (partial or final) for this search will be availableGetAsyncSearchRequest.Builder
keepAlive(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Specify the time interval in which the results (partial or final) for this search will be availableprotected GetAsyncSearchRequest.Builder
self()
GetAsyncSearchRequest.Builder
waitForCompletionTimeout(Time value)
Specify the time that the request should block waiting for the final responseGetAsyncSearchRequest.Builder
waitForCompletionTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Specify the time that the request should block waiting for the final responseMethods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
id
Required - The async search IDAPI name:
id
-
keepAlive
Specify the time interval in which the results (partial or final) for this search will be availableAPI name:
keep_alive
-
keepAlive
public final GetAsyncSearchRequest.Builder keepAlive(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)Specify the time interval in which the results (partial or final) for this search will be availableAPI name:
keep_alive
-
waitForCompletionTimeout
Specify the time that the request should block waiting for the final responseAPI name:
wait_for_completion_timeout
-
waitForCompletionTimeout
public final GetAsyncSearchRequest.Builder waitForCompletionTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)Specify the time that the request should block waiting for the final responseAPI name:
wait_for_completion_timeout
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<GetAsyncSearchRequest.Builder>
-
build
Builds aGetAsyncSearchRequest
.- Specified by:
build
in interfaceObjectBuilder<GetAsyncSearchRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-