Class: Google::Cloud::Firestore::V1::RunQueryResponse

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/firestore/v1/firestore.rb

Overview

The response for Firestore.RunQuery.

Instance Attribute Summary collapse

Instance Attribute Details

#document ⇒ ::Google::Cloud::Firestore::V1::Document

Returns A query result, not set when reporting partial progress.

Returns:



423
424
425
426
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 423

class RunQueryResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#done ⇒ ::Boolean

Returns 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.



423
424
425
426
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 423

class RunQueryResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#explain_metrics ⇒ ::Google::Cloud::Firestore::V1::ExplainMetrics

Returns 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:



423
424
425
426
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 423

class RunQueryResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#read_time ⇒ ::Google::Protobuf::Timestamp

Returns 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.



423
424
425
426
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 423

class RunQueryResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#skipped_results ⇒ ::Integer

Returns 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.



423
424
425
426
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 423

class RunQueryResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#transaction ⇒ ::String

Returns 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.



423
424
425
426
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 423

class RunQueryResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end