CreateBudgetDetails

class oci.budget.models.CreateBudgetDetails(**kwargs)

Bases: object

The create budget details.

Clients should use ‘targetType’ and ‘targets’ to specify the target type and list of targets on which the budget is applied.

For backwards compatibility, ‘targetCompartmentId’ is still supported for all existing clients. This is considered deprecated, however, and all clients are upgraded to use ‘targetType’ and ‘targets’.

Specifying both ‘targetCompartmentId’ and ‘targets’ causes a Bad Request.

Attributes:

PROCESSING_PERIOD_TYPE_INVOICE

A constant which can be used with the processing_period_type property of a CreateBudgetDetails.

PROCESSING_PERIOD_TYPE_MONTH

A constant which can be used with the processing_period_type property of a CreateBudgetDetails.

PROCESSING_PERIOD_TYPE_SINGLE_USE

A constant which can be used with the processing_period_type property of a CreateBudgetDetails.

RESET_PERIOD_MONTHLY

A constant which can be used with the reset_period property of a CreateBudgetDetails.

TARGET_TYPE_COMPARTMENT

A constant which can be used with the target_type property of a CreateBudgetDetails.

TARGET_TYPE_TAG

A constant which can be used with the target_type property of a CreateBudgetDetails.

amount

[Required] Gets the amount of this CreateBudgetDetails.

budget_processing_period_start_offset

Gets the budget_processing_period_start_offset of this CreateBudgetDetails.

compartment_id

[Required] Gets the compartment_id of this CreateBudgetDetails.

defined_tags

Gets the defined_tags of this CreateBudgetDetails.

description

Gets the description of this CreateBudgetDetails.

display_name

Gets the display_name of this CreateBudgetDetails.

end_date

Gets the end_date of this CreateBudgetDetails.

freeform_tags

Gets the freeform_tags of this CreateBudgetDetails.

processing_period_type

Gets the processing_period_type of this CreateBudgetDetails.

reset_period

[Required] Gets the reset_period of this CreateBudgetDetails.

start_date

Gets the start_date of this CreateBudgetDetails.

system_tags

Gets the system_tags of this CreateBudgetDetails.

target_compartment_id

Gets the target_compartment_id of this CreateBudgetDetails.

target_type

Gets the target_type of this CreateBudgetDetails.

targets

Gets the targets of this CreateBudgetDetails. The list of targets on which the budget is applied. If targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}". Curerntly, the array should contain exactly one item.

Methods:

__init__(**kwargs)

Initializes a new CreateBudgetDetails 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 CreateBudgetDetails. 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 CreateBudgetDetails. 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 CreateBudgetDetails. 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 CreateBudgetDetails. This constant has a value of “MONTHLY”

TARGET_TYPE_COMPARTMENT = 'COMPARTMENT'

A constant which can be used with the target_type property of a CreateBudgetDetails. This constant has a value of “COMPARTMENT”

TARGET_TYPE_TAG = 'TAG'

A constant which can be used with the target_type property of a CreateBudgetDetails. This constant has a value of “TAG”

__init__(**kwargs)

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

Parameters
  • compartment_id (str) – The value to assign to the compartment_id property of this CreateBudgetDetails.

  • target_compartment_id (str) – The value to assign to the target_compartment_id property of this CreateBudgetDetails.

  • display_name (str) – The value to assign to the display_name property of this CreateBudgetDetails.

  • description (str) – The value to assign to the description property of this CreateBudgetDetails.

  • amount (float) – The value to assign to the amount property of this CreateBudgetDetails.

  • reset_period (str) – The value to assign to the reset_period property of this CreateBudgetDetails. Allowed values for this property are: “MONTHLY”

  • budget_processing_period_start_offset (int) – The value to assign to the budget_processing_period_start_offset property of this CreateBudgetDetails.

  • processing_period_type (str) – The value to assign to the processing_period_type property of this CreateBudgetDetails. Allowed values for this property are: “INVOICE”, “MONTH”, “SINGLE_USE”

  • start_date (datetime) – The value to assign to the start_date property of this CreateBudgetDetails.

  • end_date (datetime) – The value to assign to the end_date property of this CreateBudgetDetails.

  • target_type (str) – The value to assign to the target_type property of this CreateBudgetDetails. Allowed values for this property are: “COMPARTMENT”, “TAG”

  • targets (list[str]) – The value to assign to the targets property of this CreateBudgetDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateBudgetDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateBudgetDetails.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this CreateBudgetDetails.

property amount

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

Returns

The amount of this CreateBudgetDetails.

Return type

float

property budget_processing_period_start_offset

Gets the budget_processing_period_start_offset of this CreateBudgetDetails. 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 CreateBudgetDetails.

Return type

int

property compartment_id

[Required] Gets the compartment_id of this CreateBudgetDetails. The OCID of the compartment.

Returns

The compartment_id of this CreateBudgetDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateBudgetDetails. 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 CreateBudgetDetails.

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this CreateBudgetDetails.

Return type

str

property display_name

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

Returns

The display_name of this CreateBudgetDetails.

Return type

str

property end_date

Gets the end_date of this CreateBudgetDetails. The date when the one-time budget concludes. For example, 2023-08-12T16:01:19.847222+05:30. 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 CreateBudgetDetails.

Return type

datetime

property freeform_tags

Gets the freeform_tags of this CreateBudgetDetails. 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 CreateBudgetDetails.

Return type

dict(str, str)

property processing_period_type

Gets the processing_period_type of this CreateBudgetDetails. 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 CreateBudgetDetails.

Return type

str

property reset_period

[Required] Gets the reset_period of this CreateBudgetDetails. The reset period for the budget.

Allowed values for this property are: “MONTHLY”

Returns

The reset_period of this CreateBudgetDetails.

Return type

str

property start_date

Gets the start_date of this CreateBudgetDetails. The date when the one-time budget begins. For example, 2023-07-12T16:01:19.847222+05:30. 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 CreateBudgetDetails.

Return type

datetime

property system_tags

Gets the system_tags of this CreateBudgetDetails. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this CreateBudgetDetails.

Return type

dict(str, dict(str, object))

property target_compartment_id

Gets the target_compartment_id of this CreateBudgetDetails. This is DEPRECATED. Set the target compartment ID in targets instead.

Returns

The target_compartment_id of this CreateBudgetDetails.

Return type

str

property target_type

Gets the target_type of this CreateBudgetDetails. The type of target on which the budget is applied.

Allowed values for this property are: “COMPARTMENT”, “TAG”

Returns

The target_type of this CreateBudgetDetails.

Return type

str

property targets

Gets the targets of this CreateBudgetDetails. The list of targets on which the budget is applied.

If targetType is “COMPARTMENT”, the targets contain the list of compartment OCIDs. If targetType is “TAG”, the targets contain the list of cost tracking tag identifiers in the form of “{tagNamespace}.{tagKey}.{tagValue}”.

Curerntly, the array should contain exactly one item.

Returns

The targets of this CreateBudgetDetails.

Return type

list[str]