Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace AlertRule

The alert rule.

Properties

budgetId

budgetId: string

The OCID of the budget.

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

displayName

displayName: string

The name of the alert rule. Avoid entering confidential information.

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

lifecycleState

lifecycleState: LifecycleState

The current state of the alert rule.

Optional message

message: undefined | string

Custom message sent when an alert is triggered.

recipients

recipients: string

The delimited list of email addresses to receive the alert when it triggers. Delimiter characters can be a comma, space, TAB, or semicolon.

threshold

threshold: number

The threshold for triggering the alert. If the thresholdType is PERCENTAGE, the maximum value is 10000. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

thresholdType

thresholdType: ThresholdType

The type of threshold.

timeCreated

timeCreated: Date

The time the budget was created.

timeUpdated

timeUpdated: Date

The time the budget was updated.

type

type: AlertType

The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).

Optional version

version: undefined | number

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

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: AlertRule): object

getJsonObj