Class: OCI::DemandSignal::Models::CreateOccMetricAlarmDetails

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

Overview

Payload for creating an 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 = {}) ⇒ CreateOccMetricAlarmDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
 
# File 'lib/oci/demand_signal/models/create_occ_metric_alarm_details.rb', line 139

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

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

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


79
80
81
 
# File 'lib/oci/demand_signal/models/create_occ_metric_alarm_details.rb', line 79

def defined_tags
  @defined_tags
end

#description ⇒ String

Optional description for the alarm.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

[Required] Human-readable name for the alarm.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/demand_signal/models/create_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>) 


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

def freeform_tags
  @freeform_tags
end

#frequency ⇒ String

[Required] Frequency at which notifications should be sent.

Returns:

  • (String) 


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

def frequency
  @frequency
end

#is_active ⇒ BOOLEAN

[Required] Alarm active status.

Returns:

  • (BOOLEAN) 


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

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/create_occ_metric_alarm_details.rb', line 35

def lifecycle_state
  @lifecycle_state
end

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

This attribute is required.

Returns:



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

def resource_configuration
  @resource_configuration
end

#subscribers ⇒ Array<String>

List of topic OCIDs for notifications.

Returns:

  • (Array<String>) 


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

def subscribers
  @subscribers
end

#threshold ⇒ Integer

[Required] Threshold at which alarm must be triggered.

Returns:

  • (Integer) 


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

def threshold
  @threshold
end

#threshold_type ⇒ String

Units in which threshold is being stored.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/demand_signal/models/create_occ_metric_alarm_details.rb', line 59

def threshold_type
  @threshold_type
end

Class Method Details

.attribute_map ⇒ Object

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/demand_signal/models/create_occ_metric_alarm_details.rb', line 82

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    '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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/demand_signal/models/create_occ_metric_alarm_details.rb', line 102

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    '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>>'
    # 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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/oci/demand_signal/models/create_occ_metric_alarm_details.rb', line 225

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    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
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



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

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


246
247
248
 
# File 'lib/oci/demand_signal/models/create_occ_metric_alarm_details.rb', line 246

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



255
256
257
 
# File 'lib/oci/demand_signal/models/create_occ_metric_alarm_details.rb', line 255

def hash
  [display_name, description, lifecycle_state, compartment_id, is_active, subscribers, frequency, threshold, threshold_type, resource_configuration, 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



299
300
301
302
303
304
305
306
307
308
 
# File 'lib/oci/demand_signal/models/create_occ_metric_alarm_details.rb', line 299

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



293
294
295
 
# File 'lib/oci/demand_signal/models/create_occ_metric_alarm_details.rb', line 293

def to_s
  to_hash.to_s
end