Budget

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

Bases: object

A budget.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a Budget.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a Budget.

PROCESSING_PERIOD_TYPE_INVOICE

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

PROCESSING_PERIOD_TYPE_MONTH

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

PROCESSING_PERIOD_TYPE_SINGLE_USE

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

RESET_PERIOD_MONTHLY

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

TARGET_TYPE_COMPARTMENT

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

TARGET_TYPE_TAG

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

actual_spend

Gets the actual_spend of this Budget.

alert_rule_count

[Required] Gets the alert_rule_count of this Budget.

amount

[Required] Gets the amount of this Budget.

budget_processing_period_start_offset

Gets the budget_processing_period_start_offset of this Budget.

compartment_id

[Required] Gets the compartment_id of this Budget.

defined_tags

Gets the defined_tags of this Budget.

description

Gets the description of this Budget.

display_name

[Required] Gets the display_name of this Budget.

end_date

Gets the end_date of this Budget.

forecasted_spend

Gets the forecasted_spend of this Budget.

freeform_tags

Gets the freeform_tags of this Budget.

id

[Required] Gets the id of this Budget.

lifecycle_state

[Required] Gets the lifecycle_state of this Budget.

processing_period_type

Gets the processing_period_type of this Budget.

reset_period

[Required] Gets the reset_period of this Budget.

start_date

Gets the start_date of this Budget.

system_tags

Gets the system_tags of this Budget.

target_compartment_id

Gets the target_compartment_id of this Budget.

target_type

Gets the target_type of this Budget.

targets

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

time_created

[Required] Gets the time_created of this Budget.

time_spend_computed

Gets the time_spend_computed of this Budget.

time_updated

[Required] Gets the time_updated of this Budget.

version

Gets the version of this Budget.

Methods:

__init__(**kwargs)

Initializes a new Budget object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a Budget. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a Budget. This constant has a value of “INACTIVE”

PROCESSING_PERIOD_TYPE_INVOICE = 'INVOICE'

A constant which can be used with the processing_period_type property of a Budget. 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 Budget. 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 Budget. 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 Budget. This constant has a value of “MONTHLY”

TARGET_TYPE_COMPARTMENT = 'COMPARTMENT'

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

TARGET_TYPE_TAG = 'TAG'

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

__init__(**kwargs)

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

Parameters
  • id (str) – The value to assign to the id property of this Budget.

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

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

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

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

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

  • reset_period (str) – The value to assign to the reset_period property of this Budget. Allowed values for this property are: “MONTHLY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

  • processing_period_type (str) – The value to assign to the processing_period_type property of this Budget. Allowed values for this property are: “INVOICE”, “MONTH”, “SINGLE_USE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

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

  • target_type (str) – The value to assign to the target_type property of this Budget. Allowed values for this property are: “COMPARTMENT”, “TAG”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Budget. Allowed values for this property are: “ACTIVE”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • alert_rule_count (int) – The value to assign to the alert_rule_count property of this Budget.

  • version (int) – The value to assign to the version property of this Budget.

  • actual_spend (float) – The value to assign to the actual_spend property of this Budget.

  • forecasted_spend (float) – The value to assign to the forecasted_spend property of this Budget.

  • time_spend_computed (datetime) – The value to assign to the time_spend_computed property of this Budget.

  • time_created (datetime) – The value to assign to the time_created property of this Budget.

  • time_updated (datetime) – The value to assign to the time_updated property of this Budget.

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

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

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

property actual_spend

Gets the actual_spend of this Budget. The actual spend in currency for the current budget cycle.

Returns

The actual_spend of this Budget.

Return type

float

property alert_rule_count

[Required] Gets the alert_rule_count of this Budget. The total number of alert rules in the budget.

Returns

The alert_rule_count of this Budget.

Return type

int

property amount

[Required] Gets the amount of this Budget. The amount of the budget expressed in the currency of the customer’s rate card.

Returns

The amount of this Budget.

Return type

float

property budget_processing_period_start_offset

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

Return type

int

property compartment_id

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

Returns

The compartment_id of this Budget.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this Budget.

Return type

str

property display_name

[Required] Gets the display_name of this Budget. The display name of the budget. Avoid entering confidential information.

Returns

The display_name of this Budget.

Return type

str

property end_date

Gets the end_date of this Budget. The time 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 Budget.

Return type

datetime

property forecasted_spend

Gets the forecasted_spend of this Budget. The forecasted spend in currency by the end of the current budget cycle.

Returns

The forecasted_spend of this Budget.

Return type

float

property freeform_tags

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

Return type

dict(str, str)

property id

[Required] Gets the id of this Budget. The OCID of the budget.

Returns

The id of this Budget.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this Budget. The current state of the budget.

Allowed values for this property are: “ACTIVE”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this Budget.

Return type

str

property processing_period_type

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

Allowed values for this property are: “INVOICE”, “MONTH”, “SINGLE_USE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The processing_period_type of this Budget.

Return type

str

property reset_period

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

Allowed values for this property are: “MONTHLY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The reset_period of this Budget.

Return type

str

property start_date

Gets the start_date of this Budget. 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 Budget.

Return type

datetime

property system_tags

Gets the system_tags of this Budget. 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 Budget.

Return type

dict(str, dict(str, object))

property target_compartment_id

Gets the target_compartment_id of this Budget. This is DEPRECATED. For backwards compatability, the property is populated when the targetType is “COMPARTMENT”, and targets contain the specific target compartment OCID. For all other scenarios, this property will be left empty.

Returns

The target_compartment_id of this Budget.

Return type

str

property target_type

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

Allowed values for this property are: “COMPARTMENT”, “TAG”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The target_type of this Budget.

Return type

str

property targets

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

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

Returns

The targets of this Budget.

Return type

list[str]

property time_created

[Required] Gets the time_created of this Budget. The time that the budget was created.

Returns

The time_created of this Budget.

Return type

datetime

property time_spend_computed

Gets the time_spend_computed of this Budget. The time that the budget spend was last computed.

Returns

The time_spend_computed of this Budget.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this Budget. The time that the budget was updated.

Returns

The time_updated of this Budget.

Return type

datetime

property version

Gets the version of this Budget. The version of the budget. Starts from 1 and increments by 1.

Returns

The version of this Budget.

Return type

int