Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::RunQueryResponse (v1.2.0)

Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::RunQueryResponse.

The response for Firestore.RunQuery.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#document

def document() -> ::Google::Cloud::Firestore::V1::Document

Returns

(::Google::Cloud::Firestore::V1::Document) — A query result, not set when reporting partial progress.

#document=

def document=(value) -> ::Google::Cloud::Firestore::V1::Document

Parameter

value (::Google::Cloud::Firestore::V1::Document) — A query result, not set when reporting partial progress.

Returns

(::Google::Cloud::Firestore::V1::Document) — A query result, not set when reporting partial progress.

#done

def done() -> ::Boolean

Returns

(::Boolean) — If present, Firestore has completely finished the request and no more documents will be returned.

#done=

def done=(value) -> ::Boolean

Parameter

value (::Boolean) — If present, Firestore has completely finished the request and no more documents will be returned.

Returns

(::Boolean) — If present, Firestore has completely finished the request and no more documents will be returned.

#explain_metrics

def explain_metrics() -> ::Google::Cloud::Firestore::V1::ExplainMetrics

Returns

(::Google::Cloud::Firestore::V1::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.

#explain_metrics=

def explain_metrics=(value) -> ::Google::Cloud::Firestore::V1::ExplainMetrics

Parameter

value (::Google::Cloud::Firestore::V1::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.

Returns

(::Google::Cloud::Firestore::V1::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.

#read_time

def read_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — 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.

#read_time=

def read_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — 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.

Returns

(::Google::Protobuf::Timestamp) — 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.

#skipped_results

def skipped_results() -> ::Integer

Returns

(::Integer) — The number of results that have been skipped due to an offset between the last response and the current response.

#skipped_results=

def skipped_results=(value) -> ::Integer

Parameter

value (::Integer) — The number of results that have been skipped due to an offset between the last response and the current response.

Returns

(::Integer) — The number of results that have been skipped due to an offset between the last response and the current response.

#transaction

def transaction() -> ::String

Returns

(::String) — 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.

#transaction=

def transaction=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.