Class: OCI::DatabaseManagement::Models::SqlTuningTaskPlanStats

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_management/models/sql_tuning_task_plan_stats.rb

Overview

The statistics of a SQL execution plan.

Constant Summary collapse

PLAN_STATUS_ENUM = 
[
  PLAN_STATUS_COMPLETE = 'COMPLETE'.freeze,
  PLAN_STATUS_PARTIAL = 'PARTIAL'.freeze,
  PLAN_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SqlTuningTaskPlanStats

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :plan_type (String) —

    The value to assign to the #plan_type property

  • :plan_stats (Hash<String, Float>) —

    The value to assign to the #plan_stats property

  • :plan_status (String) —

    The value to assign to the #plan_status property



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/database_management/models/sql_tuning_task_plan_stats.rb', line 65

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.plan_type = attributes[:'planType'] if attributes[:'planType']

  raise 'You cannot provide both :planType and :plan_type' if attributes.key?(:'planType') && attributes.key?(:'plan_type')

  self.plan_type = attributes[:'plan_type'] if attributes[:'plan_type']

  self.plan_stats = attributes[:'planStats'] if attributes[:'planStats']

  raise 'You cannot provide both :planStats and :plan_stats' if attributes.key?(:'planStats') && attributes.key?(:'plan_stats')

  self.plan_stats = attributes[:'plan_stats'] if attributes[:'plan_stats']

  self.plan_status = attributes[:'planStatus'] if attributes[:'planStatus']

  raise 'You cannot provide both :planStatus and :plan_status' if attributes.key?(:'planStatus') && attributes.key?(:'plan_status')

  self.plan_status = attributes[:'plan_status'] if attributes[:'plan_status']
end

Instance Attribute Details

#plan_stats ⇒ Hash<String, Float>

[Required] A map contains the statistics for the SQL execution using the plan. The key of the map is the metric's name. The value of the map is the metric's value.

Returns:

  • (Hash<String, Float>) 


27
28
29
 
# File 'lib/oci/database_management/models/sql_tuning_task_plan_stats.rb', line 27

def plan_stats
  @plan_stats
end

#plan_status ⇒ String

[Required] The status of the execution using the plan.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/database_management/models/sql_tuning_task_plan_stats.rb', line 32

def plan_status
  @plan_status
end

#plan_type ⇒ String

[Required] The type of the original or modified plan with profile, index, and so on.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/database_management/models/sql_tuning_task_plan_stats.rb', line 21

def plan_type
  @plan_type
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



35
36
37
38
39
40
41
42
43
 
# File 'lib/oci/database_management/models/sql_tuning_task_plan_stats.rb', line 35

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'plan_type': :'planType',
    'plan_stats': :'planStats',
    'plan_status': :'planStatus'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
 
# File 'lib/oci/database_management/models/sql_tuning_task_plan_stats.rb', line 46

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'plan_type': :'String',
    'plan_stats': :'Hash<String, Float>',
    'plan_status': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



110
111
112
113
114
115
116
117
 
# File 'lib/oci/database_management/models/sql_tuning_task_plan_stats.rb', line 110

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    plan_type == other.plan_type &&
    plan_stats == other.plan_stats &&
    plan_status == other.plan_status
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/database_management/models/sql_tuning_task_plan_stats.rb', line 142

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


122
123
124
 
# File 'lib/oci/database_management/models/sql_tuning_task_plan_stats.rb', line 122

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



131
132
133
 
# File 'lib/oci/database_management/models/sql_tuning_task_plan_stats.rb', line 131

def hash
  [plan_type, plan_stats, plan_status].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/database_management/models/sql_tuning_task_plan_stats.rb', line 175

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



169
170
171
 
# File 'lib/oci/database_management/models/sql_tuning_task_plan_stats.rb', line 169

def to_s
  to_hash.to_s
end