Class: Google::Apis::FirestoreV1::QueryTarget

Inherits:

Object

• Object
• Google::Apis::FirestoreV1::QueryTarget

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

A target specified by a query.

Instance Attribute Summary

• #parent ⇒ String

  The parent resource name.

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

  A Firestore query.

Instance Method Summary

• #initialize(**args) ⇒ QueryTarget constructor

  A new instance of QueryTarget.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ QueryTarget

Returns a new instance of QueryTarget.

# File 'lib/google/apis/firestore_v1/classes.rb', line 3339

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

Instance Attribute Details

#parent ⇒ String

The parent resource name. In the format: projects/project_id/databases/ database_id/documents or projects/project_id/databases/database_id/ documents/document_path`. For example:projects/my-project/databases/my- database/documentsorprojects/my-project/databases/my-database/documents/ chatrooms/my-chatroom Corresponds to the JSON propertyparent`

Returns:

• (String)

# File 'lib/google/apis/firestore_v1/classes.rb', line 3330

def parent
  @parent
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:

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

# File 'lib/google/apis/firestore_v1/classes.rb', line 3337

def structured_query
  @structured_query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/firestore_v1/classes.rb', line 3344

def update!(**args)
  @parent = args[:parent] if args.key?(:parent)
  @structured_query = args[:structured_query] if args.key?(:structured_query)
end