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
- 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] 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.
-
#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.
-
#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.
-
#reset_period ⇒ String
[Required] The reset period for the budget.
-
#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] Time budget was created.
-
#time_spend_computed ⇒ DateTime
Time budget spend was last computed.
-
#time_updated ⇒ DateTime
[Required] Time budget was updated.
-
#version ⇒ Integer
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
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 |
# File 'lib/oci/budget/models/budget_summary.rb', line 199 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.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
86 87 88 |
# File 'lib/oci/budget/models/budget_summary.rb', line 86 def actual_spend @actual_spend end |
#alert_rule_count ⇒ Integer
[Required] Total number of alert rules in the budget
78 79 80 |
# File 'lib/oci/budget/models/budget_summary.rb', line 78 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.
53 54 55 |
# File 'lib/oci/budget/models/budget_summary.rb', line 53 def amount @amount end |
#compartment_id ⇒ String
[Required] The OCID of the compartment
33 34 35 |
# File 'lib/oci/budget/models/budget_summary.rb', line 33 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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
Example: ‘{"CostCenter": "42"}`
118 119 120 |
# File 'lib/oci/budget/models/budget_summary.rb', line 118 def @defined_tags end |
#description ⇒ String
The description of the budget.
48 49 50 |
# File 'lib/oci/budget/models/budget_summary.rb', line 48 def description @description end |
#display_name ⇒ String
[Required] The display name of the budget.
44 45 46 |
# File 'lib/oci/budget/models/budget_summary.rb', line 44 def display_name @display_name end |
#forecasted_spend ⇒ Float
The forecasted spend in currency by the end of the current budget cycle
90 91 92 |
# File 'lib/oci/budget/models/budget_summary.rb', line 90 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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
Example: ‘"Finance"`
110 111 112 |
# File 'lib/oci/budget/models/budget_summary.rb', line 110 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the budget
29 30 31 |
# File 'lib/oci/budget/models/budget_summary.rb', line 29 def id @id end |
#lifecycle_state ⇒ String
[Required] The current state of the budget.
74 75 76 |
# File 'lib/oci/budget/models/budget_summary.rb', line 74 def lifecycle_state @lifecycle_state end |
#reset_period ⇒ String
[Required] The reset period for the budget.
58 59 60 |
# File 'lib/oci/budget/models/budget_summary.rb', line 58 def reset_period @reset_period end |
#target_compartment_id ⇒ String
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.
40 41 42 |
# File 'lib/oci/budget/models/budget_summary.rb', line 40 def target_compartment_id @target_compartment_id end |
#target_type ⇒ String
The type of target on which the budget is applied.
63 64 65 |
# File 'lib/oci/budget/models/budget_summary.rb', line 63 def target_type @target_type end |
#targets ⇒ Array<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 tag identifiers in the form of \"{tagNamespace}.{tagKey}.{tagValue}\".
70 71 72 |
# File 'lib/oci/budget/models/budget_summary.rb', line 70 def targets @targets end |
#time_created ⇒ DateTime
[Required] Time budget was created
98 99 100 |
# File 'lib/oci/budget/models/budget_summary.rb', line 98 def time_created @time_created end |
#time_spend_computed ⇒ DateTime
Time budget spend was last computed
94 95 96 |
# File 'lib/oci/budget/models/budget_summary.rb', line 94 def time_spend_computed @time_spend_computed end |
#time_updated ⇒ DateTime
[Required] Time budget was updated
102 103 104 |
# File 'lib/oci/budget/models/budget_summary.rb', line 102 def time_updated @time_updated end |
#version ⇒ Integer
Version of the budget. Starts from 1 and increments by 1.
82 83 84 |
# File 'lib/oci/budget/models/budget_summary.rb', line 82 def version @version end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
# File 'lib/oci/budget/models/budget_summary.rb', line 121 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', '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.
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 |
# File 'lib/oci/budget/models/budget_summary.rb', line 148 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', '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.
346 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/budget/models/budget_summary.rb', line 346 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 && 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
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/budget/models/budget_summary.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
374 375 376 |
# File 'lib/oci/budget/models/budget_summary.rb', line 374 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
383 384 385 |
# File 'lib/oci/budget/models/budget_summary.rb', line 383 def hash [id, compartment_id, target_compartment_id, display_name, description, amount, reset_period, 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
427 428 429 430 431 432 433 434 435 436 |
# File 'lib/oci/budget/models/budget_summary.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
421 422 423 |
# File 'lib/oci/budget/models/budget_summary.rb', line 421 def to_s to_hash.to_s end |