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 - The ID of the job to stopprotected StopJobRequest.Builder
self()
final StopJobRequest.Builder
Block for (at maximum) the specified duration while waiting for the job to stop.final StopJobRequest.Builder
Block for (at maximum) the specified duration while waiting for the job to stop.final StopJobRequest.Builder
waitForCompletion
(Boolean value) True if the API should block until the job has fully stopped, false if should be executed async.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 - The ID of the job to stopAPI name:
id
-
timeout
Block for (at maximum) the specified duration while waiting for the job to stop. Defaults to 30s.API name:
timeout
-
timeout
Block for (at maximum) the specified duration while waiting for the job to stop. Defaults to 30s.API name:
timeout
-
waitForCompletion
True if the API should block until the job has fully stopped, false if should be executed async. Defaults to false.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.
-