Documentation

Google_Service_Firestore_Resource_ProjectsDatabases extends Google_Service_Resource
in package

The "databases" collection of methods.

Typical usage is: $firestoreService = new Google_Service_Firestore(...); $databases = $firestoreService->databases;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
exportDocuments()  : Google_Service_Firestore_GoogleLongrunningOperation
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.
importDocuments()  : Google_Service_Firestore_GoogleLongrunningOperation
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.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

exportDocuments()

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.

public exportDocuments(string $name, Google_Service_Firestore_GoogleFirestoreAdminV1ExportDocumentsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Firestore_GoogleLongrunningOperation

(databases.exportDocuments)

Parameters
$name : string

Required. Database to export. Should be of the form: projects/{project_id}/databases/{database_id}.

$postBody : Google_Service_Firestore_GoogleFirestoreAdminV1ExportDocumentsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Firestore_GoogleLongrunningOperation —

importDocuments()

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.

public importDocuments(string $name, Google_Service_Firestore_GoogleFirestoreAdminV1ImportDocumentsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Firestore_GoogleLongrunningOperation

(databases.importDocuments)

Parameters
$name : string

Required. Database to import into. Should be of the form: projects/{project_id}/databases/{database_id}.

$postBody : Google_Service_Firestore_GoogleFirestoreAdminV1ImportDocumentsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Firestore_GoogleLongrunningOperation —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results