Cloud Firestore V1 Client - Class GetIndexRequest (1.34.0)

Version 1.34.0

• 1.47.1 (latest)
• 1.47.0
• 1.46.0
• 1.45.2
• 1.44.1
• 1.43.3
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.7
• 1.36.1
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.28.0
• 1.27.3

Reference documentation and code samples for the Cloud Firestore V1 Client class GetIndexRequest.

The request for FirestoreAdmin.GetIndex.

Generated from protobuf message google.firestore.admin.v1.GetIndexRequest

Namespace

Google \ Cloud \ Firestore \ Admin \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Required. A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

getName

Required. A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

Returns
Type	Description
string

setName

Required. A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameter
Name	Description
name	string Required. A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id} Please see Google\Cloud\Firestore\Admin\V1\FirestoreAdminClient::indexName() for help formatting this field.

Returns
Type	Description
Google\Cloud\Firestore\Admin\V1\GetIndexRequest