* $firestoreService = new Google\Service\Firestore(...); * $databases = $firestoreService->databases; * */ class ProjectsDatabases extends \Google\Service\Resource { /** * Exports a copy of all or a subset of documents from Google Cloud Firestore to * another storage system, such as Google Cloud Storage. Recent updates to * documents may not be reflected in the export. The export occurs in the * background and its progress can be monitored and managed via the Operation * resource that is created. The output of an export may only be used once the * associated operation is done. If an export operation is cancelled before * completion it may leave partial data behind in Google Cloud Storage. For more * details on export behavior and output format, refer to: * https://cloud.google.com/firestore/docs/manage-data/export-import * (databases.exportDocuments) * * @param string $name Required. Database to export. Should be of the form: * `projects/{project_id}/databases/{database_id}`. * @param GoogleFirestoreAdminV1ExportDocumentsRequest $postBody * @param array $optParams Optional parameters. * @return GoogleLongrunningOperation */ public function exportDocuments($name, GoogleFirestoreAdminV1ExportDocumentsRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('exportDocuments', [$params], GoogleLongrunningOperation::class); } /** * Gets information about a database. (databases.get) * * @param string $name Required. A name of the form * `projects/{project_id}/databases/{database_id}` * @param array $optParams Optional parameters. * @return GoogleFirestoreAdminV1Database */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], GoogleFirestoreAdminV1Database::class); } /** * Imports documents into Google Cloud Firestore. Existing documents with the * same name are overwritten. The import occurs in the background and its * progress can be monitored and managed via the Operation resource that is * created. If an ImportDocuments operation is cancelled, it is possible that a * subset of the data has already been imported to Cloud Firestore. * (databases.importDocuments) * * @param string $name Required. Database to import into. Should be of the form: * `projects/{project_id}/databases/{database_id}`. * @param GoogleFirestoreAdminV1ImportDocumentsRequest $postBody * @param array $optParams Optional parameters. * @return GoogleLongrunningOperation */ public function importDocuments($name, GoogleFirestoreAdminV1ImportDocumentsRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('importDocuments', [$params], GoogleLongrunningOperation::class); } /** * List all the databases in the project. (databases.listProjectsDatabases) * * @param string $parent Required. A parent name of the form * `projects/{project_id}` * @param array $optParams Optional parameters. * @return GoogleFirestoreAdminV1ListDatabasesResponse */ public function listProjectsDatabases($parent, $optParams = []) { $params = ['parent' => $parent]; $params = array_merge($params, $optParams); return $this->call('list', [$params], GoogleFirestoreAdminV1ListDatabasesResponse::class); } /** * Updates a database. (databases.patch) * * @param string $name The resource name of the Database. Format: * `projects/{project}/databases/{database}` * @param GoogleFirestoreAdminV1Database $postBody * @param array $optParams Optional parameters. * * @opt_param string updateMask The list of fields to be updated. * @return GoogleLongrunningOperation */ public function patch($name, GoogleFirestoreAdminV1Database $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('patch', [$params], GoogleLongrunningOperation::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(ProjectsDatabases::class, 'Google_Service_Firestore_Resource_ProjectsDatabases');