Firestore Admin v1 API - Class ExportDocumentsRequest (3.1.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.MemberwiseClone()

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
`RepeatedField<String>`

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`

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`