Class: OCI::DemandSignal::Models::OccMetricAlarm

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

Overview

OccMetricAlarm represents an alarm configuration for OCI Control Center metric.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
FREQUENCY_ENUM = 
[
  FREQUENCY_DAILY = 'DAILY'.freeze,
  FREQUENCY_WEEKLY = 'WEEKLY'.freeze,
  FREQUENCY_MONTHLY = 'MONTHLY'.freeze,
  FREQUENCY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
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 = {}) ⇒ OccMetricAlarm

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



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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 181

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

Compartment OCID in which the alarm is created.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 62

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>>) 


102
103
104
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 102

def defined_tags
  @defined_tags
end

#description ⇒ String

Optional description for the alarm.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 46

def description
  @description
end

#display_name ⇒ String

[Required] Human-readable name for the alarm.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 42

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>) 


94
95
96
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 94

def freeform_tags
  @freeform_tags
end

#frequency ⇒ String

[Required] Frequency at which notifications should be sent.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 74

def frequency
  @frequency
end

#id ⇒ String

[Required] Unique OCID for this alarm configuration.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 38

def id
  @id
end

#is_active ⇒ BOOLEAN

[Required] Alarm active status.

Returns:

  • (BOOLEAN) 


66
67
68
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 66

def is_active
  @is_active
end

#lifecycle_state ⇒ String

[Required] The current lifecycle state of the resource.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 58

def lifecycle_state
  @lifecycle_state
end

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

This attribute is required.

Returns:



86
87
88
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 86

def resource_configuration
  @resource_configuration
end

#subscribers ⇒ Array<String>

[Required] List of topic OCIDs for notifications.

Returns:

  • (Array<String>) 


70
71
72
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 70

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>>) 


109
110
111
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 109

def system_tags
  @system_tags
end

#threshold ⇒ Integer

[Required] Threshold at which alarm must be triggered.

Returns:

  • (Integer) 


78
79
80
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 78

def threshold
  @threshold
end

#threshold_type ⇒ String

[Required] Units in which threshold is being stored.

Returns:

  • (String) 


82
83
84
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 82

def threshold_type
  @threshold_type
end

#time_created ⇒ DateTime

[Required] Creation timestamp (RFC 3339).

Returns:

  • (DateTime) 


50
51
52
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 50

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] Last update timestamp (RFC 3339).

Returns:

  • (DateTime) 


54
55
56
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 54

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 112

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.



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

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



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

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



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 355

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


335
336
337
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 335

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



344
345
346
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 344

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



388
389
390
391
392
393
394
395
396
397
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 388

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



382
383
384
 
# File 'lib/oci/demand_signal/models/occ_metric_alarm.rb', line 382

def to_s
  to_hash.to_s
end