Class: OCI::Bds::Models::MetricThresholdRule

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/bds/models/metric_threshold_rule.rb

Overview

An autoscale action is triggered when a performance metric exceeds a threshold.

Constant Summary collapse

OPERATOR_ENUM = 
[
  OPERATOR_GT = 'GT'.freeze,
  OPERATOR_LT = 'LT'.freeze,
  OPERATOR_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MetricThresholdRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :duration_in_minutes (Integer) —

    The value to assign to the #duration_in_minutes property

  • :operator (String) —

    The value to assign to the #operator property

  • :value (Integer) —

    The value to assign to the #value property



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

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

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

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

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

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

Instance Attribute Details

#duration_in_minutes ⇒ Integer

[Required] This value is the minimum period of time the metric value exceeds the threshold value before the action is triggered. The value is in minutes.

Returns:

  • (Integer) 


20
21
22
 
# File 'lib/oci/bds/models/metric_threshold_rule.rb', line 20

def duration_in_minutes
  @duration_in_minutes
end

#operator ⇒ String

[Required] The comparison operator to use. Options are greater than (GT) or less than (LT).

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/bds/models/metric_threshold_rule.rb', line 24

def operator
  @operator
end

#value ⇒ Integer

[Required] Integer non-negative value. 0 < value < 100

Returns:

  • (Integer) 


28
29
30
 
# File 'lib/oci/bds/models/metric_threshold_rule.rb', line 28

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
 
# File 'lib/oci/bds/models/metric_threshold_rule.rb', line 31

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'duration_in_minutes': :'durationInMinutes',
    'operator': :'operator',
    'value': :'value'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'duration_in_minutes': :'Integer',
    'operator': :'String',
    'value': :'Integer'
    # 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



98
99
100
101
102
103
104
105
 
# File 'lib/oci/bds/models/metric_threshold_rule.rb', line 98

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

  self.class == other.class &&
    duration_in_minutes == other.duration_in_minutes &&
    operator == other.operator &&
    value == other.value
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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/oci/bds/models/metric_threshold_rule.rb', line 130

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


110
111
112
 
# File 'lib/oci/bds/models/metric_threshold_rule.rb', line 110

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



119
120
121
 
# File 'lib/oci/bds/models/metric_threshold_rule.rb', line 119

def hash
  [duration_in_minutes, operator, value].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



163
164
165
166
167
168
169
170
171
172
 
# File 'lib/oci/bds/models/metric_threshold_rule.rb', line 163

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



157
158
159
 
# File 'lib/oci/bds/models/metric_threshold_rule.rb', line 157

def to_s
  to_hash.to_s
end