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
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aEqlGetRequest
.final EqlGetRequest.Builder
Required - Identifier for the search.final EqlGetRequest.Builder
Period for which the search and its results are stored on the cluster.final EqlGetRequest.Builder
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
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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
id
Required - Identifier for the search.API name:
id
-
keepAlive
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
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
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
- Specified by:
self
in classRequestBase.AbstractBuilder<EqlGetRequest.Builder>
-
build
Builds aEqlGetRequest
.- Specified by:
build
in interfaceObjectBuilder<EqlGetRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-