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

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



1977
1978
1979
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1977

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

Instance Attribute Details

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

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

Returns:



1958
1959
1960
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1958

def new_transaction
  @new_transaction
end

#read_time ⇒ String

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

Returns:

  • (String) 


1964
1965
1966
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1964

def read_time
  @read_time
end

#structured_query ⇒ Google::Apis::FirestoreV1::StructuredQuery

A Firestore query. Corresponds to the JSON property structuredQuery

Returns:



1969
1970
1971
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1969

def structured_query
  @structured_query
end

#transaction ⇒ String

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

Returns:

  • (String) 


1975
1976
1977
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1975

def transaction
  @transaction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1982
1983
1984
1985
1986
1987
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1982

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