Cloud Firestore V1 Client - Class ExportDocumentsRequest (1.34.0)

Version 1.34.0

• 1.47.2 (latest)
• 1.47.1
• 1.46.0
• 1.45.2
• 1.44.1
• 1.43.3
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.7
• 1.36.1
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.28.0
• 1.27.3

Reference documentation and code samples for the Cloud Firestore V1 Client class ExportDocumentsRequest.

The request for FirestoreAdmin.ExportDocuments.

Generated from protobuf message google.firestore.admin.v1.ExportDocumentsRequest

Namespace

Google \ Cloud \ Firestore \ Admin \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Required. Database to export. Should be of the form: projects/{project_id}/databases/{database_id}.
↳ collection_ids	array Which collection ids to export. Unspecified means all collections.
↳ output_uri_prefix	string The output URI. Currently only supports Google Cloud Storage URIs of the form: gs://BUCKET_NAME[/NAMESPACE_PATH], where BUCKET_NAME is the name of the Google Cloud Storage bucket and NAMESPACE_PATH is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time.

getName

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

Returns
Type	Description
string

setName

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCollectionIds

Which collection ids to export. Unspecified means all collections.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setCollectionIds

Which collection ids to export. Unspecified means all collections.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getOutputUriPrefix

The output URI. Currently only supports Google Cloud Storage URIs of the form: gs://BUCKET_NAME[/NAMESPACE_PATH], where BUCKET_NAME is the name of the Google Cloud Storage bucket and NAMESPACE_PATH is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming.

If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time.

Returns
Type	Description
string

setOutputUriPrefix

The output URI. Currently only supports Google Cloud Storage URIs of the form: gs://BUCKET_NAME[/NAMESPACE_PATH], where BUCKET_NAME is the name of the Google Cloud Storage bucket and NAMESPACE_PATH is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming.

If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameter
Name	Description
name	string Required. Database to export. Should be of the form: projects/{project_id}/databases/{database_id}. Please see Google\Cloud\Firestore\Admin\V1\FirestoreAdminClient::databaseName() for help formatting this field.

Returns
Type	Description
Google\Cloud\Firestore\Admin\V1\ExportDocumentsRequest