Class: OCI::DemandSignal::Models::OccMetricAlarmSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/demand_signal/models/occ_metric_alarm_summary.rb

Overview

Summary of OccMetricAlarm.

Constant Summary collapse

THRESHOLD_TYPE_ENUM = 
[
  THRESHOLD_TYPE_PERCENTAGE = 'PERCENTAGE'.freeze,
  THRESHOLD_TYPE_UNITS = 'UNITS'.freeze,
  THRESHOLD_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OccMetricAlarmSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :is_active (BOOLEAN) —

    The value to assign to the #is_active property

  • :subscribers (Array<String>) —

    The value to assign to the #subscribers property

  • :frequency (String) —

    The value to assign to the #frequency property

  • :threshold (Integer) —

    The value to assign to the #threshold property

  • :threshold_type (String) —

    The value to assign to the #threshold_type property

  • :resource_configuration (OCI::DemandSignal::Models::BaseResourceConfiguration) —

    The value to assign to the #resource_configuration property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 163

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.is_active = attributes[:'isActive'] unless attributes[:'isActive'].nil?

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

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

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

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

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

  self.threshold_type = attributes[:'thresholdType'] if attributes[:'thresholdType']

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

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

  self.resource_configuration = attributes[:'resourceConfiguration'] if attributes[:'resourceConfiguration']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] Compartment OCID in which the alarm is created.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 44

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


84
85
86
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 84

def defined_tags
  @defined_tags
end

#description ⇒ String

Optional description for the alarm.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 28

def description
  @description
end

#display_name ⇒ String

[Required] Human-readable name for the alarm.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 24

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


76
77
78
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 76

def freeform_tags
  @freeform_tags
end

#frequency ⇒ String

[Required] Frequency at which notifications should be sent.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 56

def frequency
  @frequency
end

#id ⇒ String

[Required] Unique OCID for this alarm configuration.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 20

def id
  @id
end

#is_active ⇒ BOOLEAN

[Required] Alarm active status.

Returns:

  • (BOOLEAN) 


48
49
50
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 48

def is_active
  @is_active
end

#lifecycle_state ⇒ String

[Required] The current lifecycle state of the resource.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 40

def lifecycle_state
  @lifecycle_state
end

#resource_configuration ⇒ OCI::DemandSignal::Models::BaseResourceConfiguration

This attribute is required.

Returns:



68
69
70
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 68

def resource_configuration
  @resource_configuration
end

#subscribers ⇒ Array<String>

[Required] List of topic OCIDs for notifications.

Returns:

  • (Array<String>) 


52
53
54
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 52

def subscribers
  @subscribers
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


91
92
93
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 91

def system_tags
  @system_tags
end

#threshold ⇒ Integer

[Required] Threshold at which alarm must be triggered.

Returns:

  • (Integer) 


60
61
62
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 60

def threshold
  @threshold
end

#threshold_type ⇒ String

Units in which threshold is being stored.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 64

def threshold_type
  @threshold_type
end

#time_created ⇒ DateTime

[Required] Creation timestamp (RFC 3339).

Returns:

  • (DateTime) 


32
33
34
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 32

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] Last update timestamp (RFC 3339).

Returns:

  • (DateTime) 


36
37
38
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 36

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 94

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'compartment_id': :'compartmentId',
    'is_active': :'isActive',
    'subscribers': :'subscribers',
    'frequency': :'frequency',
    'threshold': :'threshold',
    'threshold_type': :'thresholdType',
    'resource_configuration': :'resourceConfiguration',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'compartment_id': :'String',
    'is_active': :'BOOLEAN',
    'subscribers': :'Array<String>',
    'frequency': :'String',
    'threshold': :'Integer',
    'threshold_type': :'String',
    'resource_configuration': :'OCI::DemandSignal::Models::BaseResourceConfiguration',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 266

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    compartment_id == other.compartment_id &&
    is_active == other.is_active &&
    subscribers == other.subscribers &&
    frequency == other.frequency &&
    threshold == other.threshold &&
    threshold_type == other.threshold_type &&
    resource_configuration == other.resource_configuration &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 311

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


291
292
293
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 291

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



300
301
302
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 300

def hash
  [id, display_name, description, time_created, time_updated, lifecycle_state, compartment_id, is_active, subscribers, frequency, threshold, threshold_type, resource_configuration, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



344
345
346
347
348
349
350
351
352
353
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 344

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



338
339
340
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm_summary.rb', line 338

def to_s
  to_hash.to_s
end