Firestore Admin v1 API - Class ExportDocumentsRequest (3.4.0)

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].

Inheritance

object > ExportDocumentsRequest

Implements

IMessage ExportDocumentsRequest, IEquatable ExportDocumentsRequest, IDeepCloneable ExportDocumentsRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

ExportDocumentsRequest()

public ExportDocumentsRequest()

ExportDocumentsRequest(ExportDocumentsRequest)

public ExportDocumentsRequest(ExportDocumentsRequest other)

Parameter
Name	Description
`other`	`ExportDocumentsRequest`

Properties

CollectionIds

public RepeatedField<string> CollectionIds { get; }

Which collection ids to export. Unspecified means all collections.

Property Value
Type	Description
`RepeatedFieldstring`

DatabaseName

public DatabaseName DatabaseName { get; set; }

DatabaseName-typed view over the Name resource name property.

Property Value
Type	Description
`DatabaseName`

Name

public string Name { get; set; }

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

Property Value
Type	Description
`string`

NamespaceIds

public RepeatedField<string> NamespaceIds { get; }

Unspecified means 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.

Property Value
Type	Description
`RepeatedFieldstring`

OutputUriPrefix

public string OutputUriPrefix { get; set; }

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.

Property Value
Type	Description
`string`

SnapshotTime

public Timestamp SnapshotTime { get; set; }

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.

Property Value
Type	Description
`Timestamp`