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

Inherits:

Object

• Object
• Google::Apis::FirestoreV1::RunQueryRequest

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

Overview

The request for Firestore.RunQuery.

Instance Attribute Summary

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

  Options for creating a new transaction.

• #read_time ⇒ String

  Reads documents as they were at the given time.

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

  A Firestore query.

• #transaction ⇒ String

  Reads documents in a transaction.

Instance Method Summary

• #initialize(**args) ⇒ RunQueryRequest constructor

  A new instance of RunQueryRequest.

• #update!(**args) ⇒ Object

  Update properties of this object.

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

# File 'generated/google/apis/firestore_v1/classes.rb', line 1995

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:

• (Google::Apis::FirestoreV1::TransactionOptions)

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

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)

# File 'generated/google/apis/firestore_v1/classes.rb', line 1982

def read_time
  @read_time
end

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

A Firestore query. Corresponds to the JSON property structuredQuery

Returns:

• (Google::Apis::FirestoreV1::StructuredQuery)

# File 'generated/google/apis/firestore_v1/classes.rb', line 1987

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)

# File 'generated/google/apis/firestore_v1/classes.rb', line 1993

def transaction
  @transaction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/firestore_v1/classes.rb', line 2000

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