Viewing file:  ProjectsDatabases.php (7.51 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Firestore\Resource;
use Google\Service\Firestore\GoogleFirestoreAdminV1Database;
use Google\Service\Firestore\GoogleFirestoreAdminV1ExportDocumentsRequest;
use Google\Service\Firestore\GoogleFirestoreAdminV1ImportDocumentsRequest;
use Google\Service\Firestore\GoogleFirestoreAdminV1ListDatabasesResponse;
use Google\Service\Firestore\GoogleLongrunningOperation;
/**
* The "databases" collection of methods.
* Typical usage is:
* <code>
* $firestoreService = new Google\Service\Firestore(...);
* $databases = $firestoreService->projects_databases;
* </code>
*/
class ProjectsDatabases extends \Google\Service\Resource
{
/**
* Create a database. (databases.create)
*
* @param string $parent Required. A parent name of the form
* `projects/{project_id}`
* @param GoogleFirestoreAdminV1Database $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string databaseId Required. The ID to use for the database, which
* will become the final component of the database's resource name. This value
* should be 4-63 characters. Valid characters are /a-z-/ with first character a
* letter and the last a letter or a number. Must not be UUID-like
* /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id is also
* valid.
* @return GoogleLongrunningOperation
*/
public function create($parent, GoogleFirestoreAdminV1Database $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], GoogleLongrunningOperation::class);
}
/**
* Deletes a database. (databases.delete)
*
* @param string $name Required. A name of the form
* `projects/{project_id}/databases/{database_id}`
* @param array $optParams Optional parameters.
*
* @opt_param bool allowMissing If set to true and the Database is not found,
* the request will succeed but no action will be taken.
* @opt_param string etag The current etag of the Database. If an etag is
* provided and does not match the current etag of the database, deletion will
* be blocked and a FAILED_PRECONDITION error will be returned.
* @opt_param bool freeId If set, will free the database_id associated with this
* database. uid will be used as the resource id to identify this deleted
* database.
* @opt_param bool validateOnly If set, validate the request and preview the
* response, but do not actually delete the database.
* @return GoogleLongrunningOperation
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], GoogleLongrunningOperation::class);
}
/**
* 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');
|