public sealed class ExportDocumentsRequest : IMessage<ExportDocumentsRequest>, IEquatable<ExportDocumentsRequest>, IDeepCloneable<ExportDocumentsRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Firestore Admin v1 API class ExportDocumentsRequest.
The request for
[FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].
public RepeatedField<string> NamespaceIds { get; }
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 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.
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][google.firestore.admin.v1.Database.earliest_version_time].
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThe latest version available for the \u003ccode\u003eExportDocumentsRequest\u003c/code\u003e class is 3.12.0, which is part of the Google Cloud Firestore Admin v1 API.\u003c/p\u003e\n"],["\u003cp\u003eThis class, \u003ccode\u003eExportDocumentsRequest\u003c/code\u003e, is used to initiate the export of documents from Firestore using the \u003ccode\u003eFirestoreAdmin.ExportDocuments\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eExportDocumentsRequest\u003c/code\u003e class implements several interfaces, including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, and inherits from the \u003ccode\u003eobject\u003c/code\u003e class.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of \u003ccode\u003eExportDocumentsRequest\u003c/code\u003e include \u003ccode\u003eCollectionIds\u003c/code\u003e, \u003ccode\u003eDatabaseName\u003c/code\u003e, \u003ccode\u003eName\u003c/code\u003e, \u003ccode\u003eNamespaceIds\u003c/code\u003e, \u003ccode\u003eOutputUriPrefix\u003c/code\u003e, and \u003ccode\u003eSnapshotTime\u003c/code\u003e, allowing specification of what and where to export.\u003c/p\u003e\n"],["\u003cp\u003eThe object accepts parameters such as \u003ccode\u003eother\u003c/code\u003e, and has 2 constructors, one with no arguments, and another one with \u003ccode\u003eExportDocumentsRequest other\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Firestore Admin v1 API - Class ExportDocumentsRequest (3.15.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.15.0 (latest)](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest)\n- [3.14.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.14.0/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest)\n- [3.13.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.13.0/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest)\n- [3.12.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.12.0/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest)\n- [3.11.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.11.0/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest)\n- [3.10.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.10.0/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest)\n- [3.9.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.9.0/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest)\n- [3.8.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.8.0/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest)\n- [3.7.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.7.0/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest)\n- [3.6.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.6.0/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest)\n- [3.5.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.5.0/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.4.0/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.3.0/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.2.0/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.1.0/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest)\n- [3.0.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.0.0/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/2.4.0/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/2.3.0/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest)\n- [2.2.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/2.2.0/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest) \n\n public sealed class ExportDocumentsRequest : IMessage\u003cExportDocumentsRequest\u003e, IEquatable\u003cExportDocumentsRequest\u003e, IDeepCloneable\u003cExportDocumentsRequest\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Firestore Admin v1 API class ExportDocumentsRequest.\n\nThe request for\n\\[FirestoreAdmin.ExportDocuments\\]\\[google.firestore.admin.v1.FirestoreAdmin.ExportDocuments\\]. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e ExportDocumentsRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[ExportDocumentsRequest](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[ExportDocumentsRequest](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[ExportDocumentsRequest](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.Firestore.Admin.V1](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.Firestore.Admin.V1.dll\n\nConstructors\n------------\n\n### ExportDocumentsRequest()\n\n public ExportDocumentsRequest()\n\n### ExportDocumentsRequest(ExportDocumentsRequest)\n\n public ExportDocumentsRequest(ExportDocumentsRequest other)\n\nProperties\n----------\n\n### CollectionIds\n\n public RepeatedField\u003cstring\u003e CollectionIds { get; }\n\nWhich collection IDs to export. Unspecified means all collections. Each\ncollection ID in this list must be unique.\n\n### DatabaseName\n\n public DatabaseName DatabaseName { get; set; }\n\n[DatabaseName](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.DatabaseName)-typed view over the [Name](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.ExportDocumentsRequest#Google_Cloud_Firestore_Admin_V1_ExportDocumentsRequest_Name) resource name property.\n\n### Name\n\n public string Name { get; set; }\n\nRequired. Database to export. Should be of the form:\n`projects/{project_id}/databases/{database_id}`.\n\n### NamespaceIds\n\n public RepeatedField\u003cstring\u003e NamespaceIds { get; }\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### OutputUriPrefix\n\n public string OutputUriPrefix { get; set; }\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.\nIf the URI is a bucket (without a namespace path), a prefix will be\ngenerated based on the start time.\n\n### SnapshotTime\n\n public Timestamp SnapshotTime { get; set; }\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\\]\\[google.firestore.admin.v1.Database.earliest_version_time\\].\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."]]
