- 1.43.0 (latest)
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description | 
| data | arrayOptional. Data for populating the Message object. | 
| ↳ endpoint | stringRequired. The name of the Endpoint resource from which to undeploy a Model. Format:  | 
| ↳ deployed_model_id | stringRequired. The ID of the DeployedModel to be undeployed from the Endpoint. | 
| ↳ traffic_split | array|Google\Protobuf\Internal\MapFieldIf 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 | stringRequired. The name of the Endpoint resource from which to undeploy a Model.
Format:
 | 
| deployedModelId | stringRequired. The ID of the DeployedModel to be undeployed from the Endpoint. | 
| trafficSplit | arrayIf 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 | 
| UndeployModelRequest | |