Google Cloud Ai Platform V1 Client - Class UndeployIndexRequest (0.17.0)

Version 0.17.0

• 1.12.0 (latest)
• 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 UndeployIndexRequest.

Request message for IndexEndpointService.UndeployIndex.

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

Methods

build

Parameters
Name	Description
indexEndpoint	string Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint} Please see {@see \Google\Cloud\AIPlatform\V1\IndexEndpointServiceClient::indexEndpointName()} for help formatting this field.
deployedIndexId	string Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.

Returns
Type	Description
Google\Cloud\AIPlatform\V1\UndeployIndexRequest

__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: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
↳ 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}

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}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDeployedIndexId

Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.

Returns
Type	Description
string

setDeployedIndexId

Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.

Parameter
Name	Description
var	string

Returns
Type	Description
$this