Class: OCI::Monitoring::Models::AlarmDimensionStatesCollection

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/monitoring/models/alarm_dimension_states_collection.rb

Overview

The list of current alarm state entries for each metric stream that matches the filters.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AlarmDimensionStatesCollection

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_collection.rb', line 69

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

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

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

  self.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil?

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

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

  self.is_notifications_per_metric_dimension_enabled = attributes[:'isNotificationsPerMetricDimensionEnabled'] unless attributes[:'isNotificationsPerMetricDimensionEnabled'].nil?

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

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

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

Instance Attribute Details

#alarm_id ⇒ String

[Required] The OCID of the alarm to retrieve alarm state entries for.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_collection.rb', line 15

def alarm_id
  @alarm_id
end

#is_enabled ⇒ BOOLEAN

[Required] Whether the alarm is enabled.

Example: true

Returns:

  • (BOOLEAN) 


22
23
24
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_collection.rb', line 22

def is_enabled
  @is_enabled
end

#is_notifications_per_metric_dimension_enabled ⇒ BOOLEAN

[Required] When set to true, splits alarm notifications per metric stream. When set to false, groups alarm notifications across metric streams.

Returns:

  • (BOOLEAN) 


28
29
30
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_collection.rb', line 28

def is_notifications_per_metric_dimension_enabled
  @is_notifications_per_metric_dimension_enabled
end

#items ⇒ Array<OCI::Monitoring::Models::AlarmDimensionStatesEntry>

[Required] Array of alarm state entries.

Returns:



33
34
35
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_collection.rb', line 33

def items
  @items
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_collection.rb', line 36

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'alarm_id': :'alarmId',
    'is_enabled': :'isEnabled',
    'is_notifications_per_metric_dimension_enabled': :'isNotificationsPerMetricDimensionEnabled',
    'items': :'items'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_collection.rb', line 48

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'alarm_id': :'String',
    'is_enabled': :'BOOLEAN',
    'is_notifications_per_metric_dimension_enabled': :'BOOLEAN',
    'items': :'Array<OCI::Monitoring::Models::AlarmDimensionStatesEntry>'
    # 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



103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_collection.rb', line 103

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

  self.class == other.class &&
    alarm_id == other.alarm_id &&
    is_enabled == other.is_enabled &&
    is_notifications_per_metric_dimension_enabled == other.is_notifications_per_metric_dimension_enabled &&
    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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_collection.rb', line 136

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


116
117
118
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_collection.rb', line 116

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



125
126
127
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_collection.rb', line 125

def hash
  [alarm_id, is_enabled, is_notifications_per_metric_dimension_enabled, items].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_collection.rb', line 169

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



163
164
165
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_collection.rb', line 163

def to_s
  to_hash.to_s
end