Class Target

A specification of a set of documents to listen to.

Inheritance

object

Target

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.v1beta1.Data

Assembly: Google.Apis.Firestore.v1beta1.dll

Syntax

public class Target : IDirectResponseSchema

Properties

Documents

A target specified by a set of document names.

Declaration

[JsonProperty("documents")]
public virtual DocumentsTarget Documents { get; set; }

Property Value

Type	Description
DocumentsTarget

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

ExpectedCount

The number of documents that last matched the query at the resume token or read time. This value is only relevant when a resume_type is provided. This value being present and greater than zero signals that the client wants ExistenceFilter.unchanged_names to be included in the response.

Declaration

[JsonProperty("expectedCount")]
public virtual int? ExpectedCount { get; set; }

Property Value

Type	Description
int?

Once

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

Declaration

[JsonProperty("once")]
public virtual bool? Once { get; set; }

Property Value

Type	Description
bool?

Query

A target specified by a query.

Declaration

[JsonProperty("query")]
public virtual QueryTarget Query { get; set; }

Property Value

Type	Description
QueryTarget

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

Start listening after a specific read_time. The client must know the state of matching documents at this time.

Declaration

[JsonProperty("readTime")]
public virtual string ReadTimeRaw { get; set; }

Property Value

Type	Description
string

ResumeToken

A resume token from a prior TargetChange for an identical target. Using a resume token with a different target is unsupported and may fail.

Declaration

[JsonProperty("resumeToken")]
public virtual string ResumeToken { get; set; }

Property Value

Type	Description
string

TargetId

The target ID that identifies the target on the stream. Must be a positive number and non-zero. If target_id is 0 (or unspecified), the server will assign an ID for this target and return that in a TargetChange::ADD event. Once a target with target_id=0 is added, all subsequent targets must also have target_id=0. If an AddTarget request with target_id != 0 is sent to the server after a target with target_id=0 is added, the server will immediately send a response with a TargetChange::Remove event. Note that if the client sends multiple AddTarget requests without an ID, the order of IDs returned in TargetChage.target_ids are undefined. Therefore, clients should provide a target ID instead of relying on the server to assign one. If target_id is non-zero, there must not be an existing active target on this stream with the same ID.

Declaration

[JsonProperty("targetId")]
public virtual int? TargetId { get; set; }

Property Value

Type	Description
int?

Implements

IDirectResponseSchema