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
Methods
__construct
Constructor.
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}
.
string
setName
Required. Database to export. Should be of the form: projects/{project_id}/databases/{database_id}
.
var
string
$this
getCollectionIds
Which collection ids to export. Unspecified means all collections.
setCollectionIds
Which collection ids to export. Unspecified means all collections.
var
string[]
$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.
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.
var
string
$this
