Class: OCI::DemandSignal::Models::UpdateOccMetricAlarmDetails

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

Overview

Fields that can be updated for OccMetricAlarm.

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
].freeze
THRESHOLD_TYPE_ENUM = 
[
  THRESHOLD_TYPE_PERCENTAGE = 'PERCENTAGE'.freeze,
  THRESHOLD_TYPE_UNITS = 'UNITS'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateOccMetricAlarmDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state 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

  • :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



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/demand_signal/models/update_occ_metric_alarm_details.rb', line 125

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.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.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.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.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']
end

Instance Attribute Details

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


71
72
73
 
# File 'lib/oci/demand_signal/models/update_occ_metric_alarm_details.rb', line 71

def defined_tags
  @defined_tags
end

#description ⇒ String

Optional description for the alarm.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/demand_signal/models/update_occ_metric_alarm_details.rb', line 31

def description
  @description
end

#display_name ⇒ String

Human-readable name for the alarm.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/demand_signal/models/update_occ_metric_alarm_details.rb', line 27

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


63
64
65
 
# File 'lib/oci/demand_signal/models/update_occ_metric_alarm_details.rb', line 63

def freeform_tags
  @freeform_tags
end

#frequency ⇒ String

Frequency at which notifications should be sent.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/demand_signal/models/update_occ_metric_alarm_details.rb', line 47

def frequency
  @frequency
end

#is_active ⇒ BOOLEAN

Alarm active status.

Returns:

  • (BOOLEAN) 


39
40
41
 
# File 'lib/oci/demand_signal/models/update_occ_metric_alarm_details.rb', line 39

def is_active
  @is_active
end

#lifecycle_state ⇒ String

The current lifecycle state of the resource.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/demand_signal/models/update_occ_metric_alarm_details.rb', line 35

def lifecycle_state
  @lifecycle_state
end

#subscribers ⇒ Array<String>

List of topic OCIDs for notifications.

Returns:

  • (Array<String>) 


43
44
45
 
# File 'lib/oci/demand_signal/models/update_occ_metric_alarm_details.rb', line 43

def subscribers
  @subscribers
end

#threshold ⇒ Integer

Threshold at which alarm must be triggered.

Returns:

  • (Integer) 


51
52
53
 
# File 'lib/oci/demand_signal/models/update_occ_metric_alarm_details.rb', line 51

def threshold
  @threshold
end

#threshold_type ⇒ String

Units in which threshold is being stored.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/demand_signal/models/update_occ_metric_alarm_details.rb', line 55

def threshold_type
  @threshold_type
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/demand_signal/models/update_occ_metric_alarm_details.rb', line 74

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'lifecycle_state': :'lifecycleState',
    'is_active': :'isActive',
    'subscribers': :'subscribers',
    'frequency': :'frequency',
    'threshold': :'threshold',
    'threshold_type': :'thresholdType',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/demand_signal/models/update_occ_metric_alarm_details.rb', line 92

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'lifecycle_state': :'String',
    'is_active': :'BOOLEAN',
    'subscribers': :'Array<String>',
    'frequency': :'String',
    'threshold': :'Integer',
    'threshold_type': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/oci/demand_signal/models/update_occ_metric_alarm_details.rb', line 199

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    lifecycle_state == other.lifecycle_state &&
    is_active == other.is_active &&
    subscribers == other.subscribers &&
    frequency == other.frequency &&
    threshold == other.threshold &&
    threshold_type == other.threshold_type &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/oci/demand_signal/models/update_occ_metric_alarm_details.rb', line 238

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


218
219
220
 
# File 'lib/oci/demand_signal/models/update_occ_metric_alarm_details.rb', line 218

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



227
228
229
 
# File 'lib/oci/demand_signal/models/update_occ_metric_alarm_details.rb', line 227

def hash
  [display_name, description, lifecycle_state, is_active, subscribers, frequency, threshold, threshold_type, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



271
272
273
274
275
276
277
278
279
280
 
# File 'lib/oci/demand_signal/models/update_occ_metric_alarm_details.rb', line 271

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



265
266
267
 
# File 'lib/oci/demand_signal/models/update_occ_metric_alarm_details.rb', line 265

def to_s
  to_hash.to_s
end