Class StopTransformRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.transform.StopTransformRequest.Builder
All Implemented Interfaces:
ObjectBuilder<StopTransformRequest>
Enclosing class:
StopTransformRequest

public static class StopTransformRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<StopTransformRequest>
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • allowNoMatch

      public final StopTransformRequest.Builder allowNoMatch​(@Nullable java.lang.Boolean value)
      Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the _all string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.

      If it is true, the API returns a successful acknowledgement message when there are no matches. When there are only partial matches, the API stops the appropriate transforms.

      If it is false, the request returns a 404 status code when there are no matches or only partial matches.

      API name: allow_no_match

    • force

      public final StopTransformRequest.Builder force​(@Nullable java.lang.Boolean value)
      If it is true, the API forcefully stops the transforms.

      API name: force

    • timeout

      public final StopTransformRequest.Builder timeout​(@Nullable Time value)
      Period to wait for a response when wait_for_completion is true. If no response is received before the timeout expires, the request returns a timeout exception. However, the request continues processing and eventually moves the transform to a STOPPED state.

      API name: timeout

    • timeout

      public final StopTransformRequest.Builder timeout​(java.util.function.Function<Time.Builder,​ObjectBuilder<Time>> fn)
      Period to wait for a response when wait_for_completion is true. If no response is received before the timeout expires, the request returns a timeout exception. However, the request continues processing and eventually moves the transform to a STOPPED state.

      API name: timeout

    • transformId

      public final StopTransformRequest.Builder transformId​(java.lang.String value)
      Required - Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression. To stop all transforms, use _all or * as the identifier.

      API name: transform_id

    • waitForCheckpoint

      public final StopTransformRequest.Builder waitForCheckpoint​(@Nullable java.lang.Boolean value)
      If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false, the transform stops as soon as possible.

      API name: wait_for_checkpoint

    • waitForCompletion

      public final StopTransformRequest.Builder waitForCompletion​(@Nullable java.lang.Boolean value)
      If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns immediately and the indexer is stopped asynchronously in the background.

      API name: wait_for_completion

    • build

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