Class: OCI::Budget::Models::AlertRule

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/budget/models/alert_rule.rb

Overview

The alert rule.

Constant Summary collapse

TYPE_ENUM =
[
  TYPE_ACTUAL = 'ACTUAL'.freeze,
  TYPE_FORECAST = 'FORECAST'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
THRESHOLD_TYPE_ENUM =
[
  THRESHOLD_TYPE_PERCENTAGE = 'PERCENTAGE'.freeze,
  THRESHOLD_TYPE_ABSOLUTE = 'ABSOLUTE'.freeze,
  THRESHOLD_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AlertRule

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

  • :budget_id (String)

    The value to assign to the #budget_id property

  • :display_name (String)

    The value to assign to the #display_name property

  • :type (String)

    The value to assign to the #type property

  • :threshold (Float)

    The value to assign to the #threshold property

  • :threshold_type (String)

    The value to assign to the #threshold_type property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :message (String)

    The value to assign to the #message property

  • :description (String)

    The value to assign to the #description property

  • :version (Integer)

    The value to assign to the #version property

  • :recipients (String)

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

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



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
# File 'lib/oci/budget/models/alert_rule.rb', line 169

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

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

  self.budget_id = attributes[:'budget_id'] if attributes[:'budget_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.type = attributes[:'type'] if attributes[:'type']

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

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

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

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

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

#budget_idString

[Required] The OCID of the budget

Returns:

  • (String)


35
36
37
# File 'lib/oci/budget/models/alert_rule.rb', line 35

def budget_id
  @budget_id
end

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


100
101
102
# File 'lib/oci/budget/models/alert_rule.rb', line 100

def defined_tags
  @defined_tags
end

#descriptionString

The description of the alert rule.

Returns:

  • (String)


66
67
68
# File 'lib/oci/budget/models/alert_rule.rb', line 66

def description
  @description
end

#display_nameString

[Required] The name of the alert rule.

Returns:

  • (String)


39
40
41
# File 'lib/oci/budget/models/alert_rule.rb', line 39

def display_name
  @display_name
end

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


92
93
94
# File 'lib/oci/budget/models/alert_rule.rb', line 92

def freeform_tags
  @freeform_tags
end

#idString

[Required] The OCID of the alert rule

Returns:

  • (String)


31
32
33
# File 'lib/oci/budget/models/alert_rule.rb', line 31

def id
  @id
end

#lifecycle_stateString

[Required] The current state of the alert rule.

Returns:

  • (String)


58
59
60
# File 'lib/oci/budget/models/alert_rule.rb', line 58

def lifecycle_state
  @lifecycle_state
end

#messageString

Custom message sent when alert is triggered

Returns:

  • (String)


62
63
64
# File 'lib/oci/budget/models/alert_rule.rb', line 62

def message
  @message
end

#recipientsString

[Required] Delimited list of email addresses to receive the alert when it triggers. Delimiter character can be comma, space, TAB, or semicolon.

Returns:

  • (String)


76
77
78
# File 'lib/oci/budget/models/alert_rule.rb', line 76

def recipients
  @recipients
end

#thresholdFloat

[Required] The threshold for triggering the alert. If thresholdType is PERCENTAGE, the maximum value is 10000.

Returns:

  • (Float)


50
51
52
# File 'lib/oci/budget/models/alert_rule.rb', line 50

def threshold
  @threshold
end

#threshold_typeString

[Required] The type of threshold.

Returns:

  • (String)


54
55
56
# File 'lib/oci/budget/models/alert_rule.rb', line 54

def threshold_type
  @threshold_type
end

#time_createdDateTime

[Required] Time budget was created

Returns:

  • (DateTime)


80
81
82
# File 'lib/oci/budget/models/alert_rule.rb', line 80

def time_created
  @time_created
end

#time_updatedDateTime

[Required] Time budget was updated

Returns:

  • (DateTime)


84
85
86
# File 'lib/oci/budget/models/alert_rule.rb', line 84

def time_updated
  @time_updated
end

#typeString

[Required] The type of alert. Valid values are ACTUAL (the alert will trigger based on actual usage) or FORECAST (the alert will trigger based on predicted usage).

Returns:

  • (String)


45
46
47
# File 'lib/oci/budget/models/alert_rule.rb', line 45

def type
  @type
end

#versionInteger

Version of the alert rule. Starts from 1 and increments by 1.

Returns:

  • (Integer)


70
71
72
# File 'lib/oci/budget/models/alert_rule.rb', line 70

def version
  @version
end

Class Method Details

.attribute_mapObject

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



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'lib/oci/budget/models/alert_rule.rb', line 103

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'budget_id': :'budgetId',
    'display_name': :'displayName',
    'type': :'type',
    'threshold': :'threshold',
    'threshold_type': :'thresholdType',
    'lifecycle_state': :'lifecycleState',
    'message': :'message',
    'description': :'description',
    'version': :'version',
    'recipients': :'recipients',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# File 'lib/oci/budget/models/alert_rule.rb', line 126

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'budget_id': :'String',
    'display_name': :'String',
    'type': :'String',
    'threshold': :'Float',
    'threshold_type': :'String',
    'lifecycle_state': :'String',
    'message': :'String',
    'description': :'String',
    'version': :'Integer',
    'recipients': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    '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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
# File 'lib/oci/budget/models/alert_rule.rb', line 284

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

  self.class == other.class &&
    id == other.id &&
    budget_id == other.budget_id &&
    display_name == other.display_name &&
    type == other.type &&
    threshold == other.threshold &&
    threshold_type == other.threshold_type &&
    lifecycle_state == other.lifecycle_state &&
    message == other.message &&
    description == other.description &&
    version == other.version &&
    recipients == other.recipients &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
# File 'lib/oci/budget/models/alert_rule.rb', line 328

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


308
309
310
# File 'lib/oci/budget/models/alert_rule.rb', line 308

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



317
318
319
# File 'lib/oci/budget/models/alert_rule.rb', line 317

def hash
  [id, budget_id, display_name, type, threshold, threshold_type, lifecycle_state, message, description, version, recipients, time_created, time_updated, freeform_tags, defined_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



361
362
363
364
365
366
367
368
369
370
# File 'lib/oci/budget/models/alert_rule.rb', line 361

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



355
356
357
# File 'lib/oci/budget/models/alert_rule.rb', line 355

def to_s
  to_hash.to_s
end