Package co.elastic.clients.elasticsearch.transform

Class StopTransformRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • transformId

      public StopTransformRequest.Builder transformId​(java.lang.String value)
      Required - The id of the transform to stop

      API name: transform_id

    • allowNoMatch

      public StopTransformRequest.Builder allowNoMatch​(@Nullable java.lang.Boolean value)
      Whether to ignore if a wildcard expression matches no transforms. (This includes _all string or when no transforms have been specified)

      API name: allow_no_match

    • force

      public StopTransformRequest.Builder force​(@Nullable java.lang.Boolean value)
      Whether to force stop a failed transform or not. Default to false

      API name: force

    • timeout

      public StopTransformRequest.Builder timeout​(@Nullable java.lang.String value)
      Controls the time to wait until the transform has stopped. Default to 30 seconds

      API name: timeout

    • waitForCheckpoint

      public StopTransformRequest.Builder waitForCheckpoint​(@Nullable java.lang.Boolean value)
      Whether to wait for the transform to reach a checkpoint before stopping. Default to false

      API name: wait_for_checkpoint

    • waitForCompletion

      public StopTransformRequest.Builder waitForCompletion​(@Nullable java.lang.Boolean value)
      Whether to wait for the transform to fully stop before returning or not. Default to false

      API name: wait_for_completion

    • build

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