Class: Google::Apis::FirestoreV1beta1::RunAggregationQueryResponse

Inherits:
Object
  • Object
show all
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

Overview

The response for Firestore.RunAggregationQuery.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RunAggregationQueryResponse

Returns a new instance of RunAggregationQueryResponse.



1847
1848
1849
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1847

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

Instance Attribute Details

#read_timeString

The time at which the aggregate value is valid for. Corresponds to the JSON property readTime

Returns:

  • (String)


1831
1832
1833
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1831

def read_time
  @read_time
end

#resultGoogle::Apis::FirestoreV1beta1::AggregationResult

The result of a single bucket from a Firestore aggregation query. The keys of aggregate_fields are the same for all results in an aggregation query, unlike document queries which can have different fields present for each result. Corresponds to the JSON property result



1838
1839
1840
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1838

def result
  @result
end

#transactionString

The transaction that was started as part of this request. Only present on the first response when the request requested to start a new transaction. Corresponds to the JSON property transaction NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String)


1845
1846
1847
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1845

def transaction
  @transaction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1852
1853
1854
1855
1856
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1852

def update!(**args)
  @read_time = args[:read_time] if args.key?(:read_time)
  @result = args[:result] if args.key?(:result)
  @transaction = args[:transaction] if args.key?(:transaction)
end