Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class UndeployIndexRequest.
Request message for IndexEndpointService.UndeployIndex.
Generated from protobuf message google.cloud.aiplatform.v1.UndeployIndexRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ index_endpoint |
string
Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: |
↳ deployed_index_id |
string
Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint. |
getIndexEndpoint
Required. The name of the IndexEndpoint resource from which to undeploy an Index.
Format:
projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
Generated from protobuf field string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setIndexEndpoint
Required. The name of the IndexEndpoint resource from which to undeploy an Index.
Format:
projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
Generated from protobuf field string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDeployedIndexId
Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.
Generated from protobuf field string deployed_index_id = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setDeployedIndexId
Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.
Generated from protobuf field string deployed_index_id = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |