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

Inherits:

Object

• Object
• Google::Apis::FirestoreV1::ExplainOptions

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

• #analyze ⇒ Boolean (also: #analyze?)

  Optional.

Instance Method Summary

• #initialize(**args) ⇒ ExplainOptions constructor

  A new instance of ExplainOptions.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ ExplainOptions

Returns a new instance of ExplainOptions.

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

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)

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

def analyze
  @analyze
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

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

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