Google Cloud Ai Platform V1 Client - Class UndeployModelRequest (0.25.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class UndeployModelRequest.

Request message for EndpointService.UndeployModel.

Generated from protobuf message google.cloud.aiplatform.v1.UndeployModelRequest

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ endpoint string

Required. The name of the Endpoint resource from which to undeploy a Model. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

↳ deployed_model_id string

Required. The ID of the DeployedModel to be undeployed from the Endpoint.

↳ traffic_split array|Google\Protobuf\Internal\MapField

If this field is provided, then the Endpoint's traffic_split will be overwritten with it. If last DeployedModel is being undeployed from the Endpoint, the [Endpoint.traffic_split] will always end up empty when this call returns. A DeployedModel will be successfully undeployed only if it doesn't have any traffic assigned to it when this method executes, or if this field unassigns any traffic to it.

getEndpoint

Required. The name of the Endpoint resource from which to undeploy a Model.

Format: projects/{project}/locations/{location}/endpoints/{endpoint}

Returns
TypeDescription
string

setEndpoint

Required. The name of the Endpoint resource from which to undeploy a Model.

Format: projects/{project}/locations/{location}/endpoints/{endpoint}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDeployedModelId

Required. The ID of the DeployedModel to be undeployed from the Endpoint.

Returns
TypeDescription
string

setDeployedModelId

Required. The ID of the DeployedModel to be undeployed from the Endpoint.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTrafficSplit

If this field is provided, then the Endpoint's traffic_split will be overwritten with it. If last DeployedModel is being undeployed from the Endpoint, the [Endpoint.traffic_split] will always end up empty when this call returns. A DeployedModel will be successfully undeployed only if it doesn't have any traffic assigned to it when this method executes, or if this field unassigns any traffic to it.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setTrafficSplit

If this field is provided, then the Endpoint's traffic_split will be overwritten with it. If last DeployedModel is being undeployed from the Endpoint, the [Endpoint.traffic_split] will always end up empty when this call returns. A DeployedModel will be successfully undeployed only if it doesn't have any traffic assigned to it when this method executes, or if this field unassigns any traffic to it.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
endpoint string

Required. The name of the Endpoint resource from which to undeploy a Model. Format: projects/{project}/locations/{location}/endpoints/{endpoint} Please see Google\Cloud\AIPlatform\V1\EndpointServiceClient::endpointName() for help formatting this field.

deployedModelId string

Required. The ID of the DeployedModel to be undeployed from the Endpoint.

trafficSplit array

If this field is provided, then the Endpoint's traffic_split will be overwritten with it. If last DeployedModel is being undeployed from the Endpoint, the [Endpoint.traffic_split] will always end up empty when this call returns. A DeployedModel will be successfully undeployed only if it doesn't have any traffic assigned to it when this method executes, or if this field unassigns any traffic to it.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\UndeployModelRequest