Cloud Firestore V1 Client - Class GetIndexRequest (1.33.0)

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

Methods

__construct

Constructor.

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

setName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this