Firestore v1 API - Class TargetChange (3.1.0) 

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

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

Targets being watched have changed.

Inheritance

object > TargetChange

Namespace

GoogleCloudGoogle.Cloud.FirestoreV1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

TargetChange()

public TargetChange()

TargetChange(TargetChange)

public TargetChange(TargetChange other)
Parameter
NameDescription
otherTargetChange

Properties

Cause

public Status Cause { get; set; }

The error that resulted in this change, if applicable.

Property Value
TypeDescription
Status

ReadTime

public Timestamp ReadTime { get; set; }

The consistent read_time for the given target_ids (omitted when the target_ids are not at a consistent snapshot).

The stream is guaranteed to send a read_time with target_ids empty whenever the entire stream reaches a new consistent snapshot. ADD, CURRENT, and RESET messages are guaranteed to (eventually) result in a new consistent snapshot (while NO_CHANGE and REMOVE messages are not).

For a given stream, read_time is guaranteed to be monotonically increasing.

Property Value
TypeDescription
Timestamp

ResumeToken

public ByteString ResumeToken { get; set; }

A token that can be used to resume the stream for the given target_ids, or all targets if target_ids is empty.

Not set on every target change.

Property Value
TypeDescription
ByteString

TargetChangeType

public TargetChange.Types.TargetChangeType TargetChangeType { get; set; }

The type of change that occurred.

Property Value
TypeDescription
TargetChangeTypesTargetChangeType

TargetIds

public RepeatedField<int> TargetIds { get; }

The target IDs of targets that have changed.

If empty, the change applies to all targets.

The order of the target IDs is not defined.

Property Value
TypeDescription
RepeatedFieldint