Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateBudgetDetails

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.

Properties

amount

amount: number

The amount of the budget expressed as a whole number 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.

Optional displayName

displayName: undefined | string

The displayName of the budget. Avoid entering confidential information.

Optional endDate

endDate: Date

The date 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 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\"}}

Optional processingPeriodType

processingPeriodType: model.ProcessingPeriodType

The type of the budget processing period. 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. Set the target compartment ID in targets instead.

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

Functions

getDeserializedJsonObj

getJsonObj