Class RunQueryResponse

The response for Firestore.RunQuery.

Inheritance

object

RunQueryResponse

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 RunQueryResponse : IDirectResponseSchema

Properties

Document

A query result, not set when reporting partial progress.

Declaration

[JsonProperty("document")]
public virtual Document Document { get; set; }

Property Value

Type	Description
Document

Done

If present, Firestore has completely finished the request and no more documents will be returned.

Declaration

[JsonProperty("done")]
public virtual bool? Done { get; set; }

Property Value

Type	Description
bool?

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

ExplainMetrics

Query explain metrics. This is only present when the RunQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.

Declaration

[JsonProperty("explainMetrics")]
public virtual ExplainMetrics ExplainMetrics { get; set; }

Property Value

Type	Description
ExplainMetrics

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 time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their read_time and this one. If the query returns no results, a response with read_time and no document will be sent, and this represents the time at which the query was run.

Declaration

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

Property Value

Type	Description
string

SkippedResults

The number of results that have been skipped due to an offset between the last response and the current response.

Declaration

[JsonProperty("skippedResults")]
public virtual int? SkippedResults { get; set; }

Property Value

Type	Description
int?

Transaction

The transaction that was started as part of this request. Can only be set in the first response, and only if RunQueryRequest.new_transaction was set in the request. If set, no other fields will be set in this response.

Declaration

[JsonProperty("transaction")]
public virtual string Transaction { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema