Class: OCI::Monitoring::Models::AlarmHistoryCollection

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

Overview

The configuration details for retrieving alarm history.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AlarmHistoryCollection

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

Instance Attribute Details

#alarm_idString

[Required] The OCID of the alarm for which to retrieve history.

Returns:

  • (String)


14
15
16
# File 'lib/oci/monitoring/models/alarm_history_collection.rb', line 14

def alarm_id
  @alarm_id
end

#entriesArray<OCI::Monitoring::Models::AlarmHistoryEntry>

[Required] The set of history entries retrieved for the alarm.



26
27
28
# File 'lib/oci/monitoring/models/alarm_history_collection.rb', line 26

def entries
  @entries
end

#is_enabledBOOLEAN

[Required] Whether the alarm is enabled.

Example: true

Returns:

  • (BOOLEAN)


21
22
23
# File 'lib/oci/monitoring/models/alarm_history_collection.rb', line 21

def is_enabled
  @is_enabled
end

Class Method Details

.attribute_mapObject

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



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

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

.swagger_typesObject

Attribute type mapping.



40
41
42
43
44
45
46
47
48
# File 'lib/oci/monitoring/models/alarm_history_collection.rb', line 40

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



87
88
89
90
91
92
93
94
# File 'lib/oci/monitoring/models/alarm_history_collection.rb', line 87

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

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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# File 'lib/oci/monitoring/models/alarm_history_collection.rb', line 119

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


99
100
101
# File 'lib/oci/monitoring/models/alarm_history_collection.rb', line 99

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



108
109
110
# File 'lib/oci/monitoring/models/alarm_history_collection.rb', line 108

def hash
  [alarm_id, is_enabled, entries].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



152
153
154
155
156
157
158
159
160
161
# File 'lib/oci/monitoring/models/alarm_history_collection.rb', line 152

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



146
147
148
# File 'lib/oci/monitoring/models/alarm_history_collection.rb', line 146

def to_s
  to_hash.to_s
end