Class: Google::Apis::FirestoreV1beta1::RunQueryResponse
- Inherits:
-
Object
- Object
- Google::Apis::FirestoreV1beta1::RunQueryResponse
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/firestore_v1beta1/classes.rb,
lib/google/apis/firestore_v1beta1/representations.rb,
lib/google/apis/firestore_v1beta1/representations.rb more...
Overview
The response for Firestore.RunQuery.
Instance Attribute Summary collapse
-
#document ⇒ Google::Apis::FirestoreV1beta1::Document
A Firestore document.
-
#done ⇒ Boolean
(also: #done?)
If present, Firestore has completely finished the request and no more documents will be returned.
-
#explain_metrics ⇒ Google::Apis::FirestoreV1beta1::ExplainMetrics
Explain metrics for the query.
-
#read_time ⇒ String
The time at which the document was read.
-
#skipped_results ⇒ Fixnum
The number of results that have been skipped due to an offset between the last response and the current response.
-
#transaction ⇒ String
The transaction that was started as part of this request.
Instance Method Summary collapse
-
#initialize(**args) ⇒ RunQueryResponse
constructor
A new instance of RunQueryResponse.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ RunQueryResponse
Returns a new instance of RunQueryResponse.
2471 2472 2473 |
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2471 def initialize(**args) update!(**args) end |
Instance Attribute Details
#document ⇒ Google::Apis::FirestoreV1beta1::Document
A Firestore document. Must not exceed 1 MiB - 4 bytes.
Corresponds to the JSON property document
2434 2435 2436 |
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2434 def document @document end |
#done ⇒ Boolean Also known as: done?
If present, Firestore has completely finished the request and no more
documents will be returned.
Corresponds to the JSON property done
2440 2441 2442 |
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2440 def done @done end |
#explain_metrics ⇒ Google::Apis::FirestoreV1beta1::ExplainMetrics
Explain metrics for the query.
Corresponds to the JSON property explainMetrics
2446 2447 2448 |
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2446 def explain_metrics @explain_metrics end |
#read_time ⇒ String
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.
Corresponds to the JSON property readTime
2455 2456 2457 |
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2455 def read_time @read_time end |
#skipped_results ⇒ Fixnum
The number of results that have been skipped due to an offset between the last
response and the current response.
Corresponds to the JSON property skippedResults
2461 2462 2463 |
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2461 def skipped_results @skipped_results end |
#transaction ⇒ 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.
Corresponds to the JSON property transaction
NOTE: Values are automatically base64 encoded/decoded in the client library.
2469 2470 2471 |
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2469 def transaction @transaction end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2476 2477 2478 2479 2480 2481 2482 2483 |
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2476 def update!(**args) @document = args[:document] if args.key?(:document) @done = args[:done] if args.key?(:done) @explain_metrics = args[:explain_metrics] if args.key?(:explain_metrics) @read_time = args[:read_time] if args.key?(:read_time) @skipped_results = args[:skipped_results] if args.key?(:skipped_results) @transaction = args[:transaction] if args.key?(:transaction) end |