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
  • Field Details

  • 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 stop

      API name: id

    • timeout

      @Nullable public final Time 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