Class: OCI::Costad::Models::CostAnomalyEvent

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/costad/models/cost_anomaly_event.rb

Overview

A CostAnomalyEvent.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
COST_MONITOR_TYPE_ENUM = 
[
  COST_MONITOR_TYPE_DEFAULT = 'DEFAULT'.freeze,
  COST_MONITOR_TYPE_CUSTOM = 'CUSTOM'.freeze,
  COST_MONITOR_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
FEEDBACK_RESPONSE_ENUM = 
[
  FEEDBACK_RESPONSE_ACCURATE_ANOMALY = 'ACCURATE_ANOMALY'.freeze,
  FEEDBACK_RESPONSE_EXPECTED_ANOMALY = 'EXPECTED_ANOMALY'.freeze,
  FEEDBACK_RESPONSE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CostAnomalyEvent

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 190

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

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

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

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

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

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

  self.cost_monitor_name = attributes[:'costMonitorName'] if attributes[:'costMonitorName']

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

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

  self.cost_monitor_type = attributes[:'costMonitorType'] if attributes[:'costMonitorType']

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

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

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

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

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

  self.cost_impact = attributes[:'costImpact'] if attributes[:'costImpact']

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

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

  self.cost_variance_percentage = attributes[:'costVariancePercentage'] if attributes[:'costVariancePercentage']

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

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

  self.root_cause_detail = attributes[:'rootCauseDetail'] if attributes[:'rootCauseDetail']

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

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

  self.feedback_response = attributes[:'feedbackResponse'] if attributes[:'feedbackResponse']

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

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

  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) 


40
41
42
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 40

def compartment_id
  @compartment_id
end

#cost_anomaly_name ⇒ String

[Required] The name of the associated cost monitor.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 36

def cost_anomaly_name
  @cost_anomaly_name
end

#cost_impact ⇒ Float

The cost impact of the detected anomaly.

Returns:

  • (Float) 


68
69
70
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 68

def cost_impact
  @cost_impact
end

#cost_monitor_id ⇒ String

[Required] The OCID of the associated cost monitor.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 48

def cost_monitor_id
  @cost_monitor_id
end

#cost_monitor_name ⇒ String

[Required] The name of the associated cost monitor.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 52

def cost_monitor_name
  @cost_monitor_name
end

#cost_monitor_type ⇒ String

Type of cost monitor

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 56

def cost_monitor_type
  @cost_monitor_type
end

#cost_variance_percentage ⇒ Float

The cost variance percentage of the detected anomaly.

Returns:

  • (Float) 


72
73
74
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 72

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


95
96
97
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 95

def defined_tags
  @defined_tags
end

#feedback_response ⇒ String

The feedback response for the cost anomaly event.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 79

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


103
104
105
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 103

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Cost Anomaly Event.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 32

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the cost anomaly event.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 44

def lifecycle_state
  @lifecycle_state
end

#root_cause_detail ⇒ OCI::Costad::Models::RootCauseDetail

Returns:



75
76
77
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 75

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


112
113
114
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 112

def system_tags
  @system_tags
end

#target_resource_filter ⇒ OCI::Costad::Models::TargetResourceFilter

This attribute is required.

Returns:



60
61
62
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 60

def target_resource_filter
  @target_resource_filter
end

#time_anomaly_event_date ⇒ DateTime

[Required] The event date of the anomaly event.

Returns:

  • (DateTime) 


64
65
66
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 64

def time_anomaly_event_date
  @time_anomaly_event_date
end

#time_created ⇒ DateTime

[Required] The created time of the cost anomaly event.

Returns:

  • (DateTime) 


83
84
85
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 83

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The updated time of the cost anomaly event.

Returns:

  • (DateTime) 


87
88
89
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 87

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 115

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'cost_anomaly_name': :'costAnomalyName',
    'compartment_id': :'compartmentId',
    'lifecycle_state': :'lifecycleState',
    'cost_monitor_id': :'costMonitorId',
    'cost_monitor_name': :'costMonitorName',
    'cost_monitor_type': :'costMonitorType',
    'target_resource_filter': :'targetResourceFilter',
    'time_anomaly_event_date': :'timeAnomalyEventDate',
    'cost_impact': :'costImpact',
    'cost_variance_percentage': :'costVariancePercentage',
    'root_cause_detail': :'rootCauseDetail',
    'feedback_response': :'feedbackResponse',
    '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.



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 141

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'cost_anomaly_name': :'String',
    'compartment_id': :'String',
    'lifecycle_state': :'String',
    'cost_monitor_id': :'String',
    'cost_monitor_name': :'String',
    'cost_monitor_type': :'String',
    'target_resource_filter': :'OCI::Costad::Models::TargetResourceFilter',
    'time_anomaly_event_date': :'DateTime',
    'cost_impact': :'Float',
    'cost_variance_percentage': :'Float',
    'root_cause_detail': :'OCI::Costad::Models::RootCauseDetail',
    'feedback_response': :'String',
    '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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 347

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

  self.class == other.class &&
    id == other.id &&
    cost_anomaly_name == other.cost_anomaly_name &&
    compartment_id == other.compartment_id &&
    lifecycle_state == other.lifecycle_state &&
    cost_monitor_id == other.cost_monitor_id &&
    cost_monitor_name == other.cost_monitor_name &&
    cost_monitor_type == other.cost_monitor_type &&
    target_resource_filter == other.target_resource_filter &&
    time_anomaly_event_date == other.time_anomaly_event_date &&
    cost_impact == other.cost_impact &&
    cost_variance_percentage == other.cost_variance_percentage &&
    root_cause_detail == other.root_cause_detail &&
    feedback_response == other.feedback_response &&
    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



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 394

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


374
375
376
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 374

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



383
384
385
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 383

def hash
  [id, cost_anomaly_name, compartment_id, lifecycle_state, cost_monitor_id, cost_monitor_name, cost_monitor_type, target_resource_filter, time_anomaly_event_date, cost_impact, cost_variance_percentage, root_cause_detail, feedback_response, 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



427
428
429
430
431
432
433
434
435
436
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 427

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



421
422
423
 
# File 'lib/oci/costad/models/cost_anomaly_event.rb', line 421

def to_s
  to_hash.to_s
end