Class: OCI::Budget::Models::CreateAlertRuleDetails

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

Overview

The create alert rule details. This is a batch-create.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_ACTUAL = 'ACTUAL'.freeze,
  TYPE_FORECAST = 'FORECAST'.freeze
].freeze
THRESHOLD_TYPE_ENUM = 
[
  THRESHOLD_TYPE_PERCENTAGE = 'PERCENTAGE'.freeze,
  THRESHOLD_TYPE_ABSOLUTE = 'ABSOLUTE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateAlertRuleDetails

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

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

  • :recipients (String) —

    The value to assign to the #recipients property

  • :message (String) —

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



119
120
121
122
123
124
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
 
# File 'lib/oci/budget/models/create_alert_rule_details.rb', line 119

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

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

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


68
69
70
 
# File 'lib/oci/budget/models/create_alert_rule_details.rb', line 68

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the alert rule.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/budget/models/create_alert_rule_details.rb', line 27

def description
  @description
end

#display_name ⇒ String

The name of the alert rule. Avoid entering confidential information.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/budget/models/create_alert_rule_details.rb', line 23

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


60
61
62
 
# File 'lib/oci/budget/models/create_alert_rule_details.rb', line 60

def freeform_tags
  @freeform_tags
end

#message ⇒ String

The message to be sent to the recipients when the alert rule is triggered.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/budget/models/create_alert_rule_details.rb', line 52

def message
  @message
end

#recipients ⇒ String

The audience that receives the alert when it triggers. An empty string is interpreted as null.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/budget/models/create_alert_rule_details.rb', line 48

def recipients
  @recipients
end

#threshold ⇒ Float

[Required] The threshold for triggering the alert, expressed as a whole number or decimal value. If the thresholdType is ABSOLUTE, the threshold can have at most 12 digits before the decimal point, and up to two digits after the decimal point. If the thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to two digits after the decimal point.

Returns:

  • (Float) 


40
41
42
 
# File 'lib/oci/budget/models/create_alert_rule_details.rb', line 40

def threshold
  @threshold
end

#threshold_type ⇒ String

[Required] The type of threshold.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/budget/models/create_alert_rule_details.rb', line 44

def threshold_type
  @threshold_type
end

#type ⇒ String

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

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/budget/models/create_alert_rule_details.rb', line 33

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/oci/budget/models/create_alert_rule_details.rb', line 71

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'type': :'type',
    'threshold': :'threshold',
    'threshold_type': :'thresholdType',
    'recipients': :'recipients',
    'message': :'message',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/budget/models/create_alert_rule_details.rb', line 88

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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/oci/budget/models/create_alert_rule_details.rb', line 183

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    type == other.type &&
    threshold == other.threshold &&
    threshold_type == other.threshold_type &&
    recipients == other.recipients &&
    message == other.message &&
    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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/oci/budget/models/create_alert_rule_details.rb', line 221

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


201
202
203
 
# File 'lib/oci/budget/models/create_alert_rule_details.rb', line 201

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



210
211
212
 
# File 'lib/oci/budget/models/create_alert_rule_details.rb', line 210

def hash
  [display_name, description, type, threshold, threshold_type, recipients, message, 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



254
255
256
257
258
259
260
261
262
263
 
# File 'lib/oci/budget/models/create_alert_rule_details.rb', line 254

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



248
249
250
 
# File 'lib/oci/budget/models/create_alert_rule_details.rb', line 248

def to_s
  to_hash.to_s
end