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

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

Overview

The create budget details.

Constant Summary collapse

RESET_PERIOD_ENUM =

rubocop:disable Metrics/LineLength

[
  RESET_PERIOD_MONTHLY = 'MONTHLY'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateBudgetDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :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

  • :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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
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
146
 
# File 'lib/oci/budget/models/create_budget_details.rb', line 101

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

#amount ⇒ Float

[Required] The amount of the budget expressed as a whole number in the currency of the customer’s rate card.

Returns:

  • (Float) 


32
33
34
 
# File 'lib/oci/budget/models/create_budget_details.rb', line 32

def amount
  @amount
end

#compartment_id ⇒ String

[Required] The OCID of the compartment

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/budget/models/create_budget_details.rb', line 15

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"}`

Returns:

  • (Hash<String, Hash<String, Object>>) 


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

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the budget.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/budget/models/create_budget_details.rb', line 27

def description
  @description
end

#display_name ⇒ String

The displayName of the budget.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/budget/models/create_budget_details.rb', line 23

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"`

Returns:

  • (Hash<String, String>) 


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

def freeform_tags
  @freeform_tags
end

#reset_period ⇒ String

[Required] The reset period for the budget.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/budget/models/create_budget_details.rb', line 37

def reset_period
  @reset_period
end

#target_compartment_id ⇒ String

[Required] The OCID of the compartment on which budget is applied

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/budget/models/create_budget_details.rb', line 19

def target_compartment_id
  @target_compartment_id
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/budget/models/create_budget_details.rb', line 56

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',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/oci/budget/models/create_budget_details.rb', line 72

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',
    '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



165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/budget/models/create_budget_details.rb', line 165

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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/oci/budget/models/create_budget_details.rb', line 202

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


182
183
184
 
# File 'lib/oci/budget/models/create_budget_details.rb', line 182

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



191
192
193
 
# File 'lib/oci/budget/models/create_budget_details.rb', line 191

def hash
  [compartment_id, target_compartment_id, display_name, description, amount, reset_period, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



235
236
237
238
239
240
241
242
243
244
 
# File 'lib/oci/budget/models/create_budget_details.rb', line 235

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



229
230
231
 
# File 'lib/oci/budget/models/create_budget_details.rb', line 229

def to_s
  to_hash.to_s
end