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>
Builder for
StopTransformRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description StopTransformRequest.Builder
allowNoMatch(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.StopTransformRequest
build()
Builds aStopTransformRequest
.StopTransformRequest.Builder
force(java.lang.Boolean value)
If it is true, the API forcefully stops the transforms.StopTransformRequest.Builder
timeout(Time value)
Period to wait for a response whenwait_for_completion
istrue
.StopTransformRequest.Builder
timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Period to wait for a response whenwait_for_completion
istrue
.StopTransformRequest.Builder
transformId(java.lang.String value)
Required - Identifier for the transform.StopTransformRequest.Builder
waitForCheckpoint(java.lang.Boolean value)
If it is true, the transform does not completely stop until the current checkpoint is completed.StopTransformRequest.Builder
waitForCompletion(java.lang.Boolean value)
If it is true, the API blocks until the indexer state completely stops.Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
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
-
timeout
public final StopTransformRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)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
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
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
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
Builds aStopTransformRequest
.- Specified by:
build
in interfaceObjectBuilder<StopTransformRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-