1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Firestore
  7. \
  8. Resource
  9. \
  10. ProjectsDatabasesCollectionGroupsIndexes

ProjectsDatabasesCollectionGroupsIndexes

class ProjectsDatabasesCollectionGroupsIndexes extends Resource (View source)

The "indexes" collection of methods.

Typical usage is:

 $firestoreService = new Google\Service\Firestore(...);
 $indexes = $firestoreService->projects_databases_collectionGroups_indexes;

Methods

GoogleLongrunningOperation
create(string $parent, GoogleFirestoreAdminV1Index $postBody, array $optParams = [])

Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata. (indexes.create)

FirestoreEmpty
delete(string $name, array $optParams = [])

Deletes a composite index. (indexes.delete)

GoogleFirestoreAdminV1Index
get(string $name, array $optParams = [])

Gets a composite index. (indexes.get)

GoogleFirestoreAdminV1ListIndexesResponse
listProjectsDatabasesCollectionGroupsIndexes(string $parent, array $optParams = [])

Lists composite indexes.

Details

at line 47
GoogleLongrunningOperation create(string $parent, GoogleFirestoreAdminV1Index $postBody, array $optParams = [])

Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata. (indexes.create)

Parameters

string $parent

Required. A parent name of the form projects/{project_ id}/databases/{database_id}/collectionGroups/{collection_id}
GoogleFirestoreAdminV1Index $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 62
FirestoreEmpty delete(string $name, array $optParams = [])

Deletes a composite index. (indexes.delete)

Parameters

string $name

Required. A name of the form projects/{project_id}/datab ases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}
array $optParams

Optional parameters.

Return Value

FirestoreEmpty

Exceptions

Exception

at line 77
GoogleFirestoreAdminV1Index get(string $name, array $optParams = [])

Gets a composite index. (indexes.get)

Parameters

string $name

Required. A name of the form projects/{project_id}/datab ases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}
array $optParams

Optional parameters.

Return Value

GoogleFirestoreAdminV1Index

Exceptions

Exception

at line 98
GoogleFirestoreAdminV1ListIndexesResponse listProjectsDatabasesCollectionGroupsIndexes(string $parent, array $optParams = [])

Lists composite indexes.

(indexes.listProjectsDatabasesCollectionGroupsIndexes)

Parameters

string $parent

Required. A parent name of the form projects/{project_ id}/databases/{database_id}/collectionGroups/{collection_id}
array $optParams

Optional parameters.

Return Value

GoogleFirestoreAdminV1ListIndexesResponse

Exceptions

Exception