Cloud Firestore V1 Client - Class CreateIndexRequest (1.43.3)

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

The request for FirestoreAdmin.CreateIndex.

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

Namespace

Google \ Cloud \ Firestore \ Admin \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
↳ index Google\Cloud\Firestore\Admin\V1\Index

Required. The composite index to create.

getParent

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

Returns
Type Description
string

setParent

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

Parameter
Name Description
var string
Returns
Type Description
$this

getIndex

Required. The composite index to create.

Returns
Type Description
Google\Cloud\Firestore\Admin\V1\Index|null

hasIndex

clearIndex

setIndex

Required. The composite index to create.

Parameter
Name Description
var Google\Cloud\Firestore\Admin\V1\Index
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id} Please see Google\Cloud\Firestore\Admin\V1\FirestoreAdminClient::collectionGroupName() for help formatting this field.
index Google\Cloud\Firestore\Admin\V1\Index

Required. The composite index to create.
Returns
Type Description
Google\Cloud\Firestore\Admin\V1\CreateIndexRequest