* $firestoreService = new Google\Service\Firestore(...); * $indexes = $firestoreService->projects_databases_collectionGroups_indexes; * */ class ProjectsDatabasesCollectionGroupsIndexes extends \Google\Service\Resource { /** * 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) * * @param string $parent Required. A parent name of the form `projects/{project_ * id}/databases/{database_id}/collectionGroups/{collection_id}` * @param GoogleFirestoreAdminV1Index $postBody * @param array $optParams Optional parameters. * @return GoogleLongrunningOperation * @throws \Google\Service\Exception */ public function create($parent, GoogleFirestoreAdminV1Index $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], GoogleLongrunningOperation::class); } /** * Deletes a composite index. (indexes.delete) * * @param string $name Required. A name of the form `projects/{project_id}/datab * ases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` * @param array $optParams Optional parameters. * @return FirestoreEmpty * @throws \Google\Service\Exception */ public function delete($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('delete', [$params], FirestoreEmpty::class); } /** * Gets a composite index. (indexes.get) * * @param string $name Required. A name of the form `projects/{project_id}/datab * ases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` * @param array $optParams Optional parameters. * @return GoogleFirestoreAdminV1Index * @throws \Google\Service\Exception */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], GoogleFirestoreAdminV1Index::class); } /** * Lists composite indexes. * (indexes.listProjectsDatabasesCollectionGroupsIndexes) * * @param string $parent Required. A parent name of the form `projects/{project_ * id}/databases/{database_id}/collectionGroups/{collection_id}` * @param array $optParams Optional parameters. * * @opt_param string filter The filter to apply to list results. * @opt_param int pageSize The number of results to return. * @opt_param string pageToken A page token, returned from a previous call to * FirestoreAdmin.ListIndexes, that may be used to get the next page of results. * @return GoogleFirestoreAdminV1ListIndexesResponse * @throws \Google\Service\Exception */ public function listProjectsDatabasesCollectionGroupsIndexes($parent, $optParams = []) { $params = ['parent' => $parent]; $params = array_merge($params, $optParams); return $this->call('list', [$params], GoogleFirestoreAdminV1ListIndexesResponse::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(ProjectsDatabasesCollectionGroupsIndexes::class, 'Google_Service_Firestore_Resource_ProjectsDatabasesCollectionGroupsIndexes');