Package co.elastic.clients.elasticsearch.transform

Class StopTransformRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.transform.StopTransformRequest

All Implemented Interfaces:

ElasticsearchCommonRequest

public final class StopTransformRequest
extends RequestBase

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,ElasticsearchError>	ENDPOINT	Endpoint "transform.stop_transform".

Constructor Summary

Constructors

Constructor	Description
StopTransformRequest(StopTransformRequest.Builder builder)
StopTransformRequest(java.util.function.Function<StopTransformRequest.Builder,StopTransformRequest.Builder> fn)

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.
java.lang.String	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,ElasticsearchError> ENDPOINT

Endpoint "transform.stop_transform".

Constructor Details

StopTransformRequest

public StopTransformRequest(StopTransformRequest.Builder builder)

StopTransformRequest

public StopTransformRequest(java.util.function.Function<StopTransformRequest.Builder,StopTransformRequest.Builder> fn)

Method Details

transformId

public java.lang.String transformId()

Required - The id of the transform to stop

API name: transform_id

allowNoMatch

@Nullable
public 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 java.lang.Boolean force()

Whether to force stop a failed transform or not. Default to false

API name: force

timeout

@Nullable
public java.lang.String timeout()

Controls the time to wait until the transform has stopped. Default to 30 seconds

API name: timeout

waitForCheckpoint

@Nullable
public 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 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