Class: Google::Firestore::V1beta1::RunQueryResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb

Overview

The response for Firestore::RunQuery.

Instance Attribute Summary collapse

Instance Attribute Details

#document ⇒ Google::Firestore::V1beta1::Document

Returns A query result. Not set when reporting partial progress.

Returns:



324
 
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb', line 324

class RunQueryResponse; 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.



324
 
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb', line 324

class RunQueryResponse; 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.



324
 
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb', line 324

class RunQueryResponse; 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.



324
 
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb', line 324

class RunQueryResponse; end