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. Each collection ID in this list must be unique.
↳ 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.
↳ namespace_ids
array
An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.
The timestamp that corresponds to the version of the database to be exported. The timestamp must be in the past, rounded to the minute and not older than earliestVersionTime. If specified, then the exported documents will represent a consistent view of the database at the provided time. Otherwise, there are no guarantees about the consistency of the exported documents.
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. Each
collection ID in this list must be unique.
Which collection IDs to export. Unspecified means all collections. Each
collection ID in this list must be unique.
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
getNamespaceIds
An empty list represents all namespaces. This is the preferred
usage for databases that don't use namespaces.
An empty string element represents the default namespace. This should be
used if the database has data in non-default namespaces, but doesn't want
to include them. Each namespace in this list must be unique.
An empty list represents all namespaces. This is the preferred
usage for databases that don't use namespaces.
An empty string element represents the default namespace. This should be
used if the database has data in non-default namespaces, but doesn't want
to include them. Each namespace in this list must be unique.
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
getSnapshotTime
The timestamp that corresponds to the version of the database to be
exported. The timestamp must be in the past, rounded to the minute and not
older than
earliestVersionTime.
If specified, then the exported documents will represent a consistent view
of the database at the provided time. Otherwise, there are no guarantees
about the consistency of the exported documents.
The timestamp that corresponds to the version of the database to be
exported. The timestamp must be in the past, rounded to the minute and not
older than
earliestVersionTime.
If specified, then the exported documents will represent a consistent view
of the database at the provided time. Otherwise, there are no guarantees
about the consistency of the exported documents.
Required. Database to export. Should be of the form:
projects/{project_id}/databases/{database_id}. Please see
FirestoreAdminClient::databaseName() for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Firestore V1 Client - Class ExportDocumentsRequest (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/Admin.V1.ExportDocumentsRequest)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/Admin.V1.ExportDocumentsRequest)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/Admin.V1.ExportDocumentsRequest)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/Admin.V1.ExportDocumentsRequest)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/Admin.V1.ExportDocumentsRequest)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/Admin.V1.ExportDocumentsRequest)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/Admin.V1.ExportDocumentsRequest)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/Admin.V1.ExportDocumentsRequest)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/Admin.V1.ExportDocumentsRequest)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/Admin.V1.ExportDocumentsRequest)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/Admin.V1.ExportDocumentsRequest)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/Admin.V1.ExportDocumentsRequest)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/Admin.V1.ExportDocumentsRequest)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/Admin.V1.ExportDocumentsRequest)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/Admin.V1.ExportDocumentsRequest)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/Admin.V1.ExportDocumentsRequest)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/Admin.V1.ExportDocumentsRequest)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/Admin.V1.ExportDocumentsRequest)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/Admin.V1.ExportDocumentsRequest)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/Admin.V1.ExportDocumentsRequest)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/Admin.V1.ExportDocumentsRequest)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/Admin.V1.ExportDocumentsRequest)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/Admin.V1.ExportDocumentsRequest) \nReference documentation and code samples for the Cloud Firestore V1 Client class ExportDocumentsRequest.\n\nThe request for\n[FirestoreAdmin.ExportDocuments](/php/docs/reference/cloud-firestore/latest/Admin.V1.FirestoreAdminClient#_Google_Cloud_Firestore_Admin_V1_FirestoreAdminClient__exportDocuments__).\n\nGenerated from protobuf message `google.firestore.admin.v1.ExportDocumentsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ Admin \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. Database to export. Should be of the form:\n`projects/{project_id}/databases/{database_id}`.\n\n### setName\n\nRequired. Database to export. Should be of the form:\n`projects/{project_id}/databases/{database_id}`.\n\n### getCollectionIds\n\nWhich collection IDs to export. Unspecified means all collections. Each\ncollection ID in this list must be unique.\n\n### setCollectionIds\n\nWhich collection IDs to export. Unspecified means all collections. Each\ncollection ID in this list must be unique.\n\n### getOutputUriPrefix\n\nThe output URI. Currently only supports Google Cloud Storage URIs of the\nform: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name\nof the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional\nGoogle Cloud Storage namespace path. When\nchoosing a name, be sure to consider Google Cloud Storage naming\nguidelines: \u003chttps://cloud.google.com/storage/docs/naming\u003e.\n\nIf the URI is a bucket (without a namespace path), a prefix will be\ngenerated based on the start time.\n\n### setOutputUriPrefix\n\nThe output URI. Currently only supports Google Cloud Storage URIs of the\nform: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name\nof the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional\nGoogle Cloud Storage namespace path. When\nchoosing a name, be sure to consider Google Cloud Storage naming\nguidelines: \u003chttps://cloud.google.com/storage/docs/naming\u003e.\n\nIf the URI is a bucket (without a namespace path), a prefix will be\ngenerated based on the start time.\n\n### getNamespaceIds\n\nAn empty list represents all namespaces. This is the preferred\nusage for databases that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the database has data in non-default namespaces, but doesn't want\nto include them. Each namespace in this list must be unique.\n\n### setNamespaceIds\n\nAn empty list represents all namespaces. This is the preferred\nusage for databases that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the database has data in non-default namespaces, but doesn't want\nto include them. Each namespace in this list must be unique.\n\n### getSnapshotTime\n\nThe timestamp that corresponds to the version of the database to be\nexported. The timestamp must be in the past, rounded to the minute and not\nolder than\n[earliestVersionTime](/php/docs/reference/cloud-firestore/latest/Admin.V1.Database#_Google_Cloud_Firestore_Admin_V1_Database__getEarliestVersionTime__).\n\nIf specified, then the exported documents will represent a consistent view\nof the database at the provided time. Otherwise, there are no guarantees\nabout the consistency of the exported documents.\n\n### hasSnapshotTime\n\n### clearSnapshotTime\n\n### setSnapshotTime\n\nThe timestamp that corresponds to the version of the database to be\nexported. The timestamp must be in the past, rounded to the minute and not\nolder than\n[earliestVersionTime](/php/docs/reference/cloud-firestore/latest/Admin.V1.Database#_Google_Cloud_Firestore_Admin_V1_Database__getEarliestVersionTime__).\n\nIf specified, then the exported documents will represent a consistent view\nof the database at the provided time. Otherwise, there are no guarantees\nabout the consistency of the exported documents.\n\n### static::build"]]
