Package co.elastic.clients.elasticsearch.rollup

Class StopJobRequest.Builder

java.lang.Object
co.elastic.clients.elasticsearch.rollup.StopJobRequest.Builder
All Implemented Interfaces:
ObjectBuilder<StopJobRequest>
Enclosing class:
StopJobRequest
public static class StopJobRequest.Builder
extends java.lang.Object
implements ObjectBuilder<StopJobRequest>
Builder for StopJobRequest.

  • Constructor Summary

    Constructors
    Constructor Description
    Builder()  

  • Method Summary

    Modifier and Type Method Description
    StopJobRequest build()
    Builds a StopJobRequest.
    StopJobRequest.Builder id​(java.lang.String value)
    Required - The ID of the job to stop
    StopJobRequest.Builder timeout​(java.lang.String value)
    Block for (at maximum) the specified duration while waiting for the job to stop.
    StopJobRequest.Builder waitForCompletion​(java.lang.Boolean value)
    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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • id

      public StopJobRequest.Builder id​(java.lang.String value)
      Required - The ID of the job to stop

      API name: id

    • timeout

      public StopJobRequest.Builder timeout​(@Nullable java.lang.String value)
      Block for (at maximum) the specified duration while waiting for the job to stop. Defaults to 30s.

      API name: timeout

    • waitForCompletion

      public StopJobRequest.Builder waitForCompletion​(@Nullable java.lang.Boolean value)
      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

    • build

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