UpdateAlertRuleDetails

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

Bases: object

The update alert rule details.

Attributes:

THRESHOLD_TYPE_ABSOLUTE

A constant which can be used with the threshold_type property of a UpdateAlertRuleDetails.

THRESHOLD_TYPE_PERCENTAGE

A constant which can be used with the threshold_type property of a UpdateAlertRuleDetails.

TYPE_ACTUAL

A constant which can be used with the type property of a UpdateAlertRuleDetails.

TYPE_FORECAST

A constant which can be used with the type property of a UpdateAlertRuleDetails.

defined_tags

Gets the defined_tags of this UpdateAlertRuleDetails.

description

Gets the description of this UpdateAlertRuleDetails.

display_name

Gets the display_name of this UpdateAlertRuleDetails.

freeform_tags

Gets the freeform_tags of this UpdateAlertRuleDetails.

message

Gets the message of this UpdateAlertRuleDetails.

recipients

Gets the recipients of this UpdateAlertRuleDetails.

threshold

Gets the threshold of this UpdateAlertRuleDetails.

threshold_type

Gets the threshold_type of this UpdateAlertRuleDetails.

type

Gets the type of this UpdateAlertRuleDetails.

Methods:

__init__(**kwargs)

Initializes a new UpdateAlertRuleDetails object with values from keyword arguments.

THRESHOLD_TYPE_ABSOLUTE = 'ABSOLUTE'

A constant which can be used with the threshold_type property of a UpdateAlertRuleDetails. This constant has a value of “ABSOLUTE”

THRESHOLD_TYPE_PERCENTAGE = 'PERCENTAGE'

A constant which can be used with the threshold_type property of a UpdateAlertRuleDetails. This constant has a value of “PERCENTAGE”

TYPE_ACTUAL = 'ACTUAL'

A constant which can be used with the type property of a UpdateAlertRuleDetails. This constant has a value of “ACTUAL”

TYPE_FORECAST = 'FORECAST'

A constant which can be used with the type property of a UpdateAlertRuleDetails. This constant has a value of “FORECAST”

__init__(**kwargs)

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

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

  • type (str) – The value to assign to the type property of this UpdateAlertRuleDetails. Allowed values for this property are: “ACTUAL”, “FORECAST”

  • threshold (float) – The value to assign to the threshold property of this UpdateAlertRuleDetails.

  • threshold_type (str) – The value to assign to the threshold_type property of this UpdateAlertRuleDetails. Allowed values for this property are: “PERCENTAGE”, “ABSOLUTE”

  • recipients (str) – The value to assign to the recipients property of this UpdateAlertRuleDetails.

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

  • message (str) – The value to assign to the message property of this UpdateAlertRuleDetails.

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

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

property defined_tags

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

Return type

dict(str, dict(str, object))

property description

Gets the description of this UpdateAlertRuleDetails. The description of the alert rule.

Returns

The description of this UpdateAlertRuleDetails.

Return type

str

property display_name

Gets the display_name of this UpdateAlertRuleDetails. The name of the alert rule. Avoid entering confidential information.

Returns

The display_name of this UpdateAlertRuleDetails.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property message

Gets the message of this UpdateAlertRuleDetails. The message to be delivered to the recipients when an alert is triggered.

Returns

The message of this UpdateAlertRuleDetails.

Return type

str

property recipients

Gets the recipients of this UpdateAlertRuleDetails. The audience that receives the alert when it triggers. If you need to clear out this value, pass in an empty string instead of a null value.

Returns

The recipients of this UpdateAlertRuleDetails.

Return type

str

property threshold

Gets the threshold of this UpdateAlertRuleDetails. The threshold for triggering the alert, expressed as a whole number or decimal value. If the thresholdType is ABSOLUTE, the threshold can have at most 12 digits before the decimal point, and up to two digits after the decimal point. If the thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to two digits after the decimal point.

Returns

The threshold of this UpdateAlertRuleDetails.

Return type

float

property threshold_type

Gets the threshold_type of this UpdateAlertRuleDetails. The type of threshold.

Allowed values for this property are: “PERCENTAGE”, “ABSOLUTE”

Returns

The threshold_type of this UpdateAlertRuleDetails.

Return type

str

property type

Gets the type of this UpdateAlertRuleDetails. 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).

Allowed values for this property are: “ACTUAL”, “FORECAST”

Returns

The type of this UpdateAlertRuleDetails.

Return type

str