Firestore Admin v1 API - Class ExportDocumentsMetadata (3.5.0)

public sealed class ExportDocumentsMetadata : IMessage<ExportDocumentsMetadata>, IEquatable<ExportDocumentsMetadata>, IDeepCloneable<ExportDocumentsMetadata>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore Admin v1 API class ExportDocumentsMetadata.

Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].

Inheritance

object > ExportDocumentsMetadata

Implements

IMessage ExportDocumentsMetadata, IEquatable ExportDocumentsMetadata, IDeepCloneable ExportDocumentsMetadata, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

ExportDocumentsMetadata()

public ExportDocumentsMetadata()

ExportDocumentsMetadata(ExportDocumentsMetadata)

public ExportDocumentsMetadata(ExportDocumentsMetadata other)

Parameter
Name	Description
`other`	`ExportDocumentsMetadata`

Properties

CollectionIds

public RepeatedField<string> CollectionIds { get; }

Which collection ids are being exported.

Property Value
Type	Description
`RepeatedFieldstring`

EndTime

public Timestamp EndTime { get; set; }

The time this operation completed. Will be unset if operation still in progress.

Property Value
Type	Description
`Timestamp`

NamespaceIds

public RepeatedField<string> NamespaceIds { get; }

Which namespace ids are being exported.

Property Value
Type	Description
`RepeatedFieldstring`

OperationState

public OperationState OperationState { get; set; }

The state of the export operation.

Property Value
Type	Description
`OperationState`

OutputUriPrefix

public string OutputUriPrefix { get; set; }

Where the documents are being exported to.

Property Value
Type	Description
`string`

ProgressBytes

public Progress ProgressBytes { get; set; }

The progress, in bytes, of this operation.

Property Value
Type	Description
`Progress`

ProgressDocuments

public Progress ProgressDocuments { get; set; }

The progress, in documents, of this operation.

Property Value
Type	Description
`Progress`

SnapshotTime

public Timestamp SnapshotTime { get; set; }

The timestamp that corresponds to the version of the database that is being exported. If unspecified, there are no guarantees about the consistency of the documents being exported.

Property Value
Type	Description
`Timestamp`

StartTime

public Timestamp StartTime { get; set; }

The time this operation started.

Property Value
Type	Description
`Timestamp`