CreateBudgetDetails

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

Bases: object

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.

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"
  • 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.
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
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
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))
description

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

Returns:The description of this CreateBudgetDetails.
Return type:str
display_name

Gets the display_name of this CreateBudgetDetails. The displayName of the budget.

Returns:The display_name of this CreateBudgetDetails.
Return type:str
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)
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
target_compartment_id

Gets the target_compartment_id of this CreateBudgetDetails. This is DEPRECTAED. Set the target compartment id in targets instead.

Returns:The target_compartment_id of this CreateBudgetDetails.
Return type:str
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
targets

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

Returns:The targets of this CreateBudgetDetails.
Return type:list[str]