Package co.elastic.clients.elasticsearch.ml

Class StopTrainedModelDeploymentRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<StopTrainedModelDeploymentRequest.Builder>

co.elastic.clients.elasticsearch.ml.StopTrainedModelDeploymentRequest.Builder

All Implemented Interfaces:

WithJson<StopTrainedModelDeploymentRequest.Builder>, ObjectBuilder<StopTrainedModelDeploymentRequest>

Enclosing class:

StopTrainedModelDeploymentRequest

public static class StopTrainedModelDeploymentRequest.Builder
extends RequestBase.AbstractBuilder<StopTrainedModelDeploymentRequest.Builder>
implements ObjectBuilder<StopTrainedModelDeploymentRequest>

Builder for StopTrainedModelDeploymentRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StopTrainedModelDeploymentRequest.Builder	allowNoMatch(java.lang.Boolean value)	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.
StopTrainedModelDeploymentRequest	build()	Builds a StopTrainedModelDeploymentRequest.
StopTrainedModelDeploymentRequest.Builder	force(java.lang.Boolean value)	Forcefully stops the deployment, even if it is used by ingest pipelines.
StopTrainedModelDeploymentRequest.Builder	modelId(java.lang.String value)	Required - The unique identifier of the trained model.
protected StopTrainedModelDeploymentRequest.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

allowNoMatch

public final StopTrainedModelDeploymentRequest.Builder allowNoMatch(@Nullable
java.lang.Boolean value)

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. If false, the request returns a 404 status code when there are no matches or only partial matches.

API name: allow_no_match

force

public final StopTrainedModelDeploymentRequest.Builder force(@Nullable
java.lang.Boolean value)

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 StopTrainedModelDeploymentRequest.Builder modelId(java.lang.String value)

Required - The unique identifier of the trained model.

API name: model_id

self

protected StopTrainedModelDeploymentRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<StopTrainedModelDeploymentRequest.Builder>

build

public StopTrainedModelDeploymentRequest build()

Builds a StopTrainedModelDeploymentRequest.

Specified by:

build in interface ObjectBuilder<StopTrainedModelDeploymentRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.