Package co.elastic.clients.elasticsearch.eql

Class EqlGetRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.eql.EqlGetRequest.Builder

All Implemented Interfaces:

WithJson<EqlGetRequest.Builder>, ObjectBuilder<EqlGetRequest>

Enclosing class:

EqlGetRequest

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

Builder for EqlGetRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EqlGetRequest	build()	Builds a EqlGetRequest.
final EqlGetRequest.Builder	id(String value)	Required - Identifier for the search.
final EqlGetRequest.Builder	keepAlive(Time value)	Period for which the search and its results are stored on the cluster.
final EqlGetRequest.Builder	keepAlive(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period for which the search and its results are stored on the cluster.
protected EqlGetRequest.Builder	self()
final EqlGetRequest.Builder	waitForCompletionTimeout(Time value)	Timeout duration to wait for the request to finish.
final EqlGetRequest.Builder	waitForCompletionTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Timeout duration to wait for the request to finish.

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

Required - Identifier for the search.

API name: id

keepAlive

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

Period for which the search and its results are stored on the cluster. Defaults to the keep_alive value set by the search’s EQL search API request.

API name: keep_alive

keepAlive

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

Period for which the search and its results are stored on the cluster. Defaults to the keep_alive value set by the search’s EQL search API request.

API name: keep_alive

waitForCompletionTimeout

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

Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results.

API name: wait_for_completion_timeout

waitForCompletionTimeout

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

Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results.

API name: wait_for_completion_timeout

self

protected EqlGetRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<EqlGetRequest.Builder>

build

public EqlGetRequest build()

Builds a EqlGetRequest.

Specified by:

build in interface ObjectBuilder<EqlGetRequest>

Throws:

NullPointerException - if some of the required fields are null.