Package co.elastic.clients.elasticsearch.rollup

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
@Deprecated public static class StopJobRequest.Builder extends RequestBase.AbstractBuilder<StopJobRequest.Builder> implements ObjectBuilder<StopJobRequest>
Deprecated.
Builder for StopJobRequest.

  • Constructor Details

    • Builder

      public Builder()
      Deprecated.

  • Method Details

    • id

      public final StopJobRequest.Builder id(String value)
      Deprecated.
      Required - Identifier for the rollup job.

      API name: id

    • timeout

      public final StopJobRequest.Builder timeout(@Nullable Time value)
      Deprecated.
      If wait_for_completion is true, the API blocks for (at maximum) the specified duration while waiting for the job to stop. If more than timeout time has passed, the API throws a timeout exception. NOTE: Even if a timeout occurs, the stop request is still processing and eventually moves the job to STOPPED. The timeout simply means the API call itself timed out while waiting for the status change.

      API name: timeout

    • timeout

      public final StopJobRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      Deprecated.
      If wait_for_completion is true, the API blocks for (at maximum) the specified duration while waiting for the job to stop. If more than timeout time has passed, the API throws a timeout exception. NOTE: Even if a timeout occurs, the stop request is still processing and eventually moves the job to STOPPED. The timeout simply means the API call itself timed out while waiting for the status change.

      API name: timeout

    • waitForCompletion

      public final StopJobRequest.Builder waitForCompletion(@Nullable Boolean value)
      Deprecated.
      If set to true, causes the API to block until the indexer state completely stops. If set to false, the API returns immediately and the indexer is stopped asynchronously in the background.

      API name: wait_for_completion

    • self

      protected StopJobRequest.Builder self()
      Deprecated.
      Specified by:
      self in class RequestBase.AbstractBuilder<StopJobRequest.Builder>

    • build

      public StopJobRequest build()
      Deprecated.
      Builds a StopJobRequest.
      Specified by:
      build in interface ObjectBuilder<StopJobRequest>
      Throws:
      NullPointerException - if some of the required fields are null.