Class: OCI::Opsi::Models::SummarizeExadataInsightResourceUsageAggregation

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

Overview

Resource usage summation for the current time period

Constant Summary collapse

EXADATA_RESOURCE_METRIC_ENUM = 
[
  EXADATA_RESOURCE_METRIC_CPU = 'CPU'.freeze,
  EXADATA_RESOURCE_METRIC_STORAGE = 'STORAGE'.freeze,
  EXADATA_RESOURCE_METRIC_IO = 'IO'.freeze,
  EXADATA_RESOURCE_METRIC_MEMORY = 'MEMORY'.freeze,
  EXADATA_RESOURCE_METRIC_IOPS = 'IOPS'.freeze,
  EXADATA_RESOURCE_METRIC_THROUGHPUT = 'THROUGHPUT'.freeze,
  EXADATA_RESOURCE_METRIC_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
EXADATA_RESOURCE_TYPE_ENUM = 
[
  EXADATA_RESOURCE_TYPE_DATABASE = 'DATABASE'.freeze,
  EXADATA_RESOURCE_TYPE_HOST = 'HOST'.freeze,
  EXADATA_RESOURCE_TYPE_STORAGE_SERVER = 'STORAGE_SERVER'.freeze,
  EXADATA_RESOURCE_TYPE_DISKGROUP = 'DISKGROUP'.freeze,
  EXADATA_RESOURCE_TYPE_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 = {}) ⇒ SummarizeExadataInsightResourceUsageAggregation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :time_interval_start (DateTime) —

    The value to assign to the #time_interval_start property

  • :time_interval_end (DateTime) —

    The value to assign to the #time_interval_end property

  • :exadata_resource_metric (String) —

    The value to assign to the #exadata_resource_metric property

  • :exadata_resource_type (String) —

    The value to assign to the #exadata_resource_type property

  • :usage_unit (String) —

    The value to assign to the #usage_unit property

  • :usage (Float) —

    The value to assign to the #usage property

  • :capacity (Float) —

    The value to assign to the #capacity property

  • :usage_change_percent (Float) —

    The value to assign to the #usage_change_percent property

  • :total_host_capacity (Float) —

    The value to assign to the #total_host_capacity property



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/opsi/models/summarize_exadata_insight_resource_usage_aggregation.rb', line 129

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

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

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

  self.exadata_resource_type = attributes[:'exadataResourceType'] if attributes[:'exadataResourceType']

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

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

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

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

  self.usage_change_percent = attributes[:'usageChangePercent'] if attributes[:'usageChangePercent']

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

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

  self.total_host_capacity = attributes[:'totalHostCapacity'] if attributes[:'totalHostCapacity']

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

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

Instance Attribute Details

#capacity ⇒ Float

[Required] The maximum allocated amount of the resource metric type (CPU, STORAGE) for a set of databases.

Returns:

  • (Float) 


69
70
71
 
# File 'lib/oci/opsi/models/summarize_exadata_insight_resource_usage_aggregation.rb', line 69

def capacity
  @capacity
end

#exadata_resource_metric ⇒ String

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

Returns:

  • (String) 


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

def exadata_resource_metric
  @exadata_resource_metric
end

#exadata_resource_type ⇒ String

[Required] Defines the resource type for an exadata (example: DATABASE, STORAGE_SERVER, HOST, DISKGROUP)

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/opsi/models/summarize_exadata_insight_resource_usage_aggregation.rb', line 55

def exadata_resource_type
  @exadata_resource_type
end

#time_interval_end ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_interval_end
  @time_interval_end
end

#time_interval_start ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_interval_start
  @time_interval_start
end

#total_host_capacity ⇒ Float

The maximum host CPUs (cores x threads/core) on the underlying infrastructure. This only applies to CPU and does not not apply for Autonomous Databases.

Returns:

  • (Float) 


78
79
80
 
# File 'lib/oci/opsi/models/summarize_exadata_insight_resource_usage_aggregation.rb', line 78

def total_host_capacity
  @total_host_capacity
end

#usage ⇒ Float

[Required] Total amount used of the resource metric type (CPU, STORAGE).

Returns:

  • (Float) 


64
65
66
 
# File 'lib/oci/opsi/models/summarize_exadata_insight_resource_usage_aggregation.rb', line 64

def usage
  @usage
end

#usage_change_percent ⇒ Float

[Required] Percentage change in resource usage during the current period calculated using linear regression functions

Returns:

  • (Float) 


73
74
75
 
# File 'lib/oci/opsi/models/summarize_exadata_insight_resource_usage_aggregation.rb', line 73

def usage_change_percent
  @usage_change_percent
end

#usage_unit ⇒ String

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

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/opsi/models/summarize_exadata_insight_resource_usage_aggregation.rb', line 59

def usage_unit
  @usage_unit
end

Class Method Details

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/opsi/models/summarize_exadata_insight_resource_usage_aggregation.rb', line 81

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'time_interval_start': :'timeIntervalStart',
    'time_interval_end': :'timeIntervalEnd',
    'exadata_resource_metric': :'exadataResourceMetric',
    'exadata_resource_type': :'exadataResourceType',
    'usage_unit': :'usageUnit',
    'usage': :'usage',
    'capacity': :'capacity',
    'usage_change_percent': :'usageChangePercent',
    'total_host_capacity': :'totalHostCapacity'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/opsi/models/summarize_exadata_insight_resource_usage_aggregation.rb', line 98

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'time_interval_start': :'DateTime',
    'time_interval_end': :'DateTime',
    'exadata_resource_metric': :'String',
    'exadata_resource_type': :'String',
    'usage_unit': :'String',
    'usage': :'Float',
    'capacity': :'Float',
    'usage_change_percent': :'Float',
    'total_host_capacity': :'Float'
    # 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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/oci/opsi/models/summarize_exadata_insight_resource_usage_aggregation.rb', line 228

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 &&
    exadata_resource_metric == other.exadata_resource_metric &&
    exadata_resource_type == other.exadata_resource_type &&
    usage_unit == other.usage_unit &&
    usage == other.usage &&
    capacity == other.capacity &&
    usage_change_percent == other.usage_change_percent &&
    total_host_capacity == other.total_host_capacity
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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/oci/opsi/models/summarize_exadata_insight_resource_usage_aggregation.rb', line 266

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


246
247
248
 
# File 'lib/oci/opsi/models/summarize_exadata_insight_resource_usage_aggregation.rb', line 246

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



255
256
257
 
# File 'lib/oci/opsi/models/summarize_exadata_insight_resource_usage_aggregation.rb', line 255

def hash
  [time_interval_start, time_interval_end, exadata_resource_metric, exadata_resource_type, usage_unit, usage, capacity, usage_change_percent, total_host_capacity].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



299
300
301
302
303
304
305
306
307
308
 
# File 'lib/oci/opsi/models/summarize_exadata_insight_resource_usage_aggregation.rb', line 299

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



293
294
295
 
# File 'lib/oci/opsi/models/summarize_exadata_insight_resource_usage_aggregation.rb', line 293

def to_s
  to_hash.to_s
end