Class: Google::Apis::FirestoreV1beta1::RunQueryRequest

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RunQueryRequest

Returns a new instance of RunQueryRequest.



2227
2228
2229
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2227

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) 


2200
2201
2202
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2200

def mode
  @mode
end

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

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

Returns:



2205
2206
2207
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2205

def new_transaction
  @new_transaction
end

#read_time ⇒ String

Reads documents as they were at the given time. 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) 


2212
2213
2214
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2212

def read_time
  @read_time
end

#structured_query ⇒ Google::Apis::FirestoreV1beta1::StructuredQuery

A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit Corresponds to the JSON property structuredQuery

Returns:



2218
2219
2220
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2218

def structured_query
  @structured_query
end

#transaction ⇒ String

Run the query 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) 


2225
2226
2227
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2225

def transaction
  @transaction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2232
2233
2234
2235
2236
2237
2238
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2232

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_query = args[:structured_query] if args.key?(:structured_query)
  @transaction = args[:transaction] if args.key?(:transaction)
end