Class StopJobRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.rollup.StopJobRequest
public class StopJobRequest extends RequestBase
Stops an existing, started rollup job.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
StopJobRequest.Builder
Builder forStopJobRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static Endpoint<StopJobRequest,StopJobResponse,ErrorResponse>
_ENDPOINT
Endpoint "rollup.stop_job
". -
Method Summary
Modifier and Type Method Description java.lang.String
id()
Required - The ID of the job to stopstatic StopJobRequest
of(java.util.function.Function<StopJobRequest.Builder,ObjectBuilder<StopJobRequest>> fn)
Time
timeout()
Block for (at maximum) the specified duration while waiting for the job to stop.java.lang.Boolean
waitForCompletion()
True if the API should block until the job has fully stopped, false if should be executed async.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_ENDPOINT
Endpoint "rollup.stop_job
".
-
-
Method Details
-
of
public static StopJobRequest of(java.util.function.Function<StopJobRequest.Builder,ObjectBuilder<StopJobRequest>> fn) -
id
public final java.lang.String 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
@Nullable public final java.lang.Boolean 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
-