StopTransformRequest (java-client 8.0.0-rc1 API)

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:: API specification

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class StopTransformRequest.Builder
Builder for StopTransformRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
Field Summary

Fields

Modifier and Type Field Description

static Endpoint<StopTransformRequest,StopTransformResponse,ErrorResponse> _ENDPOINT
Endpoint "transform.stop_transform".

Method Summary

Modifier and Type	Method	Description
`java.lang.Boolean`	`allowNoMatch()`	Whether to ignore if a wildcard expression matches no transforms.
`java.lang.Boolean`	`force()`	Whether to force stop a failed transform or not.
`static StopTransformRequest`	`of(java.util.function.Function<StopTransformRequest.Builder,ObjectBuilder<StopTransformRequest>> fn)`
`Time`	`timeout()`	Controls the time to wait until the transform has stopped.
`java.lang.String`	`transformId()`	Required - The id of the transform to stop
`java.lang.Boolean`	`waitForCheckpoint()`	Whether to wait for the transform to reach a checkpoint before stopping.
`java.lang.Boolean`	`waitForCompletion()`	Whether to wait for the transform to fully stop before returning or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- _ENDPOINT
  
  public static final Endpoint<StopTransformRequest,StopTransformResponse,ErrorResponse> _ENDPOINT
  
  Endpoint "transform.stop_transform".
Method Details
- of
  
  public static StopTransformRequest of(java.util.function.Function<StopTransformRequest.Builder,ObjectBuilder<StopTransformRequest>> fn)
- allowNoMatch
  
  @Nullable public final java.lang.Boolean allowNoMatch()
  
  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
  
  @Nullable public final java.lang.Boolean force()
  
  Whether to force stop a failed transform or not. Default to false
  API name: force
- timeout
  
  @Nullable public final Time timeout()
  
  Controls the time to wait until the transform has stopped. Default to 30 seconds
  API name: timeout
- transformId
  
  public final java.lang.String transformId()
  
  Required - The id of the transform to stop
  API name: transform_id
- waitForCheckpoint
  
  @Nullable public final java.lang.Boolean waitForCheckpoint()
  
  Whether to wait for the transform to reach a checkpoint before stopping. Default to false
  API name: wait_for_checkpoint
- waitForCompletion
  
  @Nullable public final java.lang.Boolean waitForCompletion()
  
  Whether to wait for the transform to fully stop before returning or not. Default to false
  API name: wait_for_completion