Google Cloud Ai Platform V1 Client - Class UndeployIndexRequest (1.54.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

Namespace

Google \ Cloud \ AIPlatform \ V1

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: 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

static::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 IndexEndpointServiceClient::indexEndpointName() for help formatting this field.
deployedIndexId string

Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.
Returns
Type Description
UndeployIndexRequest