Class: Google::Apis::FirestoreV1::RunQueryResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firestore_v1/classes.rb,
lib/google/apis/firestore_v1/representations.rb,
lib/google/apis/firestore_v1/representations.rb

Overview

The response for Firestore.RunQuery.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RunQueryResponse

Returns a new instance of RunQueryResponse.



3542
3543
3544
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3542

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#document ⇒ Google::Apis::FirestoreV1::Document

A Firestore document. Must not exceed 1 MiB - 4 bytes. Corresponds to the JSON property document

Returns:



3505
3506
3507
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3505

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

Returns:

  • (Boolean) 


3511
3512
3513
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3511

def done
  @done
end

#explain_metrics ⇒ Google::Apis::FirestoreV1::ExplainMetrics

Explain metrics for the query. Corresponds to the JSON property explainMetrics

Returns:



3517
3518
3519
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3517

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

Returns:

  • (String) 


3526
3527
3528
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3526

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

Returns:

  • (Fixnum) 


3532
3533
3534
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3532

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.

Returns:

  • (String) 


3540
3541
3542
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3540

def transaction
  @transaction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3547
3548
3549
3550
3551
3552
3553
3554
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3547

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