Class: Google::Apis::FirestoreV1beta1::RunAggregationQueryRequest

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 request for Firestore.RunAggregationQuery.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RunAggregationQueryRequest

Returns a new instance of RunAggregationQueryRequest.



2132
2133
2134
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2132

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

Instance Attribute Details

#mode ⇒ String

Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to NORMAL mode where no additional statistics will be returned with the query results. Corresponds to the JSON property mode

Returns:

  • (String) 


2106
2107
2108
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2106

def mode
  @mode
end

#new_transaction ⇒ Google::Apis::FirestoreV1beta1::TransactionOptions

Options for creating a new transaction. Corresponds to the JSON property newTransaction

Returns:



2111
2112
2113
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2111

def new_transaction
  @new_transaction
end

#read_time ⇒ String

Executes the query at the given timestamp. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. Corresponds to the JSON property readTime

Returns:

  • (String) 


2118
2119
2120
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2118

def read_time
  @read_time
end

#structured_aggregation_query ⇒ Google::Apis::FirestoreV1beta1::StructuredAggregationQuery

Firestore query for running an aggregation over a StructuredQuery. Corresponds to the JSON property structuredAggregationQuery

Returns:



2123
2124
2125
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2123

def structured_aggregation_query
  @structured_aggregation_query
end

#transaction ⇒ String

Run the aggregation within an already active transaction. The value here is the opaque transaction ID to execute the query in. Corresponds to the JSON property transaction NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


2130
2131
2132
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2130

def transaction
  @transaction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2137
2138
2139
2140
2141
2142
2143
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2137

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