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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/firestore_v1beta1/classes.rb,
generated/google/apis/firestore_v1beta1/representations.rb,
generated/google/apis/firestore_v1beta1/representations.rb

Overview

The request for Firestore.RunQuery.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ RunQueryRequest

Returns a new instance of RunQueryRequest.



1598
1599
1600
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1598

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

Instance Attribute Details

#new_transactionGoogle::Apis::FirestoreV1beta1::TransactionOptions

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



1579
1580
1581
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1579

def new_transaction
  @new_transaction
end

#read_timeString

Reads documents as they were at the given time. This may not be older than 270 seconds. Corresponds to the JSON property readTime

Returns:

  • (String)


1585
1586
1587
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1585

def read_time
  @read_time
end

#structured_queryGoogle::Apis::FirestoreV1beta1::StructuredQuery

A Firestore query. Corresponds to the JSON property structuredQuery



1590
1591
1592
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1590

def structured_query
  @structured_query
end

#transactionString

Reads documents in a transaction. Corresponds to the JSON property transaction NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String)


1596
1597
1598
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1596

def transaction
  @transaction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1603
1604
1605
1606
1607
1608
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1603

def update!(**args)
  @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