Firestore v1 API - Class Target (3.1.0) 

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

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

A specification of a set of documents to listen to.

Inheritance

object > Target

Namespace

GoogleCloudGoogle.Cloud.FirestoreV1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

Target()

public Target()

Target(Target)

public Target(Target other)
Parameter
NameDescription
otherTarget

Properties

Documents

public Target.Types.DocumentsTarget Documents { get; set; }

A target specified by a set of document names.

Property Value
TypeDescription
TargetTypesDocumentsTarget

Once

public bool Once { get; set; }

If the target should be removed once it is current and consistent.

Property Value
TypeDescription
bool

Query

public Target.Types.QueryTarget Query { get; set; }

A target specified by a query.

Property Value
TypeDescription
TargetTypesQueryTarget

ReadTime

public Timestamp ReadTime { get; set; }

Start listening after a specific read_time.

The client must know the state of matching documents at this time.

Property Value
TypeDescription
Timestamp

ResumeToken

public ByteString ResumeToken { get; set; }

A resume token from a prior [TargetChange][google.firestore.v1.TargetChange] for an identical target.

Using a resume token with a different target is unsupported and may fail.

Property Value
TypeDescription
ByteString

ResumeTypeCase

public Target.ResumeTypeOneofCase ResumeTypeCase { get; }
Property Value
TypeDescription
TargetResumeTypeOneofCase

TargetId

public int TargetId { get; set; }

The target ID that identifies the target on the stream. Must be a positive number and non-zero.

Property Value
TypeDescription
int

TargetTypeCase

public Target.TargetTypeOneofCase TargetTypeCase { get; }
Property Value
TypeDescription
TargetTargetTypeOneofCase