Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Budget

A budget.

Properties

Optional actualSpend

actualSpend: undefined | number

The actual spend in currency for the current budget cycle. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

alertRuleCount

alertRuleCount: number

The total number of alert rules in the budget. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

amount

amount: number

The amount of the budget expressed in the currency of the customer's rate card. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional budgetProcessingPeriodStartOffset

budgetProcessingPeriodStartOffset: undefined | number

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. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

compartmentId

compartmentId: string

The OCID of the compartment.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional description

description: undefined | string

The description of the budget.

displayName

displayName: string

The display name of the budget. Avoid entering confidential information.

Optional endDate

endDate: Date

The time when the one-time budget concludes. For example, {@code 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.

Optional forecastedSpend

forecastedSpend: undefined | number

The forecasted spend in currency by the end of the current budget cycle. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional freeformTags

freeformTags: undefined | object

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: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the budget.

lifecycleState

lifecycleState: LifecycleState

The current state of the budget.

Optional processingPeriodType

processingPeriodType: model.ProcessingPeriodType

The budget processing period type. Valid values are INVOICE, MONTH, and SINGLE_USE.

resetPeriod

resetPeriod: ResetPeriod

The reset period for the budget.

Optional startDate

startDate: Date

The date when the one-time budget begins. For example, {@code 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.

Optional targetCompartmentId

targetCompartmentId: undefined | string

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.

Optional targetType

targetType: model.TargetType

The type of target on which the budget is applied.

Optional targets

targets: Array<string>

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}".

timeCreated

timeCreated: Date

The time that the budget was created.

Optional timeSpendComputed

timeSpendComputed: Date

The time that the budget spend was last computed.

timeUpdated

timeUpdated: Date

The time that the budget was updated.

Optional version

version: undefined | number

The version of the budget. Starts from 1 and increments by 1. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Budget): object

getJsonObj

  • getJsonObj(obj: Budget): object