Google Cloud Ai Platform V1 Client - Class UndeployIndexRequest (0.16.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
NameDescription
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
TypeDescription
Google\Cloud\AIPlatform\V1\UndeployIndexRequest

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
string

setIndexEndpoint

Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDeployedIndexId

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

Returns
TypeDescription
string

setDeployedIndexId

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this