Class GetAsyncRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetAsyncRequest.Builder>
co.elastic.clients.elasticsearch.sql.GetAsyncRequest.Builder
- All Implemented Interfaces:
WithJson<GetAsyncRequest.Builder>
,ObjectBuilder<GetAsyncRequest>
- Enclosing class:
- GetAsyncRequest
public static class GetAsyncRequest.Builder
extends RequestBase.AbstractBuilder<GetAsyncRequest.Builder>
implements ObjectBuilder<GetAsyncRequest>
Builder for
GetAsyncRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aGetAsyncRequest
.final GetAsyncRequest.Builder
Separator for CSV results.final GetAsyncRequest.Builder
Format for the response.final GetAsyncRequest.Builder
Required - Identifier for the search.final GetAsyncRequest.Builder
Retention period for the search and its results.final GetAsyncRequest.Builder
Retention period for the search and its results.protected GetAsyncRequest.Builder
self()
final GetAsyncRequest.Builder
waitForCompletionTimeout
(Time value) Period to wait for complete results.final GetAsyncRequest.Builder
Period to wait for complete results.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
-
delimiter
Separator for CSV results. The API only supports this parameter for CSV responses.API name:
delimiter
-
format
Format for the response. You must specify a format using this parameter or the Accept HTTP header. If you specify both, the API uses this parameter.API name:
format
-
id
Required - Identifier for the search.API name:
id
-
keepAlive
Retention period for the search and its results. Defaults to thekeep_alive
period for the original SQL search.API name:
keep_alive
-
keepAlive
Retention period for the search and its results. Defaults to thekeep_alive
period for the original SQL search.API name:
keep_alive
-
waitForCompletionTimeout
Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results.API name:
wait_for_completion_timeout
-
waitForCompletionTimeout
public final GetAsyncRequest.Builder waitForCompletionTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results.API name:
wait_for_completion_timeout
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<GetAsyncRequest.Builder>
-
build
Builds aGetAsyncRequest
.- Specified by:
build
in interfaceObjectBuilder<GetAsyncRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-