AlertRuleSummary¶

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

Bases: object

The alert rule.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a AlertRuleSummary.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a AlertRuleSummary.
`THRESHOLD_TYPE_ABSOLUTE`	A constant which can be used with the threshold_type property of a AlertRuleSummary.
`THRESHOLD_TYPE_PERCENTAGE`	A constant which can be used with the threshold_type property of a AlertRuleSummary.
`TYPE_ACTUAL`	A constant which can be used with the type property of a AlertRuleSummary.
`TYPE_FORECAST`	A constant which can be used with the type property of a AlertRuleSummary.
`budget_id`	[Required] Gets the budget_id of this AlertRuleSummary.
`defined_tags`	Gets the defined_tags of this AlertRuleSummary.
`description`	Gets the description of this AlertRuleSummary.
`display_name`	[Required] Gets the display_name of this AlertRuleSummary.
`freeform_tags`	Gets the freeform_tags of this AlertRuleSummary.
`id`	[Required] Gets the id of this AlertRuleSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this AlertRuleSummary.
`message`	Gets the message of this AlertRuleSummary.
`recipients`	[Required] Gets the recipients of this AlertRuleSummary.
`threshold`	[Required] Gets the threshold of this AlertRuleSummary.
`threshold_type`	[Required] Gets the threshold_type of this AlertRuleSummary.
`time_created`	[Required] Gets the time_created of this AlertRuleSummary.
`time_updated`	[Required] Gets the time_updated of this AlertRuleSummary.
`type`	[Required] Gets the type of this AlertRuleSummary.
`version`	Gets the version of this AlertRuleSummary.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a AlertRuleSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a AlertRuleSummary. This constant has a value of “INACTIVE”

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

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

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

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

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this AlertRuleSummary.
budget_id (str) – The value to assign to the budget_id property of this AlertRuleSummary.
display_name (str) – The value to assign to the display_name property of this AlertRuleSummary.
type (str) – The value to assign to the type property of this AlertRuleSummary. Allowed values for this property are: “ACTUAL”, “FORECAST”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
threshold (float) – The value to assign to the threshold property of this AlertRuleSummary.
threshold_type (str) – The value to assign to the threshold_type property of this AlertRuleSummary. Allowed values for this property are: “PERCENTAGE”, “ABSOLUTE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this AlertRuleSummary. Allowed values for this property are: “ACTIVE”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
message (str) – The value to assign to the message property of this AlertRuleSummary.
description (str) – The value to assign to the description property of this AlertRuleSummary.
version (int) – The value to assign to the version property of this AlertRuleSummary.
recipients (str) – The value to assign to the recipients property of this AlertRuleSummary.
time_created (datetime) – The value to assign to the time_created property of this AlertRuleSummary.
time_updated (datetime) – The value to assign to the time_updated property of this AlertRuleSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AlertRuleSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AlertRuleSummary.

budget_id¶

[Required] Gets the budget_id of this AlertRuleSummary. The OCID of the budget

Returns:	The budget_id of this AlertRuleSummary.
Return type:	str

defined_tags¶

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

description¶

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

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

display_name¶

[Required] Gets the display_name of this AlertRuleSummary. The name of the alert rule.

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

freeform_tags¶

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

id¶

[Required] Gets the id of this AlertRuleSummary. The OCID of the alert rule

Returns:	The id of this AlertRuleSummary.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this AlertRuleSummary. The current state of the alert rule.

Allowed values for this property are: “ACTIVE”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this AlertRuleSummary.
Return type:	str

message¶

Gets the message of this AlertRuleSummary. Custom message that will be sent when alert is triggered

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

recipients¶

[Required] Gets the recipients of this AlertRuleSummary. The audience that will received the alert when it triggers.

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

threshold¶

[Required] Gets the threshold of this AlertRuleSummary. The threshold for triggering the alert. If thresholdType is PERCENTAGE, the maximum value is 10000.

Returns:	The threshold of this AlertRuleSummary.
Return type:	float

threshold_type¶

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

Allowed values for this property are: “PERCENTAGE”, “ABSOLUTE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

time_created¶

[Required] Gets the time_created of this AlertRuleSummary. Time when budget was created

Returns:	The time_created of this AlertRuleSummary.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this AlertRuleSummary. Time when budget was updated

Returns:	The time_updated of this AlertRuleSummary.
Return type:	datetime

type¶

[Required] Gets the type of this AlertRuleSummary. ACTUAL means the alert will trigger based on actual usage. FORECAST means the alert will trigger based on predicted usage.

Allowed values for this property are: “ACTUAL”, “FORECAST”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The type of this AlertRuleSummary.
Return type:	str

version¶

Gets the version of this AlertRuleSummary. Version of the alert rule. Starts from 1 and increments by 1.

Returns:	The version of this AlertRuleSummary.
Return type:	int