Class: OCI::Costad::Models::CostAnomalyEventSummary

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

Overview

A CostAnomalyEvent.

Constant Summary collapse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CostAnomalyEventSummary

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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/oci/costad/models/cost_anomaly_event_summary.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.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.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.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.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.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.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.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) 


28
29
30
 
# File 'lib/oci/costad/models/cost_anomaly_event_summary.rb', line 28

def compartment_id
  @compartment_id
end

#cost_anomaly_name ⇒ String

The name of the associated cost Anomaly.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/costad/models/cost_anomaly_event_summary.rb', line 24

def cost_anomaly_name
  @cost_anomaly_name
end

#cost_impact ⇒ Float

The cost impact of the detected anomaly.

Returns:

  • (Float) 


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

def cost_impact
  @cost_impact
end

#cost_monitor_id ⇒ String

[Required] The OCID of the associated cost monitor.

Returns:

  • (String) 


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

def cost_monitor_id
  @cost_monitor_id
end

#cost_monitor_name ⇒ String

[Required] The name of the associated cost monitor.

Returns:

  • (String) 


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

def cost_monitor_name
  @cost_monitor_name
end

#cost_monitor_type ⇒ String

Type of cost monitor

Returns:

  • (String) 


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

def cost_monitor_type
  @cost_monitor_type
end

#cost_variance_percentage ⇒ Float

The cost variance percentage of the detected anomaly.

Returns:

  • (Float) 


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

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


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

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


80
81
82
 
# File 'lib/oci/costad/models/cost_anomaly_event_summary.rb', line 80

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Cost Anomaly Event.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/costad/models/cost_anomaly_event_summary.rb', line 20

def id
  @id
end

#lifecycle_state ⇒ String

The current state of the cost anomaly event.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

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

This attribute is required.

Returns:



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

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


89
90
91
 
# File 'lib/oci/costad/models/cost_anomaly_event_summary.rb', line 89

def system_tags
  @system_tags
end

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

This attribute is required.

Returns:



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

def target_resource_filter
  @target_resource_filter
end

#time_anomaly_event_date ⇒ DateTime

[Required] The event date of the anomaly event.

Returns:

  • (DateTime) 


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

def time_anomaly_event_date
  @time_anomaly_event_date
end

Class Method Details

.attribute_map ⇒ Object

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/costad/models/cost_anomaly_event_summary.rb', line 92

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'cost_anomaly_name': :'costAnomalyName',
    'compartment_id': :'compartmentId',
    'cost_monitor_id': :'costMonitorId',
    'cost_monitor_name': :'costMonitorName',
    'cost_monitor_type': :'costMonitorType',
    'lifecycle_state': :'lifecycleState',
    'target_resource_filter': :'targetResourceFilter',
    'root_cause_detail': :'rootCauseDetail',
    'time_anomaly_event_date': :'timeAnomalyEventDate',
    'cost_impact': :'costImpact',
    'cost_variance_percentage': :'costVariancePercentage',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/oci/costad/models/cost_anomaly_event_summary.rb', line 271

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 &&
    cost_monitor_id == other.cost_monitor_id &&
    cost_monitor_name == other.cost_monitor_name &&
    cost_monitor_type == other.cost_monitor_type &&
    lifecycle_state == other.lifecycle_state &&
    target_resource_filter == other.target_resource_filter &&
    root_cause_detail == other.root_cause_detail &&
    time_anomaly_event_date == other.time_anomaly_event_date &&
    cost_impact == other.cost_impact &&
    cost_variance_percentage == other.cost_variance_percentage &&
    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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/oci/costad/models/cost_anomaly_event_summary.rb', line 315

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


295
296
297
 
# File 'lib/oci/costad/models/cost_anomaly_event_summary.rb', line 295

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



304
305
306
 
# File 'lib/oci/costad/models/cost_anomaly_event_summary.rb', line 304

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



348
349
350
351
352
353
354
355
356
357
 
# File 'lib/oci/costad/models/cost_anomaly_event_summary.rb', line 348

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



342
343
344
 
# File 'lib/oci/costad/models/cost_anomaly_event_summary.rb', line 342

def to_s
  to_hash.to_s
end