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

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

Overview

A budget.

Constant Summary collapse

RESET_PERIOD_ENUM =
[
  RESET_PERIOD_MONTHLY = 'MONTHLY'.freeze,
  RESET_PERIOD_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
TARGET_TYPE_ENUM =
[
  TARGET_TYPE_COMPARTMENT = 'COMPARTMENT'.freeze,
  TARGET_TYPE_TAG = 'TAG'.freeze,
  TARGET_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 = {}) ⇒ Budget

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

  • :compartment_id (String)

    The value to assign to the #compartment_id property

  • :target_compartment_id (String)

    The value to assign to the #target_compartment_id property

  • :display_name (String)

    The value to assign to the #display_name property

  • :description (String)

    The value to assign to the #description property

  • :amount (Float)

    The value to assign to the #amount property

  • :reset_period (String)

    The value to assign to the #reset_period property

  • :budget_processing_period_start_offset (Integer)

    The value to assign to the #budget_processing_period_start_offset property

  • :target_type (String)

    The value to assign to the #target_type property

  • :targets (Array<String>)

    The value to assign to the #targets property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :alert_rule_count (Integer)

    The value to assign to the #alert_rule_count property

  • :version (Integer)

    The value to assign to the #version property

  • :actual_spend (Float)

    The value to assign to the #actual_spend property

  • :forecasted_spend (Float)

    The value to assign to the #forecasted_spend property

  • :time_spend_computed (DateTime)

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



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
300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'lib/oci/budget/models/budget.rb', line 207

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

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

  self.target_compartment_id = attributes[:'target_compartment_id'] if attributes[:'target_compartment_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.description = attributes[:'description'] if attributes[:'description']

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

  self.reset_period = attributes[:'resetPeriod'] if attributes[:'resetPeriod']

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

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

  self.budget_processing_period_start_offset = attributes[:'budgetProcessingPeriodStartOffset'] if attributes[:'budgetProcessingPeriodStartOffset']

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

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

  self.target_type = attributes[:'targetType'] if attributes[:'targetType']

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

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

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

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

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

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

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

  self.actual_spend = attributes[:'actualSpend'] if attributes[:'actualSpend']

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

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

  self.forecasted_spend = attributes[:'forecastedSpend'] if attributes[:'forecastedSpend']

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

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

  self.time_spend_computed = attributes[:'timeSpendComputed'] if attributes[:'timeSpendComputed']

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

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

  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

#actual_spendFloat

The actual spend in currency for the current budget cycle

Returns:

  • (Float)


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

def actual_spend
  @actual_spend
end

#alert_rule_countInteger

[Required] Total number of alert rules in the budget

Returns:

  • (Integer)


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

def alert_rule_count
  @alert_rule_count
end

#amountFloat

[Required] The amount of the budget expressed in the currency of the customer's rate card.

Returns:

  • (Float)


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

def amount
  @amount
end

#budget_processing_period_start_offsetInteger

The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

Returns:

  • (Integer)


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

def budget_processing_period_start_offset
  @budget_processing_period_start_offset
end

#compartment_idString

[Required] The OCID of the compartment

Returns:

  • (String)


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

def compartment_id
  @compartment_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>>)


123
124
125
# File 'lib/oci/budget/models/budget.rb', line 123

def defined_tags
  @defined_tags
end

#descriptionString

The description of the budget.

Returns:

  • (String)


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

def description
  @description
end

#display_nameString

[Required] The display name of the budget.

Returns:

  • (String)


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

def display_name
  @display_name
end

#forecasted_spendFloat

The forecasted spend in currency by the end of the current budget cycle

Returns:

  • (Float)


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

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


115
116
117
# File 'lib/oci/budget/models/budget.rb', line 115

def freeform_tags
  @freeform_tags
end

#idString

[Required] The OCID of the budget

Returns:

  • (String)


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

def id
  @id
end

#lifecycle_stateString

[Required] The current state of the budget.

Returns:

  • (String)


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

def lifecycle_state
  @lifecycle_state
end

#reset_periodString

[Required] The reset period for the budget.

Returns:

  • (String)


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

def reset_period
  @reset_period
end

#target_compartment_idString

This is DEPRECATED. For backwards compatability, the property will be populated when targetType is "COMPARTMENT" AND targets contains EXACT ONE target compartment ocid. For all other scenarios, this property will be left empty.

Returns:

  • (String)


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

def target_compartment_id
  @target_compartment_id
end

#target_typeString

The type of target on which the budget is applied.

Returns:

  • (String)


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

def target_type
  @target_type
end

#targetsArray<String>

The list of targets on which the budget is applied. If targetType is "COMPARTMENT", targets contains list of compartment OCIDs. If targetType is "TAG", targets contains list of cost tracking tag identifiers in the form of "tagNamespace.tagKey.tagValue".

Returns:

  • (Array<String>)


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

def targets
  @targets
end

#time_createdDateTime

[Required] Time that budget was created

Returns:

  • (DateTime)


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

def time_created
  @time_created
end

#time_spend_computedDateTime

The time that the budget spend was last computed

Returns:

  • (DateTime)


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

def time_spend_computed
  @time_spend_computed
end

#time_updatedDateTime

[Required] Time that budget was updated

Returns:

  • (DateTime)


107
108
109
# File 'lib/oci/budget/models/budget.rb', line 107

def time_updated
  @time_updated
end

#versionInteger

Version of the budget. Starts from 1 and increments by 1.

Returns:

  • (Integer)


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

def version
  @version
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'target_compartment_id': :'targetCompartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'amount': :'amount',
    'reset_period': :'resetPeriod',
    'budget_processing_period_start_offset': :'budgetProcessingPeriodStartOffset',
    'target_type': :'targetType',
    'targets': :'targets',
    'lifecycle_state': :'lifecycleState',
    'alert_rule_count': :'alertRuleCount',
    'version': :'version',
    'actual_spend': :'actualSpend',
    'forecasted_spend': :'forecastedSpend',
    'time_spend_computed': :'timeSpendComputed',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
# File 'lib/oci/budget/models/budget.rb', line 154

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'target_compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'amount': :'Float',
    'reset_period': :'String',
    'budget_processing_period_start_offset': :'Integer',
    'target_type': :'String',
    'targets': :'Array<String>',
    'lifecycle_state': :'String',
    'alert_rule_count': :'Integer',
    'version': :'Integer',
    'actual_spend': :'Float',
    'forecasted_spend': :'Float',
    'time_spend_computed': :'DateTime',
    '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



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
# File 'lib/oci/budget/models/budget.rb', line 360

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    target_compartment_id == other.target_compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    amount == other.amount &&
    reset_period == other.reset_period &&
    budget_processing_period_start_offset == other.budget_processing_period_start_offset &&
    target_type == other.target_type &&
    targets == other.targets &&
    lifecycle_state == other.lifecycle_state &&
    alert_rule_count == other.alert_rule_count &&
    version == other.version &&
    actual_spend == other.actual_spend &&
    forecasted_spend == other.forecasted_spend &&
    time_spend_computed == other.time_spend_computed &&
    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



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
# File 'lib/oci/budget/models/budget.rb', line 409

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


389
390
391
# File 'lib/oci/budget/models/budget.rb', line 389

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



398
399
400
# File 'lib/oci/budget/models/budget.rb', line 398

def hash
  [id, compartment_id, target_compartment_id, display_name, description, amount, reset_period, budget_processing_period_start_offset, target_type, targets, lifecycle_state, alert_rule_count, version, actual_spend, forecasted_spend, time_spend_computed, 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



442
443
444
445
446
447
448
449
450
451
# File 'lib/oci/budget/models/budget.rb', line 442

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



436
437
438
# File 'lib/oci/budget/models/budget.rb', line 436

def to_s
  to_hash.to_s
end