Firestore Admin v1 API - Class BulkDeleteDocumentsMetadata (3.11.0)

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

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

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

Inheritance

object > BulkDeleteDocumentsMetadata

Implements

IMessage BulkDeleteDocumentsMetadata, IEquatable BulkDeleteDocumentsMetadata, IDeepCloneable BulkDeleteDocumentsMetadata, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

BulkDeleteDocumentsMetadata()

public BulkDeleteDocumentsMetadata()

BulkDeleteDocumentsMetadata(BulkDeleteDocumentsMetadata)

public BulkDeleteDocumentsMetadata(BulkDeleteDocumentsMetadata other)

Parameter
Name	Description
`other`	`BulkDeleteDocumentsMetadata`

Properties

CollectionIds

public RepeatedField<string> CollectionIds { get; }

The IDs of the collection groups that are being deleted.

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

Property Value
Type	Description
`RepeatedFieldstring`

OperationState

public OperationState OperationState { get; set; }

The state of the operation.

Property Value
Type	Description
`OperationState`

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 read to get the list of documents to delete. This time can also be used as the timestamp of PITR in case of disaster recovery (subject to PITR window limit).

Property Value
Type	Description
`Timestamp`

StartTime

public Timestamp StartTime { get; set; }

The time this operation started.

Property Value
Type	Description
`Timestamp`