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 - The ID of the job to stopstatic StopJobRequest
final Time
timeout()
Block for (at maximum) the specified duration while waiting for the job to stop.final Boolean
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.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "rollup.stop_job
".
-
-
Method Details
-
of
-
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
-
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
-