Class: OCI::Opsi::Models::ResourceStatistics

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

Overview

Contains resource statistics with usage unit

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResourceStatistics

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



93
94
95
96
97
98
99
100
101
102
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
 
# File 'lib/oci/opsi/models/resource_statistics.rb', line 93

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

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

  self.base_capacity = attributes[:'baseCapacity'] if attributes[:'baseCapacity']

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

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

  self.is_auto_scaling_enabled = attributes[:'isAutoScalingEnabled'] unless attributes[:'isAutoScalingEnabled'].nil?

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

  self.is_auto_scaling_enabled = attributes[:'is_auto_scaling_enabled'] unless attributes[:'is_auto_scaling_enabled'].nil?

  self.utilization_percent = attributes[:'utilizationPercent'] if attributes[:'utilizationPercent']

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

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

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

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

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

  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

#base_capacity ⇒ Float

The base allocated amount of the resource metric type (CPU, STORAGE) for a set of databases.

Returns:

  • (Float) 


24
25
26
 
# File 'lib/oci/opsi/models/resource_statistics.rb', line 24

def base_capacity
  @base_capacity
end

#capacity ⇒ Float

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

Returns:

  • (Float) 


19
20
21
 
# File 'lib/oci/opsi/models/resource_statistics.rb', line 19

def capacity
  @capacity
end

#instance_metrics ⇒ Array<OCI::Opsi::Models::InstanceMetrics>

Array of instance metrics

Returns:



40
41
42
 
# File 'lib/oci/opsi/models/resource_statistics.rb', line 40

def instance_metrics
  @instance_metrics
end

#is_auto_scaling_enabled ⇒ BOOLEAN

Indicates if auto scaling feature is enabled or disabled on a database. It will be false for all metrics other than CPU.

Returns:

  • (BOOLEAN) 


28
29
30
 
# File 'lib/oci/opsi/models/resource_statistics.rb', line 28

def is_auto_scaling_enabled
  @is_auto_scaling_enabled
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) 


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

def total_host_capacity
  @total_host_capacity
end

#usage ⇒ Float

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

Returns:

  • (Float) 


14
15
16
 
# File 'lib/oci/opsi/models/resource_statistics.rb', line 14

def usage
  @usage
end

#usage_change_percent ⇒ Float

[Required] Change in resource utilization in percentage

Returns:

  • (Float) 


36
37
38
 
# File 'lib/oci/opsi/models/resource_statistics.rb', line 36

def usage_change_percent
  @usage_change_percent
end

#utilization_percent ⇒ Float

[Required] Resource utilization in percentage

Returns:

  • (Float) 


32
33
34
 
# File 'lib/oci/opsi/models/resource_statistics.rb', line 32

def utilization_percent
  @utilization_percent
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/opsi/models/resource_statistics.rb', line 48

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'usage': :'usage',
    'capacity': :'capacity',
    'base_capacity': :'baseCapacity',
    'is_auto_scaling_enabled': :'isAutoScalingEnabled',
    'utilization_percent': :'utilizationPercent',
    'usage_change_percent': :'usageChangePercent',
    'instance_metrics': :'instanceMetrics',
    'total_host_capacity': :'totalHostCapacity'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/opsi/models/resource_statistics.rb', line 64

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'usage': :'Float',
    'capacity': :'Float',
    'base_capacity': :'Float',
    'is_auto_scaling_enabled': :'BOOLEAN',
    'utilization_percent': :'Float',
    'usage_change_percent': :'Float',
    'instance_metrics': :'Array<OCI::Opsi::Models::InstanceMetrics>',
    '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



147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/opsi/models/resource_statistics.rb', line 147

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

  self.class == other.class &&
    usage == other.usage &&
    capacity == other.capacity &&
    base_capacity == other.base_capacity &&
    is_auto_scaling_enabled == other.is_auto_scaling_enabled &&
    utilization_percent == other.utilization_percent &&
    usage_change_percent == other.usage_change_percent &&
    instance_metrics == other.instance_metrics &&
    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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/oci/opsi/models/resource_statistics.rb', line 184

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


164
165
166
 
# File 'lib/oci/opsi/models/resource_statistics.rb', line 164

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



173
174
175
 
# File 'lib/oci/opsi/models/resource_statistics.rb', line 173

def hash
  [usage, capacity, base_capacity, is_auto_scaling_enabled, utilization_percent, usage_change_percent, instance_metrics, 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



217
218
219
220
221
222
223
224
225
226
 
# File 'lib/oci/opsi/models/resource_statistics.rb', line 217

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



211
212
213
 
# File 'lib/oci/opsi/models/resource_statistics.rb', line 211

def to_s
  to_hash.to_s
end