UpdateBudgetDetails¶

class oci.budget.models.UpdateBudgetDetails(**kwargs)¶

Bases: object

The update budget details.

Attributes

`PROCESSING_PERIOD_TYPE_INVOICE`	A constant which can be used with the processing_period_type property of a UpdateBudgetDetails.
`PROCESSING_PERIOD_TYPE_MONTH`	A constant which can be used with the processing_period_type property of a UpdateBudgetDetails.
`PROCESSING_PERIOD_TYPE_SINGLE_USE`	A constant which can be used with the processing_period_type property of a UpdateBudgetDetails.
`RESET_PERIOD_MONTHLY`	A constant which can be used with the reset_period property of a UpdateBudgetDetails.
`amount`	Gets the amount of this UpdateBudgetDetails.
`budget_processing_period_start_offset`	Gets the budget_processing_period_start_offset of this UpdateBudgetDetails.
`defined_tags`	Gets the defined_tags of this UpdateBudgetDetails.
`description`	Gets the description of this UpdateBudgetDetails.
`display_name`	Gets the display_name of this UpdateBudgetDetails.
`end_date`	Gets the end_date of this UpdateBudgetDetails.
`freeform_tags`	Gets the freeform_tags of this UpdateBudgetDetails.
`processing_period_type`	Gets the processing_period_type of this UpdateBudgetDetails.
`reset_period`	Gets the reset_period of this UpdateBudgetDetails.
`start_date`	Gets the start_date of this UpdateBudgetDetails.

Methods

__init__(**kwargs) Initializes a new UpdateBudgetDetails object with values from keyword arguments.

PROCESSING_PERIOD_TYPE_INVOICE = 'INVOICE'¶: A constant which can be used with the processing_period_type property of a UpdateBudgetDetails. This constant has a value of “INVOICE”

PROCESSING_PERIOD_TYPE_MONTH = 'MONTH'¶: A constant which can be used with the processing_period_type property of a UpdateBudgetDetails. This constant has a value of “MONTH”

PROCESSING_PERIOD_TYPE_SINGLE_USE = 'SINGLE_USE'¶: A constant which can be used with the processing_period_type property of a UpdateBudgetDetails. This constant has a value of “SINGLE_USE”

RESET_PERIOD_MONTHLY = 'MONTHLY'¶: A constant which can be used with the reset_period property of a UpdateBudgetDetails. This constant has a value of “MONTHLY”

__init__(**kwargs)¶

Initializes a new UpdateBudgetDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

display_name (str) – The value to assign to the display_name property of this UpdateBudgetDetails.
description (str) – The value to assign to the description property of this UpdateBudgetDetails.
amount (float) – The value to assign to the amount property of this UpdateBudgetDetails.
budget_processing_period_start_offset (int) – The value to assign to the budget_processing_period_start_offset property of this UpdateBudgetDetails.
processing_period_type (str) – The value to assign to the processing_period_type property of this UpdateBudgetDetails. Allowed values for this property are: “INVOICE”, “MONTH”, “SINGLE_USE”
start_date (datetime) – The value to assign to the start_date property of this UpdateBudgetDetails.
end_date (datetime) – The value to assign to the end_date property of this UpdateBudgetDetails.
reset_period (str) – The value to assign to the reset_period property of this UpdateBudgetDetails. Allowed values for this property are: “MONTHLY”
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateBudgetDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateBudgetDetails.

amount¶

Gets the amount of this UpdateBudgetDetails. The amount of the budget expressed as a whole number in the currency of the customer’s rate card.

Returns:	The amount of this UpdateBudgetDetails.
Return type:	float

budget_processing_period_start_offset¶

Gets the budget_processing_period_start_offset of this UpdateBudgetDetails. 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:	The budget_processing_period_start_offset of this UpdateBudgetDetails.
Return type:	int

defined_tags¶

Gets the defined_tags of this UpdateBudgetDetails. 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:	The defined_tags of this UpdateBudgetDetails.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this UpdateBudgetDetails. The description of the budget.

Returns:	The description of this UpdateBudgetDetails.
Return type:	str

display_name¶

Gets the display_name of this UpdateBudgetDetails. The displayName of the budget. Avoid entering confidential information.

Returns:	The display_name of this UpdateBudgetDetails.
Return type:	str

end_date¶

Gets the end_date of this UpdateBudgetDetails. 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:	The end_date of this UpdateBudgetDetails.
Return type:	datetime

freeform_tags¶

Gets the freeform_tags of this UpdateBudgetDetails. 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:	The freeform_tags of this UpdateBudgetDetails.
Return type:	dict(str, str)

processing_period_type¶

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

Allowed values for this property are: “INVOICE”, “MONTH”, “SINGLE_USE”

Returns:	The processing_period_type of this UpdateBudgetDetails.
Return type:	str

reset_period¶

Gets the reset_period of this UpdateBudgetDetails. The reset period for the budget.

Allowed values for this property are: “MONTHLY”

Returns:	The reset_period of this UpdateBudgetDetails.
Return type:	str

start_date¶

Gets the start_date of this UpdateBudgetDetails. 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:	The start_date of this UpdateBudgetDetails.
Return type:	datetime