Class: OCI::Budget::Models::CreateBudgetDetails
- Inherits:
-
Object
- Object
- OCI::Budget::Models::CreateBudgetDetails
- Defined in:
- lib/oci/budget/models/create_budget_details.rb
Overview
The create budget details.
Client should use ‘targetType’ & ‘targets’ to specify the target type and list of targets on which the budget is applied.
For backwards compatibility, ‘targetCompartmentId’ will still be supported for all existing clients. However, this is considered deprecreated and all clients be upgraded to use ‘targetType’ & ‘targets’.
Specifying both ‘targetCompartmentId’ and ‘targets’ will cause a Bad Request.
Constant Summary collapse
- RESET_PERIOD_ENUM =
[ RESET_PERIOD_MONTHLY = 'MONTHLY'.freeze ].freeze
- TARGET_TYPE_ENUM =
[ TARGET_TYPE_COMPARTMENT = 'COMPARTMENT'.freeze, TARGET_TYPE_TAG = 'TAG'.freeze ].freeze
Instance Attribute Summary collapse
-
#amount ⇒ Float
[Required] The amount of the budget expressed as a whole number 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
The displayName of the budget.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#reset_period ⇒ String
[Required] The reset period for the budget.
-
#target_compartment_id ⇒ String
This is DEPRECTAED.
-
#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.
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 = {}) ⇒ CreateBudgetDetails
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 = {}) ⇒ CreateBudgetDetails
Initializes the object
134 135 136 137 138 139 140 141 142 143 144 145 146 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 176 177 178 179 180 181 182 183 184 185 186 187 188 189 |
# File 'lib/oci/budget/models/create_budget_details.rb', line 134 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.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'] self.target_type = "COMPARTMENT" if target_type.nil? && !attributes.key?(:'targetType') # rubocop:disable Style/StringLiterals 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.target_type = "COMPARTMENT" if target_type.nil? && !attributes.key?(:'targetType') && !attributes.key?(:'target_type') # rubocop:disable Style/StringLiterals self.targets = attributes[:'targets'] if attributes[:'targets'] 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
#amount ⇒ Float
[Required] The amount of the budget expressed as a whole number in the currency of the customer’s rate card.
46 47 48 |
# File 'lib/oci/budget/models/create_budget_details.rb', line 46 def amount @amount end |
#compartment_id ⇒ String
[Required] The OCID of the compartment
28 29 30 |
# File 'lib/oci/budget/models/create_budget_details.rb', line 28 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"}`
80 81 82 |
# File 'lib/oci/budget/models/create_budget_details.rb', line 80 def @defined_tags end |
#description ⇒ String
The description of the budget.
41 42 43 |
# File 'lib/oci/budget/models/create_budget_details.rb', line 41 def description @description end |
#display_name ⇒ String
The displayName of the budget.
37 38 39 |
# File 'lib/oci/budget/models/create_budget_details.rb', line 37 def display_name @display_name 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"`
72 73 74 |
# File 'lib/oci/budget/models/create_budget_details.rb', line 72 def @freeform_tags end |
#reset_period ⇒ String
[Required] The reset period for the budget.
51 52 53 |
# File 'lib/oci/budget/models/create_budget_details.rb', line 51 def reset_period @reset_period end |
#target_compartment_id ⇒ String
This is DEPRECTAED. Set the target compartment id in targets instead.
33 34 35 |
# File 'lib/oci/budget/models/create_budget_details.rb', line 33 def target_compartment_id @target_compartment_id end |
#target_type ⇒ String
The type of target on which the budget is applied.
56 57 58 |
# File 'lib/oci/budget/models/create_budget_details.rb', line 56 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}\".
Curerntly, the array should contain EXACT ONE item.
64 65 66 |
# File 'lib/oci/budget/models/create_budget_details.rb', line 64 def targets @targets end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 |
# File 'lib/oci/budget/models/create_budget_details.rb', line 83 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', 'target_compartment_id': :'targetCompartmentId', 'display_name': :'displayName', 'description': :'description', 'amount': :'amount', 'reset_period': :'resetPeriod', 'target_type': :'targetType', 'targets': :'targets', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 |
# File 'lib/oci/budget/models/create_budget_details.rb', line 101 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'String', 'target_compartment_id': :'String', 'display_name': :'String', 'description': :'String', 'amount': :'Float', 'reset_period': :'String', 'target_type': :'String', 'targets': :'Array<String>', '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.
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 |
# File 'lib/oci/budget/models/create_budget_details.rb', line 214 def ==(other) return true if equal?(other) self.class == other.class && 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 && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 |
# File 'lib/oci/budget/models/create_budget_details.rb', line 253 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
233 234 235 |
# File 'lib/oci/budget/models/create_budget_details.rb', line 233 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
242 243 244 |
# File 'lib/oci/budget/models/create_budget_details.rb', line 242 def hash [compartment_id, target_compartment_id, display_name, description, amount, reset_period, target_type, targets, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
286 287 288 289 290 291 292 293 294 295 |
# File 'lib/oci/budget/models/create_budget_details.rb', line 286 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
280 281 282 |
# File 'lib/oci/budget/models/create_budget_details.rb', line 280 def to_s to_hash.to_s end |