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

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

Request message for IndexService.GetIndex

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

Methods

build

Parameter
Name Description
name string

Required. The name of the Index resource. Format: projects/{project}/locations/{___location}/indexes/{index} Please see {@see \Google\Cloud\AIPlatform\V1\IndexServiceClient::indexName()} for help formatting this field.
Returns
Type Description
Google\Cloud\AIPlatform\V1\GetIndexRequest

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. The name of the Index resource. Format: projects/{project}/locations/{___location}/indexes/{index}

getName

Required. The name of the Index resource.

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

Returns
Type Description
string

setName

Required. The name of the Index resource.

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

Parameter
Name Description
var string
Returns
Type Description
$this