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
Methods
__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}
Generated from protobuf field string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| 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}
Generated from protobuf field string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDeployedModelId
Required. The ID of the DeployedModel to be undeployed from the Endpoint.
Generated from protobuf field string deployed_model_id = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setDeployedModelId
Required. The ID of the DeployedModel to be undeployed from the Endpoint.
Generated from protobuf field string deployed_model_id = 2 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field map<string, int32> traffic_split = 3;
| 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.
Generated from protobuf field map<string, int32> traffic_split = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |