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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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: |
↳ 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 | |
|---|---|
| Type | Description |
string | |
setEndpoint
Required. The name of the Endpoint resource from which to undeploy a Model.
Format:
projects/{project}/locations/{location}/endpoints/{endpoint}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDeployedModelId
Required. The ID of the DeployedModel to be undeployed from the Endpoint.
| Returns | |
|---|---|
| Type | Description |
string | |
setDeployedModelId
Required. The ID of the DeployedModel to be undeployed from the Endpoint.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameters | |
|---|---|
| Name | Description |
endpoint |
string
Required. The name of the Endpoint resource from which to undeploy a Model.
Format:
|
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 | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\UndeployModelRequest | |