BudgetSummary

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

Bases: object

A budget.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a BudgetSummary. This constant has a value of "ACTIVE"

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a BudgetSummary. This constant has a value of "INACTIVE"

RESET_PERIOD_MONTHLY = 'MONTHLY'

A constant which can be used with the reset_period property of a BudgetSummary. This constant has a value of "MONTHLY"

TARGET_TYPE_COMPARTMENT = 'COMPARTMENT'

A constant which can be used with the target_type property of a BudgetSummary. This constant has a value of "COMPARTMENT"

TARGET_TYPE_TAG = 'TAG'

A constant which can be used with the target_type property of a BudgetSummary. This constant has a value of "TAG"

__init__(**kwargs)

Initializes a new BudgetSummary 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 BudgetSummary.
  • compartment_id (str) -- The value to assign to the compartment_id property of this BudgetSummary.
  • target_compartment_id (str) -- The value to assign to the target_compartment_id property of this BudgetSummary.
  • display_name (str) -- The value to assign to the display_name property of this BudgetSummary.
  • description (str) -- The value to assign to the description property of this BudgetSummary.
  • amount (float) -- The value to assign to the amount property of this BudgetSummary.
  • reset_period (str) -- The value to assign to the reset_period property of this BudgetSummary. Allowed values for this property are: "MONTHLY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • target_type (str) -- The value to assign to the target_type property of this BudgetSummary. 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 BudgetSummary.
  • lifecycle_state (str) -- The value to assign to the lifecycle_state property of this BudgetSummary. 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 BudgetSummary.
  • version (int) -- The value to assign to the version property of this BudgetSummary.
  • actual_spend (float) -- The value to assign to the actual_spend property of this BudgetSummary.
  • forecasted_spend (float) -- The value to assign to the forecasted_spend property of this BudgetSummary.
  • time_spend_computed (datetime) -- The value to assign to the time_spend_computed property of this BudgetSummary.
  • time_created (datetime) -- The value to assign to the time_created property of this BudgetSummary.
  • time_updated (datetime) -- The value to assign to the time_updated property of this BudgetSummary.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this BudgetSummary.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this BudgetSummary.
actual_spend

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

Returns:The actual_spend of this BudgetSummary.
Return type:float
alert_rule_count

[Required] Gets the alert_rule_count of this BudgetSummary. Total number of alert rules in the budget

Returns:The alert_rule_count of this BudgetSummary.
Return type:int
amount

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

Returns:The amount of this BudgetSummary.
Return type:float
compartment_id

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

Returns:The compartment_id of this BudgetSummary.
Return type:str
defined_tags

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

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

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

[Required] Gets the display_name of this BudgetSummary. The display name of the budget.

Returns:The display_name of this BudgetSummary.
Return type:str
forecasted_spend

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

Returns:The forecasted_spend of this BudgetSummary.
Return type:float
freeform_tags

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

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

Returns:The id of this BudgetSummary.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this BudgetSummary. 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 BudgetSummary.
Return type:str
reset_period

[Required] Gets the reset_period of this BudgetSummary. 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 BudgetSummary.
Return type:str
target_compartment_id

Gets the target_compartment_id of this BudgetSummary. This is DEPRECATED. For backwards compatability, the property will be populated when targetType is "COMPARTMENT" AND targets contains EXACT ONE target compartment ocid. For all other scenarios, this property will be left empty.

Returns:The target_compartment_id of this BudgetSummary.
Return type:str
target_type

Gets the target_type of this BudgetSummary. 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 BudgetSummary.
Return type:str
targets

Gets the targets of this BudgetSummary. 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}".
Returns:The targets of this BudgetSummary.
Return type:list[str]
time_created

[Required] Gets the time_created of this BudgetSummary. Time budget was created

Returns:The time_created of this BudgetSummary.
Return type:datetime
time_spend_computed

Gets the time_spend_computed of this BudgetSummary. Time budget spend was last computed

Returns:The time_spend_computed of this BudgetSummary.
Return type:datetime
time_updated

[Required] Gets the time_updated of this BudgetSummary. Time budget was updated

Returns:The time_updated of this BudgetSummary.
Return type:datetime
version

Gets the version of this BudgetSummary. Version of the budget. Starts from 1 and increments by 1.

Returns:The version of this BudgetSummary.
Return type:int