Package co.elastic.clients.elasticsearch.transform

Class StopTransformRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.transform.StopTransformRequest
public class StopTransformRequest extends RequestBase
Stops one or more transforms.
See Also:

  • Field Details

  • Method Details

    • of

      public static StopTransformRequest of(Function<StopTransformRequest.Builder,ObjectBuilder<StopTransformRequest>> fn)

    • allowNoMatch

      @Nullable public final Boolean allowNoMatch()
      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

      @Nullable public final Boolean force()
      If it is true, the API forcefully stops the transforms.

      API name: force

    • timeout

      @Nullable public final Time timeout()
      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 String transformId()
      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

      @Nullable public final Boolean waitForCheckpoint()
      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

      @Nullable public final Boolean waitForCompletion()
      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