Class: OCI::Autoscaling::Models::Metric

Inherits:
MetricBase
  • Object
show all
Defined in:
lib/oci/autoscaling/models/metric.rb

Overview

Metric and threshold details for triggering an autoscaling action based on CPU or memory utilization.

Constant Summary collapse

METRIC_TYPE_ENUM = 
[
  METRIC_TYPE_CPU_UTILIZATION = 'CPU_UTILIZATION'.freeze,
  METRIC_TYPE_MEMORY_UTILIZATION = 'MEMORY_UTILIZATION'.freeze,
  METRIC_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from MetricBase

OCI::Autoscaling::Models::MetricBase::METRIC_SOURCE_ENUM

Instance Attribute Summary collapse

Attributes inherited from MetricBase

#metric_source, #pending_duration

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from MetricBase

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ Metric

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/autoscaling/models/metric.rb', line 61

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

  attributes['metricSource'] = 'COMPUTE_AGENT'

  super(attributes)

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

  self.metric_type = attributes[:'metricType'] if attributes[:'metricType']

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

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

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

Instance Attribute Details

#metric_type ⇒ String

This attribute is required.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/autoscaling/models/metric.rb', line 22

def metric_type
  @metric_type
end

#threshold ⇒ OCI::Autoscaling::Models::Threshold

This attribute is required.

Returns:



26
27
28
 
# File 'lib/oci/autoscaling/models/metric.rb', line 26

def threshold
  @threshold
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
37
38
 
# File 'lib/oci/autoscaling/models/metric.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'pending_duration': :'pendingDuration',
    'metric_source': :'metricSource',
    'metric_type': :'metricType',
    'threshold': :'threshold'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/oci/autoscaling/models/metric.rb', line 41

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'pending_duration': :'String',
    'metric_source': :'String',
    'metric_type': :'String',
    'threshold': :'OCI::Autoscaling::Models::Threshold'
    # 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



100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/autoscaling/models/metric.rb', line 100

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

  self.class == other.class &&
    pending_duration == other.pending_duration &&
    metric_source == other.metric_source &&
    metric_type == other.metric_type &&
    threshold == other.threshold
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



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/autoscaling/models/metric.rb', line 133

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


113
114
115
 
# File 'lib/oci/autoscaling/models/metric.rb', line 113

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



122
123
124
 
# File 'lib/oci/autoscaling/models/metric.rb', line 122

def hash
  [pending_duration, metric_source, metric_type, threshold].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



166
167
168
169
170
171
172
173
174
175
 
# File 'lib/oci/autoscaling/models/metric.rb', line 166

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



160
161
162
 
# File 'lib/oci/autoscaling/models/metric.rb', line 160

def to_s
  to_hash.to_s
end