Class: OCI::Opsi::Models::SummarizeDatabaseInsightResourceStatisticsAggregationCollection

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/opsi/models/summarize_database_insight_resource_statistics_aggregation_collection.rb

Overview

Returns list of the Databases with resource statistics like usage, capacity, utilization and usage change percent.

Constant Summary collapse

RESOURCE_METRIC_ENUM = 
[
  RESOURCE_METRIC_CPU = 'CPU'.freeze,
  RESOURCE_METRIC_STORAGE = 'STORAGE'.freeze,
  RESOURCE_METRIC_IO = 'IO'.freeze,
  RESOURCE_METRIC_MEMORY = 'MEMORY'.freeze,
  RESOURCE_METRIC_MEMORY_PGA = 'MEMORY_PGA'.freeze,
  RESOURCE_METRIC_MEMORY_SGA = 'MEMORY_SGA'.freeze,
  RESOURCE_METRIC_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
USAGE_UNIT_ENUM = 
[
  USAGE_UNIT_CORES = 'CORES'.freeze,
  USAGE_UNIT_GB = 'GB'.freeze,
  USAGE_UNIT_MBPS = 'MBPS'.freeze,
  USAGE_UNIT_IOPS = 'IOPS'.freeze,
  USAGE_UNIT_PERCENT = 'PERCENT'.freeze,
  USAGE_UNIT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SummarizeDatabaseInsightResourceStatisticsAggregationCollection

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/oci/opsi/models/summarize_database_insight_resource_statistics_aggregation_collection.rb', line 103

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

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

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

  self.time_interval_end = attributes[:'timeIntervalEnd'] if attributes[:'timeIntervalEnd']

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

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

  self.high_utilization_threshold = attributes[:'highUtilizationThreshold'] if attributes[:'highUtilizationThreshold']

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

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

  self.low_utilization_threshold = attributes[:'lowUtilizationThreshold'] if attributes[:'lowUtilizationThreshold']

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

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

  self.resource_metric = attributes[:'resourceMetric'] if attributes[:'resourceMetric']

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

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

  self.usage_unit = attributes[:'usageUnit'] if attributes[:'usageUnit']

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

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

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

Instance Attribute Details

#high_utilization_threshold ⇒ Integer

[Required] Percent value in which a resource metric is considered highly utilized.

Returns:

  • (Integer) 


41
42
43
 
# File 'lib/oci/opsi/models/summarize_database_insight_resource_statistics_aggregation_collection.rb', line 41

def high_utilization_threshold
  @high_utilization_threshold
end

#items ⇒ Array<OCI::Opsi::Models::ResourceStatisticsAggregation>

[Required] Collection of Resource Statistics items

Returns:



58
59
60
 
# File 'lib/oci/opsi/models/summarize_database_insight_resource_statistics_aggregation_collection.rb', line 58

def items
  @items
end

#low_utilization_threshold ⇒ Integer

[Required] Percent value in which a resource metric is considered lowly utilized.

Returns:

  • (Integer) 


45
46
47
 
# File 'lib/oci/opsi/models/summarize_database_insight_resource_statistics_aggregation_collection.rb', line 45

def low_utilization_threshold
  @low_utilization_threshold
end

#resource_metric ⇒ String

[Required] Defines the type of resource metric (example: CPU, STORAGE)

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/opsi/models/summarize_database_insight_resource_statistics_aggregation_collection.rb', line 50

def resource_metric
  @resource_metric
end

#time_interval_end ⇒ DateTime

[Required] The end timestamp that was passed into the request.

Returns:

  • (DateTime) 


37
38
39
 
# File 'lib/oci/opsi/models/summarize_database_insight_resource_statistics_aggregation_collection.rb', line 37

def time_interval_end
  @time_interval_end
end

#time_interval_start ⇒ DateTime

[Required] The start timestamp that was passed into the request.

Returns:

  • (DateTime) 


33
34
35
 
# File 'lib/oci/opsi/models/summarize_database_insight_resource_statistics_aggregation_collection.rb', line 33

def time_interval_start
  @time_interval_start
end

#usage_unit ⇒ String

[Required] Displays usage unit ( CORES, GB , PERCENT, MBPS)

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/opsi/models/summarize_database_insight_resource_statistics_aggregation_collection.rb', line 54

def usage_unit
  @usage_unit
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/opsi/models/summarize_database_insight_resource_statistics_aggregation_collection.rb', line 61

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'time_interval_start': :'timeIntervalStart',
    'time_interval_end': :'timeIntervalEnd',
    'high_utilization_threshold': :'highUtilizationThreshold',
    'low_utilization_threshold': :'lowUtilizationThreshold',
    'resource_metric': :'resourceMetric',
    'usage_unit': :'usageUnit',
    'items': :'items'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/opsi/models/summarize_database_insight_resource_statistics_aggregation_collection.rb', line 76

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'time_interval_start': :'DateTime',
    'time_interval_end': :'DateTime',
    'high_utilization_threshold': :'Integer',
    'low_utilization_threshold': :'Integer',
    'resource_metric': :'String',
    'usage_unit': :'String',
    'items': :'Array<OCI::Opsi::Models::ResourceStatisticsAggregation>'
    # 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



181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/oci/opsi/models/summarize_database_insight_resource_statistics_aggregation_collection.rb', line 181

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

  self.class == other.class &&
    time_interval_start == other.time_interval_start &&
    time_interval_end == other.time_interval_end &&
    high_utilization_threshold == other.high_utilization_threshold &&
    low_utilization_threshold == other.low_utilization_threshold &&
    resource_metric == other.resource_metric &&
    usage_unit == other.usage_unit &&
    items == other.items
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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/oci/opsi/models/summarize_database_insight_resource_statistics_aggregation_collection.rb', line 217

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


197
198
199
 
# File 'lib/oci/opsi/models/summarize_database_insight_resource_statistics_aggregation_collection.rb', line 197

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



206
207
208
 
# File 'lib/oci/opsi/models/summarize_database_insight_resource_statistics_aggregation_collection.rb', line 206

def hash
  [time_interval_start, time_interval_end, high_utilization_threshold, low_utilization_threshold, resource_metric, usage_unit, items].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



250
251
252
253
254
255
256
257
258
259
 
# File 'lib/oci/opsi/models/summarize_database_insight_resource_statistics_aggregation_collection.rb', line 250

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



244
245
246
 
# File 'lib/oci/opsi/models/summarize_database_insight_resource_statistics_aggregation_collection.rb', line 244

def to_s
  to_hash.to_s
end