Firestore v1 API - Class RunQueryResponse (3.6.0)

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

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

The response for [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].

Inheritance

object > RunQueryResponse

Implements

IMessage RunQueryResponse, IEquatable RunQueryResponse, IDeepCloneable RunQueryResponse, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.V1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

RunQueryResponse()

public RunQueryResponse()

RunQueryResponse(RunQueryResponse)

public RunQueryResponse(RunQueryResponse other)

Parameter
Name	Description
`other`	`RunQueryResponse`

Properties

ContinuationSelectorCase

public RunQueryResponse.ContinuationSelectorOneofCase ContinuationSelectorCase { get; }

Property Value
Type	Description
`RunQueryResponseContinuationSelectorOneofCase`

Document

public Document Document { get; set; }

A query result, not set when reporting partial progress.

Property Value
Type	Description
`Document`

Done

public bool Done { get; set; }

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

Property Value
Type	Description
`bool`

ExplainMetrics

public ExplainMetrics ExplainMetrics { get; set; }

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

Property Value
Type	Description
`ExplainMetrics`

HasDone

public bool HasDone { get; }

Gets whether the "done" field is set

Property Value
Type	Description
`bool`

ReadTime

public Timestamp ReadTime { get; set; }

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.

Property Value
Type	Description
`Timestamp`

SkippedResults

public int SkippedResults { get; set; }

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

Property Value
Type	Description
`int`

Transaction

public ByteString Transaction { get; set; }

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

Property Value
Type	Description
`ByteString`