Class: Google::Apis::FirestoreV1::QueryPlan

Inherits:

Object

• Object
• Google::Apis::FirestoreV1::QueryPlan

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

Plan for the query.

Instance Attribute Summary

• #plan_info ⇒ Hash<String,Object>

  Planning phase information for the query.

Instance Method Summary

• #initialize(**args) ⇒ QueryPlan constructor

  A new instance of QueryPlan.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ QueryPlan

Returns a new instance of QueryPlan.

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

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

Instance Attribute Details

#plan_info ⇒ Hash<String,Object>

Planning phase information for the query. It will include: "indexes_used": [ "query_scope": "Collection", "properties": "(foo ASC, name ASC)"," query_scope": "Collection", "properties": "(bar ASC, name ASC)"] Corresponds to the JSON property planInfo

Returns:

• (Hash<String,Object>)

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

def plan_info
  @plan_info
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

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

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