Class: Google::Apis::FirestoreV1::ExplainOptions

Inherits:
Object
  • Object
show all
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

Explain options for the query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ExplainOptions

Returns a new instance of ExplainOptions.



885
886
887
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 885

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

Instance Attribute Details

#analyze ⇒ Boolean Also known as: analyze?

Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics. Corresponds to the JSON property analyze

Returns:

  • (Boolean) 


882
883
884
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 882

def analyze
  @analyze
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



890
891
892
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 890

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