firestore  v1
Properties | List of all members
Google.Apis.Firestore.v1.Data.TargetChange Class Reference

Targets being watched have changed. More...

Inheritance diagram for Google.Apis.Firestore.v1.Data.TargetChange:
Google::Apis::Requests::IDirectResponseSchema

Properties

virtual Status Cause [get, set]
 The error that resulted in this change, if applicable. More...
 
virtual object ReadTime [get, set]
 The consistent read_time for the given target_ids (omitted when the target_ids are not at a consistent snapshot). More...
 
virtual string 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. More...
 
virtual string TargetChangeType [get, set]
 The type of change that occurred. More...
 
virtual System.Collections.Generic.IList< System.Nullable< int > > TargetIds [get, set]
 The target IDs of targets that have changed. More...
 
virtual string ETag [get, set]
 The ETag of the item. More...
 
- Properties inherited from Google::Apis::Requests::IDirectResponseSchema
string ETag
 

Detailed Description

Targets being watched have changed.

Property Documentation

◆ Cause

virtual Status Google.Apis.Firestore.v1.Data.TargetChange.Cause
getset

The error that resulted in this change, if applicable.

◆ ETag

virtual string Google.Apis.Firestore.v1.Data.TargetChange.ETag
getset

The ETag of the item.

◆ ReadTime

virtual object Google.Apis.Firestore.v1.Data.TargetChange.ReadTime
getset

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.

◆ ResumeToken

virtual string Google.Apis.Firestore.v1.Data.TargetChange.ResumeToken
getset

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.

◆ TargetChangeType

virtual string Google.Apis.Firestore.v1.Data.TargetChange.TargetChangeType
getset

The type of change that occurred.

◆ TargetIds

virtual System.Collections.Generic.IList<System.Nullable<int> > Google.Apis.Firestore.v1.Data.TargetChange.TargetIds
getset

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.


The documentation for this class was generated from the following file: