Package co.elastic.clients.elasticsearch.async_search

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 a GetAsyncSearchRequest.
final GetAsyncSearchRequest.Builder	id(String value)	Required - The async search ID
final GetAsyncSearchRequest.Builder	keepAlive(Time value)	Specify the time interval in which the results (partial or final) for this search will be available
final GetAsyncSearchRequest.Builder	keepAlive(Function<Time.Builder,ObjectBuilder<Time>> fn)	Specify the time interval in which the results (partial or final) for this search will be available
protected GetAsyncSearchRequest.Builder	self()
final GetAsyncSearchRequest.Builder	waitForCompletionTimeout(Time value)	Specify the time that the request should block waiting for the final response
final GetAsyncSearchRequest.Builder	waitForCompletionTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Specify the time that the request should block waiting for the final response

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

id

public final GetAsyncSearchRequest.Builder id(String value)

Required - The async search ID

API name: id

keepAlive

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

Specify the time interval in which the results (partial or final) for this search will be available

API name: keep_alive

keepAlive

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

Specify the time interval in which the results (partial or final) for this search will be available

API name: keep_alive

waitForCompletionTimeout

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

Specify the time that the request should block waiting for the final response

API name: wait_for_completion_timeout

waitForCompletionTimeout

public final GetAsyncSearchRequest.Builder waitForCompletionTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Specify the time that the request should block waiting for the final response

API name: wait_for_completion_timeout

self

protected GetAsyncSearchRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetAsyncSearchRequest.Builder>

build

public GetAsyncSearchRequest build()

Builds a GetAsyncSearchRequest.

Specified by:

build in interface ObjectBuilder<GetAsyncSearchRequest>

Throws:

NullPointerException - if some of the required fields are null.