Class GetAsyncRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.sql.GetAsyncRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<GetAsyncRequest>
- Enclosing class:
- GetAsyncRequest
public static class GetAsyncRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<GetAsyncRequest>
Builder for
GetAsyncRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description GetAsyncRequest
build()
Builds aGetAsyncRequest
.GetAsyncRequest.Builder
delimiter(java.lang.String value)
Separator for CSV results.GetAsyncRequest.Builder
format(java.lang.String value)
Format for the response.GetAsyncRequest.Builder
id(java.lang.String value)
Required - The async search IDGetAsyncRequest.Builder
keepAlive(Time value)
Retention period for the search and its results.GetAsyncRequest.Builder
keepAlive(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Retention period for the search and its results.GetAsyncRequest.Builder
waitForCompletionTimeout(Time value)
Period to wait for complete results.GetAsyncRequest.Builder
waitForCompletionTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Period to wait for complete results.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
-
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 - The async search IDAPI 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
public final GetAsyncRequest.Builder keepAlive(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)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(java.util.function.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
-
build
Builds aGetAsyncRequest
.- Specified by:
build
in interfaceObjectBuilder<GetAsyncRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-