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:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
StopTransformRequest.Builder
Builder forStopTransformRequest
.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()
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.java.lang.Boolean
force()
If it is true, the API forcefully stops the transforms.static StopTransformRequest
of(java.util.function.Function<StopTransformRequest.Builder,ObjectBuilder<StopTransformRequest>> fn)
Time
timeout()
Period to wait for a response whenwait_for_completion
istrue
.java.lang.String
transformId()
Required - Identifier for the transform.java.lang.Boolean
waitForCheckpoint()
If it is true, the transform does not completely stop until the current checkpoint is completed.java.lang.Boolean
waitForCompletion()
If it is true, the API blocks until the indexer state completely stops.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_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()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 java.lang.Boolean force()If it is true, the API forcefully stops the transforms.API name:
force
-
timeout
Period to wait for a response whenwait_for_completion
istrue
. 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 java.lang.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 java.lang.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 java.lang.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
-