Class: OCI::Budget::Models::BudgetSummary
- Inherits:
-
Object
- Object
- OCI::Budget::Models::BudgetSummary
- Defined in:
- lib/oci/budget/models/budget_summary.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
- PROCESSING_PERIOD_TYPE_ENUM =
[ PROCESSING_PERIOD_TYPE_INVOICE = 'INVOICE'.freeze, PROCESSING_PERIOD_TYPE_MONTH = 'MONTH'.freeze, PROCESSING_PERIOD_TYPE_SINGLE_USE = 'SINGLE_USE'.freeze, PROCESSING_PERIOD_TYPE_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
-
#actual_spend ⇒ Float
The actual spend in currency for the current budget cycle.
-
#alert_rule_count ⇒ Integer
[Required] The total number of alert rules in the budget.
-
#amount ⇒ Float
[Required] The amount of the budget, expressed in the currency of the customer's rate card.
-
#budget_processing_period_start_offset ⇒ Integer
The number of days offset from the first day of the month, at which the budget processing period starts.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
The description of the budget.
-
#display_name ⇒ String
[Required] The display name of the budget.
-
#end_date ⇒ DateTime
The time when the one-time budget concludes.
-
#forecasted_spend ⇒ Float
The forecasted spend in currency by the end of the current budget cycle.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the budget.
-
#lifecycle_state ⇒ String
[Required] The current state of the budget.
-
#processing_period_type ⇒ String
The type of the budget processing period.
-
#reset_period ⇒ String
[Required] The reset period for the budget.
-
#start_date ⇒ DateTime
The date when the one-time budget begins.
-
#target_compartment_id ⇒ String
This is DEPRECATED.
-
#target_type ⇒ String
The type of target on which the budget is applied.
-
#targets ⇒ Array<String>
The list of targets on which the budget is applied.
-
#time_created ⇒ DateTime
[Required] The time the budget was created.
-
#time_spend_computed ⇒ DateTime
The time the budget spend was last computed.
-
#time_updated ⇒ DateTime
[Required] The time the budget was updated.
-
#version ⇒ Integer
The version of the budget.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ BudgetSummary
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ BudgetSummary
Initializes the object
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 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 |
# File 'lib/oci/budget/models/budget_summary.rb', line 237 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.processing_period_type = attributes[:'processingPeriodType'] if attributes[:'processingPeriodType'] raise 'You cannot provide both :processingPeriodType and :processing_period_type' if attributes.key?(:'processingPeriodType') && attributes.key?(:'processing_period_type') self.processing_period_type = attributes[:'processing_period_type'] if attributes[:'processing_period_type'] self.start_date = attributes[:'startDate'] if attributes[:'startDate'] raise 'You cannot provide both :startDate and :start_date' if attributes.key?(:'startDate') && attributes.key?(:'start_date') self.start_date = attributes[:'start_date'] if attributes[:'start_date'] self.end_date = attributes[:'endDate'] if attributes[:'endDate'] raise 'You cannot provide both :endDate and :end_date' if attributes.key?(:'endDate') && attributes.key?(:'end_date') self.end_date = attributes[:'end_date'] if attributes[:'end_date'] 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. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] end |
Instance Attribute Details
#actual_spend ⇒ Float
The actual spend in currency for the current budget cycle.
112 113 114 |
# File 'lib/oci/budget/models/budget_summary.rb', line 112 def actual_spend @actual_spend end |
#alert_rule_count ⇒ Integer
[Required] The total number of alert rules in the budget.
104 105 106 |
# File 'lib/oci/budget/models/budget_summary.rb', line 104 def alert_rule_count @alert_rule_count end |
#amount ⇒ Float
[Required] The amount of the budget, expressed in the currency of the customer's rate card.
62 63 64 |
# File 'lib/oci/budget/models/budget_summary.rb', line 62 def amount @amount end |
#budget_processing_period_start_offset ⇒ Integer
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.
71 72 73 |
# File 'lib/oci/budget/models/budget_summary.rb', line 71 def budget_processing_period_start_offset @budget_processing_period_start_offset end |
#compartment_id ⇒ String
[Required] The OCID of the compartment.
42 43 44 |
# File 'lib/oci/budget/models/budget_summary.rb', line 42 def compartment_id @compartment_id 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\"}}
144 145 146 |
# File 'lib/oci/budget/models/budget_summary.rb', line 144 def @defined_tags end |
#description ⇒ String
The description of the budget.
57 58 59 |
# File 'lib/oci/budget/models/budget_summary.rb', line 57 def description @description end |
#display_name ⇒ String
[Required] The display name of the budget. Avoid entering confidential information.
53 54 55 |
# File 'lib/oci/budget/models/budget_summary.rb', line 53 def display_name @display_name end |
#end_date ⇒ DateTime
The time when the one-time budget concludes. For example, - 2023-03-23
. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.
84 85 86 |
# File 'lib/oci/budget/models/budget_summary.rb', line 84 def end_date @end_date end |
#forecasted_spend ⇒ Float
The forecasted spend in currency by the end of the current budget cycle.
116 117 118 |
# File 'lib/oci/budget/models/budget_summary.rb', line 116 def forecasted_spend @forecasted_spend 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\"}
136 137 138 |
# File 'lib/oci/budget/models/budget_summary.rb', line 136 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the budget.
38 39 40 |
# File 'lib/oci/budget/models/budget_summary.rb', line 38 def id @id end |
#lifecycle_state ⇒ String
[Required] The current state of the budget.
100 101 102 |
# File 'lib/oci/budget/models/budget_summary.rb', line 100 def lifecycle_state @lifecycle_state end |
#processing_period_type ⇒ String
The type of the budget processing period. Valid values are INVOICE, MONTH, and SINGLE_USE.
76 77 78 |
# File 'lib/oci/budget/models/budget_summary.rb', line 76 def processing_period_type @processing_period_type end |
#reset_period ⇒ String
[Required] The reset period for the budget.
67 68 69 |
# File 'lib/oci/budget/models/budget_summary.rb', line 67 def reset_period @reset_period end |
#start_date ⇒ DateTime
The date when the one-time budget begins. For example, 2023-03-23
. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.
80 81 82 |
# File 'lib/oci/budget/models/budget_summary.rb', line 80 def start_date @start_date end |
#target_compartment_id ⇒ String
This is DEPRECATED. For backwards compatability, the property is populated when the targetType is "COMPARTMENT", and the targets contain the specific target compartment OCID. For all other scenarios, this property is left empty.
49 50 51 |
# File 'lib/oci/budget/models/budget_summary.rb', line 49 def target_compartment_id @target_compartment_id end |
#target_type ⇒ String
The type of target on which the budget is applied.
89 90 91 |
# File 'lib/oci/budget/models/budget_summary.rb', line 89 def target_type @target_type end |
#targets ⇒ Array<String>
The list of targets on which the budget is applied. If the targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If the targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "tagNamespace.tagKey.tagValue".
96 97 98 |
# File 'lib/oci/budget/models/budget_summary.rb', line 96 def targets @targets end |
#time_created ⇒ DateTime
[Required] The time the budget was created.
124 125 126 |
# File 'lib/oci/budget/models/budget_summary.rb', line 124 def time_created @time_created end |
#time_spend_computed ⇒ DateTime
The time the budget spend was last computed.
120 121 122 |
# File 'lib/oci/budget/models/budget_summary.rb', line 120 def time_spend_computed @time_spend_computed end |
#time_updated ⇒ DateTime
[Required] The time the budget was updated.
128 129 130 |
# File 'lib/oci/budget/models/budget_summary.rb', line 128 def time_updated @time_updated end |
#version ⇒ Integer
The version of the budget. Starts from 1 and increments by 1.
108 109 110 |
# File 'lib/oci/budget/models/budget_summary.rb', line 108 def version @version end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/oci/budget/models/budget_summary.rb', line 147 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', 'processing_period_type': :'processingPeriodType', 'start_date': :'startDate', 'end_date': :'endDate', '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_types ⇒ Object
Attribute type mapping.
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 |
# File 'lib/oci/budget/models/budget_summary.rb', line 178 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', 'processing_period_type': :'String', 'start_date': :'DateTime', 'end_date': :'DateTime', '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.
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 |
# File 'lib/oci/budget/models/budget_summary.rb', line 421 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 && processing_period_type == other.processing_period_type && start_date == other.start_date && end_date == other.end_date && 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 && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 |
# File 'lib/oci/budget/models/budget_summary.rb', line 473 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
453 454 455 |
# File 'lib/oci/budget/models/budget_summary.rb', line 453 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
462 463 464 |
# File 'lib/oci/budget/models/budget_summary.rb', line 462 def hash [id, compartment_id, target_compartment_id, display_name, description, amount, reset_period, budget_processing_period_start_offset, processing_period_type, start_date, end_date, target_type, targets, lifecycle_state, alert_rule_count, version, actual_spend, forecasted_spend, time_spend_computed, time_created, time_updated, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
506 507 508 509 510 511 512 513 514 515 |
# File 'lib/oci/budget/models/budget_summary.rb', line 506 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
500 501 502 |
# File 'lib/oci/budget/models/budget_summary.rb', line 500 def to_s to_hash.to_s end |