Class StopTrainedModelDeploymentRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.StopTrainedModelDeploymentRequest
public class StopTrainedModelDeploymentRequest extends RequestBase
Stops a trained model deployment.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
StopTrainedModelDeploymentRequest.Builder
Builder forStopTrainedModelDeploymentRequest
.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<StopTrainedModelDeploymentRequest,StopTrainedModelDeploymentResponse,ErrorResponse>
_ENDPOINT
Endpoint "ml.stop_trained_model_deployment
". -
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 deployments that match; contains the_all
string or no identifiers and there are no matches; or contains wildcard expressions and there are only partial matches.java.lang.Boolean
force()
Forcefully stops the deployment, even if it is used by ingest pipelines.java.lang.String
modelId()
Required - The unique identifier of the trained model.static StopTrainedModelDeploymentRequest
of(java.util.function.Function<StopTrainedModelDeploymentRequest.Builder,ObjectBuilder<StopTrainedModelDeploymentRequest>> fn)
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
public static final Endpoint<StopTrainedModelDeploymentRequest,StopTrainedModelDeploymentResponse,ErrorResponse> _ENDPOINTEndpoint "ml.stop_trained_model_deployment
".
-
-
Method Details
-
of
public static StopTrainedModelDeploymentRequest of(java.util.function.Function<StopTrainedModelDeploymentRequest.Builder,ObjectBuilder<StopTrainedModelDeploymentRequest>> fn) -
allowNoMatch
@Nullable public final java.lang.Boolean allowNoMatch()Specifies what to do when the request: contains wildcard expressions and there are no deployments that match; contains the_all
string or no identifiers and there are no matches; or contains wildcard expressions and there are only partial matches. By default, it returns an empty array when there are no matches and the subset of results when there are partial matches. Iffalse
, 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()Forcefully stops the deployment, even if it is used by ingest pipelines. You can't use these pipelines until you restart the model deployment.API name:
force
-
modelId
public final java.lang.String modelId()Required - The unique identifier of the trained model.API name:
model_id
-