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

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class DeleteIndexRequest.

Request message for IndexService.DeleteIndex.

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

Methods

build

Parameter
NameDescription
name string

Required. The name of the Index resource to be deleted. Format: projects/{project}/locations/{location}/indexes/{index} Please see {@see \Google\Cloud\AIPlatform\V1\IndexServiceClient::indexName()} for help formatting this field.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\DeleteIndexRequest

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the Index resource to be deleted. Format: projects/{project}/locations/{location}/indexes/{index}

getName

Required. The name of the Index resource to be deleted.

Format: projects/{project}/locations/{location}/indexes/{index}

Returns
TypeDescription
string

setName

Required. The name of the Index resource to be deleted.

Format: projects/{project}/locations/{location}/indexes/{index}

Parameter
NameDescription
var string
Returns
TypeDescription
$this