Firestore v1 API - Class DocumentRemove (3.2.0)

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

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

A [Document][google.firestore.v1.Document] has been removed from the view of the targets.

Sent if the document is no longer relevant to a target and is out of view. Can be sent instead of a DocumentDelete or a DocumentChange if the server can not send the new value of the document.

Multiple [DocumentRemove][google.firestore.v1.DocumentRemove] messages may be returned for the same logical write or delete, if multiple targets are affected.

Inheritance

object > DocumentRemove

Implements

IMessage DocumentRemove, IEquatable DocumentRemove, IDeepCloneable DocumentRemove, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google CloudGoogle.Cloud.FirestoreV1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

DocumentRemove()

public DocumentRemove()

DocumentRemove(DocumentRemove)

public DocumentRemove(DocumentRemove other)

Parameter
Name	Description
`other`	`DocumentRemove`

Properties

Document

public string Document { get; set; }

The resource name of the [Document][google.firestore.v1.Document] that has gone out of view.

Property Value
Type	Description
`string`

ReadTime

public Timestamp ReadTime { get; set; }

The read timestamp at which the remove was observed.

Greater or equal to the commit_time of the change/delete/remove.

Property Value
Type	Description
`Timestamp`

RemovedTargetIds

public RepeatedField<int> RemovedTargetIds { get; }

A set of target IDs for targets that previously matched this document.

Property Value
Type	Description
`RepeatedFieldint`