Package co.elastic.clients.elasticsearch.sql

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

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetAsyncRequest	build()	Builds a GetAsyncRequest.
final GetAsyncRequest.Builder	delimiter(String value)	Separator for CSV results.
final GetAsyncRequest.Builder	format(String value)	Format for the response.
final GetAsyncRequest.Builder	id(String value)	Required - The async search ID
final GetAsyncRequest.Builder	keepAlive(Time value)	Retention period for the search and its results.
final GetAsyncRequest.Builder	keepAlive(Function<Time.Builder,ObjectBuilder<Time>> fn)	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	waitForCompletionTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

delimiter

public final GetAsyncRequest.Builder delimiter(@Nullable
 String value)

Separator for CSV results. The API only supports this parameter for CSV responses.

API name: delimiter

format

public final GetAsyncRequest.Builder format(@Nullable
 String value)

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

public final GetAsyncRequest.Builder id(String value)

Required - The async search ID

API name: id

keepAlive

public final GetAsyncRequest.Builder keepAlive(@Nullable
 Time value)

Retention period for the search and its results. Defaults to the keep_alive period for the original SQL search.

API name: keep_alive

keepAlive

public final GetAsyncRequest.Builder keepAlive(Function<Time.Builder,ObjectBuilder<Time>> fn)

Retention period for the search and its results. Defaults to the keep_alive period for the original SQL search.

API name: keep_alive

waitForCompletionTimeout

public final GetAsyncRequest.Builder waitForCompletionTimeout(@Nullable
 Time value)

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

protected GetAsyncRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetAsyncRequest.Builder>

build

public GetAsyncRequest build()

Builds a GetAsyncRequest.

Specified by:

build in interface ObjectBuilder<GetAsyncRequest>

Throws:

NullPointerException - if some of the required fields are null.