Show / Hide Table of Contents

Class DocumentRemove

A 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 messages may be returned for the same logical write or delete, if multiple targets are affected.

Inheritance
object
DocumentRemove
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Firestore.v1.Data
Assembly: Google.Apis.Firestore.v1.dll
Syntax
public class DocumentRemove : IDirectResponseSchema

Properties

Document

The resource name of the Document that has gone out of view.

Declaration
[JsonProperty("document")]
public virtual string Document { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

ReadTime

object representation of ReadTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ReadTimeDateTimeOffset instead.")]
public virtual object ReadTime { get; set; }
Property Value
Type Description
object

ReadTimeDateTimeOffset

DateTimeOffset representation of ReadTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? ReadTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

ReadTimeRaw

The read timestamp at which the remove was observed. Greater or equal to the commit_time of the change/delete/remove.

Declaration
[JsonProperty("readTime")]
public virtual string ReadTimeRaw { get; set; }
Property Value
Type Description
string

RemovedTargetIds

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

Declaration
[JsonProperty("removedTargetIds")]
public virtual IList<int?> RemovedTargetIds { get; set; }
Property Value
Type Description
IList<int?>

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX