Class: OCI::DatabaseManagement::Models::SqlTuningAdvisorTaskSummaryReportIndexFindingSummary

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

Overview

A summary for all the index findings in a SQL Tuning Advisor task. Includes the index's hash value, table name, schema, index name, reference count and index columns

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SqlTuningAdvisorTaskSummaryReportIndexFindingSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :index_hash_value (Integer) —

    The value to assign to the #index_hash_value property

  • :index_name (String) —

    The value to assign to the #index_name property

  • :table_name (String) —

    The value to assign to the #table_name property

  • :schema (String) —

    The value to assign to the #schema property

  • :reference_count (Integer) —

    The value to assign to the #reference_count property

  • :index_columns (Array<String>) —

    The value to assign to the #index_columns property



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_index_finding_summary.rb', line 75

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.index_hash_value = attributes[:'indexHashValue'] if attributes[:'indexHashValue']

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

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

  self.index_name = attributes[:'indexName'] if attributes[:'indexName']

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

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

  self.table_name = attributes[:'tableName'] if attributes[:'tableName']

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

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

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

  self.reference_count = attributes[:'referenceCount'] if attributes[:'referenceCount']

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

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

  self.index_columns = attributes[:'indexColumns'] if attributes[:'indexColumns']

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

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

Instance Attribute Details

#index_columns ⇒ Array<String>

[Required] Columns of the index.

Returns:

  • (Array<String>) 


33
34
35
 
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_index_finding_summary.rb', line 33

def index_columns
  @index_columns
end

#index_hash_value ⇒ Integer

[Required] Numerical representation of the index.

Returns:

  • (Integer) 


13
14
15
 
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_index_finding_summary.rb', line 13

def index_hash_value
  @index_hash_value
end

#index_name ⇒ String

[Required] Name of the index.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_index_finding_summary.rb', line 17

def index_name
  @index_name
end

#reference_count ⇒ Integer

[Required] The number of times the index is referenced within the SQL Tuning advisor task findings.

Returns:

  • (Integer) 


29
30
31
 
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_index_finding_summary.rb', line 29

def reference_count
  @reference_count
end

#schema ⇒ String

[Required] Schema related to the index.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_index_finding_summary.rb', line 25

def schema
  @schema
end

#table_name ⇒ String

[Required] Table's name related to the index.

Returns:

  • (String) 


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

def table_name
  @table_name
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_index_finding_summary.rb', line 36

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'index_hash_value': :'indexHashValue',
    'index_name': :'indexName',
    'table_name': :'tableName',
    'schema': :'schema',
    'reference_count': :'referenceCount',
    'index_columns': :'indexColumns'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_index_finding_summary.rb', line 50

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'index_hash_value': :'Integer',
    'index_name': :'String',
    'table_name': :'String',
    'schema': :'String',
    'reference_count': :'Integer',
    'index_columns': :'Array<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



121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_index_finding_summary.rb', line 121

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

  self.class == other.class &&
    index_hash_value == other.index_hash_value &&
    index_name == other.index_name &&
    table_name == other.table_name &&
    schema == other.schema &&
    reference_count == other.reference_count &&
    index_columns == other.index_columns
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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_index_finding_summary.rb', line 156

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


136
137
138
 
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_index_finding_summary.rb', line 136

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



145
146
147
 
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_index_finding_summary.rb', line 145

def hash
  [index_hash_value, index_name, table_name, schema, reference_count, index_columns].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



189
190
191
192
193
194
195
196
197
198
 
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_index_finding_summary.rb', line 189

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



183
184
185
 
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_index_finding_summary.rb', line 183

def to_s
  to_hash.to_s
end