Class StopJobRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.rollup.StopJobRequest
Stops an existing, started rollup job.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<StopJobRequest,
StopJobResponse, ErrorResponse> Endpoint "rollup.stop_job
". -
Method Summary
Modifier and TypeMethodDescriptionfinal String
id()
Required - Identifier for the rollup job.static StopJobRequest
final Time
timeout()
Ifwait_for_completion
istrue
, the API blocks for (at maximum) the specified duration while waiting for the job to stop.final Boolean
If set totrue
, causes the API to block until the indexer state completely stops.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "rollup.stop_job
".
-
-
Method Details
-
of
-
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
-
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
-