CreateAlertRuleDetails¶

class oci.budget.models.CreateAlertRuleDetails(**kwargs)¶

Bases: object

The create alert rule details. This is a batch-create.

Attributes

`THRESHOLD_TYPE_ABSOLUTE`	A constant which can be used with the threshold_type property of a CreateAlertRuleDetails.
`THRESHOLD_TYPE_PERCENTAGE`	A constant which can be used with the threshold_type property of a CreateAlertRuleDetails.
`TYPE_ACTUAL`	A constant which can be used with the type property of a CreateAlertRuleDetails.
`TYPE_FORECAST`	A constant which can be used with the type property of a CreateAlertRuleDetails.
`defined_tags`	Gets the defined_tags of this CreateAlertRuleDetails.
`description`	Gets the description of this CreateAlertRuleDetails.
`display_name`	Gets the display_name of this CreateAlertRuleDetails.
`freeform_tags`	Gets the freeform_tags of this CreateAlertRuleDetails.
`message`	Gets the message of this CreateAlertRuleDetails.
`recipients`	Gets the recipients of this CreateAlertRuleDetails.
`threshold`	[Required] Gets the threshold of this CreateAlertRuleDetails.
`threshold_type`	[Required] Gets the threshold_type of this CreateAlertRuleDetails.
`type`	[Required] Gets the type of this CreateAlertRuleDetails.

Methods

__init__(**kwargs) Initializes a new CreateAlertRuleDetails object with values from keyword arguments.

THRESHOLD_TYPE_ABSOLUTE = 'ABSOLUTE'¶: A constant which can be used with the threshold_type property of a CreateAlertRuleDetails. This constant has a value of “ABSOLUTE”

THRESHOLD_TYPE_PERCENTAGE = 'PERCENTAGE'¶: A constant which can be used with the threshold_type property of a CreateAlertRuleDetails. This constant has a value of “PERCENTAGE”

TYPE_ACTUAL = 'ACTUAL'¶: A constant which can be used with the type property of a CreateAlertRuleDetails. This constant has a value of “ACTUAL”

TYPE_FORECAST = 'FORECAST'¶: A constant which can be used with the type property of a CreateAlertRuleDetails. This constant has a value of “FORECAST”

__init__(**kwargs)¶

Initializes a new CreateAlertRuleDetails 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 CreateAlertRuleDetails.
description (str) – The value to assign to the description property of this CreateAlertRuleDetails.
type (str) – The value to assign to the type property of this CreateAlertRuleDetails. Allowed values for this property are: “ACTUAL”, “FORECAST”
threshold (float) – The value to assign to the threshold property of this CreateAlertRuleDetails.
threshold_type (str) – The value to assign to the threshold_type property of this CreateAlertRuleDetails. Allowed values for this property are: “PERCENTAGE”, “ABSOLUTE”
recipients (str) – The value to assign to the recipients property of this CreateAlertRuleDetails.
message (str) – The value to assign to the message property of this CreateAlertRuleDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateAlertRuleDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateAlertRuleDetails.

defined_tags¶

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

description¶

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

Returns:	The description of this CreateAlertRuleDetails.
Return type:	str

display_name¶

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

Returns:	The display_name of this CreateAlertRuleDetails.
Return type:	str

freeform_tags¶

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

message¶

Gets the message of this CreateAlertRuleDetails. The message to be sent to the recipients when the alert rule is triggered.

Returns:	The message of this CreateAlertRuleDetails.
Return type:	str

recipients¶

Gets the recipients of this CreateAlertRuleDetails. The audience that receives the alert when it triggers. An empty string is interpreted as null.

Returns:	The recipients of this CreateAlertRuleDetails.
Return type:	str

threshold¶

[Required] Gets the threshold of this CreateAlertRuleDetails. 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 CreateAlertRuleDetails.
Return type:	float

threshold_type¶

[Required] Gets the threshold_type of this CreateAlertRuleDetails. The type of threshold.

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

Returns:	The threshold_type of this CreateAlertRuleDetails.
Return type:	str

type¶

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