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

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

Overview

The update budget details.

Constant Summary collapse

PROCESSING_PERIOD_TYPE_ENUM = 
[
  PROCESSING_PERIOD_TYPE_INVOICE = 'INVOICE'.freeze,
  PROCESSING_PERIOD_TYPE_MONTH = 'MONTH'.freeze,
  PROCESSING_PERIOD_TYPE_SINGLE_USE = 'SINGLE_USE'.freeze
].freeze
RESET_PERIOD_ENUM = 
[
  RESET_PERIOD_MONTHLY = 'MONTHLY'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateBudgetDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

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

  • :budget_processing_period_start_offset (Integer) —

    The value to assign to the #budget_processing_period_start_offset property

  • :processing_period_type (String) —

    The value to assign to the #processing_period_type property

  • :start_date (DateTime) —

    The value to assign to the #start_date property

  • :end_date (DateTime) —

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



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

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

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/update_budget_details.rb', line 32

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.

Returns:

  • (Integer) 


36
37
38
 
# File 'lib/oci/budget/models/update_budget_details.rb', line 36

def budget_processing_period_start_offset
  @budget_processing_period_start_offset
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\"}}

Returns:

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


70
71
72
 
# File 'lib/oci/budget/models/update_budget_details.rb', line 70

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the budget.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

The displayName of the budget. Avoid entering confidential information.

Returns:

  • (String) 


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

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.

Returns:

  • (DateTime) 


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

def end_date
  @end_date
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\"}

Returns:

  • (Hash<String, String>) 


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

def freeform_tags
  @freeform_tags
end

#processing_period_type ⇒ String

The type of the budget processing period. Valid values are INVOICE, MONTH, and SINGLE_USE.

Returns:

  • (String) 


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

def processing_period_type
  @processing_period_type
end

#reset_period ⇒ String

The reset period for the budget.

Returns:

  • (String) 


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

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.

Returns:

  • (DateTime) 


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

def start_date
  @start_date
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'amount': :'amount',
    'budget_processing_period_start_offset': :'budgetProcessingPeriodStartOffset',
    'processing_period_type': :'processingPeriodType',
    'start_date': :'startDate',
    'end_date': :'endDate',
    'reset_period': :'resetPeriod',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/budget/models/update_budget_details.rb', line 91

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'amount': :'Float',
    'budget_processing_period_start_offset': :'Integer',
    'processing_period_type': :'String',
    'start_date': :'DateTime',
    'end_date': :'DateTime',
    '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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/budget/models/update_budget_details.rb', line 206

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    amount == other.amount &&
    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 &&
    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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/oci/budget/models/update_budget_details.rb', line 245

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


225
226
227
 
# File 'lib/oci/budget/models/update_budget_details.rb', line 225

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



234
235
236
 
# File 'lib/oci/budget/models/update_budget_details.rb', line 234

def hash
  [display_name, description, amount, budget_processing_period_start_offset, processing_period_type, start_date, end_date, 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



278
279
280
281
282
283
284
285
286
287
 
# File 'lib/oci/budget/models/update_budget_details.rb', line 278

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



272
273
274
 
# File 'lib/oci/budget/models/update_budget_details.rb', line 272

def to_s
  to_hash.to_s
end