Class: OCI::Budget::Models::CostAnomalyMonitor

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

Overview

A CostAnomalyMonitor.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_DEFAULT = 'DEFAULT'.freeze,
  TYPE_CUSTOM = 'CUSTOM'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.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 = {}) ⇒ CostAnomalyMonitor

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

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

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

  self.target_resource_filter = attributes[:'targetResourceFilter'] if attributes[:'targetResourceFilter']

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

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

  self.cost_alert_subscription_map = attributes[:'costAlertSubscriptionMap'] if attributes[:'costAlertSubscriptionMap']

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

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

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

[Required] The OCID of the compartment.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#cost_alert_subscription_map ⇒ OCI::Budget::Models::CostAlertSubscriptionMap

Returns:



59
60
61
 
# File 'lib/oci/budget/models/cost_anomaly_monitor.rb', line 59

def cost_alert_subscription_map
  @cost_alert_subscription_map
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>>) 


75
76
77
 
# File 'lib/oci/budget/models/cost_anomaly_monitor.rb', line 75

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the budget.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/budget/models/cost_anomaly_monitor.rb', line 43

def description
  @description
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>) 


83
84
85
 
# File 'lib/oci/budget/models/cost_anomaly_monitor.rb', line 83

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Cost Anomaly Monitor.

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_details ⇒ String

The current state details of the cost monitor.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the cost monitor.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/budget/models/cost_anomaly_monitor.rb', line 47

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] The name of the cost anomaly monitor. Avoid entering confidential information.

Returns:

  • (String) 


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

def name
  @name
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


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

def system_tags
  @system_tags
end

#target_resource_filter ⇒ OCI::Budget::Models::TargetResourceFilter

This attribute is required.

Returns:



56
57
58
 
# File 'lib/oci/budget/models/cost_anomaly_monitor.rb', line 56

def target_resource_filter
  @target_resource_filter
end

#time_created ⇒ DateTime

[Required] The time that the cost monitor was created.

Returns:

  • (DateTime) 


63
64
65
 
# File 'lib/oci/budget/models/cost_anomaly_monitor.rb', line 63

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The time that the cost monitor was last updated.

Returns:

  • (DateTime) 


67
68
69
 
# File 'lib/oci/budget/models/cost_anomaly_monitor.rb', line 67

def time_updated
  @time_updated
end

#type ⇒ String

Type of cost monitor

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/budget/models/cost_anomaly_monitor.rb', line 95

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'name': :'name',
    'type': :'type',
    'description': :'description',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'target_resource_filter': :'targetResourceFilter',
    'cost_alert_subscription_map': :'costAlertSubscriptionMap',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/budget/models/cost_anomaly_monitor.rb', line 117

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'name': :'String',
    'type': :'String',
    'description': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'target_resource_filter': :'OCI::Budget::Models::TargetResourceFilter',
    'cost_alert_subscription_map': :'OCI::Budget::Models::CostAlertSubscriptionMap',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    '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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/oci/budget/models/cost_anomaly_monitor.rb', line 266

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    name == other.name &&
    type == other.type &&
    description == other.description &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    target_resource_filter == other.target_resource_filter &&
    cost_alert_subscription_map == other.cost_alert_subscription_map &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_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



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

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


289
290
291
 
# File 'lib/oci/budget/models/cost_anomaly_monitor.rb', line 289

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



298
299
300
 
# File 'lib/oci/budget/models/cost_anomaly_monitor.rb', line 298

def hash
  [id, compartment_id, name, type, description, lifecycle_state, lifecycle_details, target_resource_filter, cost_alert_subscription_map, time_created, time_updated, defined_tags, freeform_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



342
343
344
345
346
347
348
349
350
351
 
# File 'lib/oci/budget/models/cost_anomaly_monitor.rb', line 342

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



336
337
338
 
# File 'lib/oci/budget/models/cost_anomaly_monitor.rb', line 336

def to_s
  to_hash.to_s
end