Package co.elastic.clients.elasticsearch.async_search

Class AsyncSearchStatusRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<AsyncSearchStatusRequest.Builder>

co.elastic.clients.elasticsearch.async_search.AsyncSearchStatusRequest.Builder

All Implemented Interfaces:

WithJson<AsyncSearchStatusRequest.Builder>, ObjectBuilder<AsyncSearchStatusRequest>

Enclosing class:

AsyncSearchStatusRequest

public static class AsyncSearchStatusRequest.Builder
extends RequestBase.AbstractBuilder<AsyncSearchStatusRequest.Builder>
implements ObjectBuilder<AsyncSearchStatusRequest>

Builder for AsyncSearchStatusRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AsyncSearchStatusRequest	build()	Builds a AsyncSearchStatusRequest.
final AsyncSearchStatusRequest.Builder	id(String value)	Required - A unique identifier for the async search.
final AsyncSearchStatusRequest.Builder	keepAlive(Time value)	The length of time that the async search needs to be available.
final AsyncSearchStatusRequest.Builder	keepAlive(Function<Time.Builder,ObjectBuilder<Time>> fn)	The length of time that the async search needs to be available.
protected AsyncSearchStatusRequest.Builder	self()

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 AsyncSearchStatusRequest.Builder id(String value)

Required - A unique identifier for the async search.

API name: id

keepAlive

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

The length of time that the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period.

API name: keep_alive

keepAlive

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

The length of time that the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period.

API name: keep_alive

self

protected AsyncSearchStatusRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<AsyncSearchStatusRequest.Builder>

build

public AsyncSearchStatusRequest build()

Builds a AsyncSearchStatusRequest.

Specified by:

build in interface ObjectBuilder<AsyncSearchStatusRequest>

Throws:

NullPointerException - if some of the required fields are null.