Class: Google::Apis::FirestoreV1::RunQueryRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firestore_v1/classes.rb,
lib/google/apis/firestore_v1/representations.rb,
lib/google/apis/firestore_v1/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.



4354
4355
4356
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 4354

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

Instance Attribute Details

#explain_options ⇒ Google::Apis::FirestoreV1::ExplainOptions

Explain options for the query. Corresponds to the JSON property explainOptions

Returns:



4321
4322
4323
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 4321

def explain_options
  @explain_options
end

#new_transaction ⇒ Google::Apis::FirestoreV1::TransactionOptions

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

Returns:



4326
4327
4328
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 4326

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) 


4333
4334
4335
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 4333

def read_time
  @read_time
end

#request_options ⇒ Google::Apis::FirestoreV1::RequestOptions

Options for a server request. Corresponds to the JSON property requestOptions

Returns:



4338
4339
4340
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 4338

def request_options
  @request_options
end

#structured_query ⇒ Google::Apis::FirestoreV1::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 7. find_nearest Corresponds to the JSON property structuredQuery

Returns:



4345
4346
4347
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 4345

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) 


4352
4353
4354
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 4352

def transaction
  @transaction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4359
4360
4361
4362
4363
4364
4365
4366
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 4359

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