Class StopJobRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<StopJobRequest.Builder>
co.elastic.clients.elasticsearch.rollup.StopJobRequest.Builder
- All Implemented Interfaces:
WithJson<StopJobRequest.Builder>
,ObjectBuilder<StopJobRequest>
- Enclosing class:
- StopJobRequest
public static class StopJobRequest.Builder
extends RequestBase.AbstractBuilder<StopJobRequest.Builder>
implements ObjectBuilder<StopJobRequest>
Builder for
StopJobRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aStopJobRequest
.final StopJobRequest.Builder
Required - Identifier for the rollup job.protected StopJobRequest.Builder
self()
final StopJobRequest.Builder
Ifwait_for_completion
istrue
, the API blocks for (at maximum) the specified duration while waiting for the job to stop.final StopJobRequest.Builder
Ifwait_for_completion
istrue
, the API blocks for (at maximum) the specified duration while waiting for the job to stop.final StopJobRequest.Builder
waitForCompletion
(Boolean value) If set totrue
, causes the API to block until the indexer state completely stops.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 rollup job.API name:
id
-
timeout
Ifwait_for_completion
istrue
, the API blocks for (at maximum) the specified duration while waiting for the job to stop. If more thantimeout
time has passed, the API throws a timeout exception.API name:
timeout
-
timeout
Ifwait_for_completion
istrue
, the API blocks for (at maximum) the specified duration while waiting for the job to stop. If more thantimeout
time has passed, the API throws a timeout exception.API name:
timeout
-
waitForCompletion
If set totrue
, causes the API to block until the indexer state completely stops. If set tofalse
, the API returns immediately and the indexer is stopped asynchronously in the background.API name:
wait_for_completion
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<StopJobRequest.Builder>
-
build
Builds aStopJobRequest
.- Specified by:
build
in interfaceObjectBuilder<StopJobRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-