AlarmSuppression¶

class oci.monitoring.models.AlarmSuppression(**kwargs)¶

Bases: object

The configuration details for an alarm suppression.

Attributes

`LEVEL_ALARM`	A constant which can be used with the level property of a AlarmSuppression.
`LEVEL_DIMENSION`	A constant which can be used with the level property of a AlarmSuppression.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a AlarmSuppression.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a AlarmSuppression.
`alarm_suppression_target`	[Required] Gets the alarm_suppression_target of this AlarmSuppression.
`compartment_id`	[Required] Gets the compartment_id of this AlarmSuppression.
`defined_tags`	Gets the defined_tags of this AlarmSuppression.
`description`	Gets the description of this AlarmSuppression.
`dimensions`	Gets the dimensions of this AlarmSuppression.
`display_name`	[Required] Gets the display_name of this AlarmSuppression.
`freeform_tags`	Gets the freeform_tags of this AlarmSuppression.
`id`	[Required] Gets the id of this AlarmSuppression.
`level`	[Required] Gets the level of this AlarmSuppression.
`lifecycle_state`	[Required] Gets the lifecycle_state of this AlarmSuppression.
`suppression_conditions`	Gets the suppression_conditions of this AlarmSuppression.
`time_created`	[Required] Gets the time_created of this AlarmSuppression.
`time_suppress_from`	[Required] Gets the time_suppress_from of this AlarmSuppression.
`time_suppress_until`	[Required] Gets the time_suppress_until of this AlarmSuppression.
`time_updated`	[Required] Gets the time_updated of this AlarmSuppression.

Methods

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

LEVEL_ALARM = 'ALARM'¶: A constant which can be used with the level property of a AlarmSuppression. This constant has a value of “ALARM”

LEVEL_DIMENSION = 'DIMENSION'¶: A constant which can be used with the level property of a AlarmSuppression. This constant has a value of “DIMENSION”

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

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a AlarmSuppression. This constant has a value of “DELETED”

__init__(**kwargs)¶

Initializes a new AlarmSuppression 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 AlarmSuppression.
compartment_id (str) – The value to assign to the compartment_id property of this AlarmSuppression.
alarm_suppression_target (oci.monitoring.models.AlarmSuppressionTarget) – The value to assign to the alarm_suppression_target property of this AlarmSuppression.
level (str) – The value to assign to the level property of this AlarmSuppression. Allowed values for this property are: “ALARM”, “DIMENSION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
suppression_conditions (list[oci.monitoring.models.SuppressionCondition]) – The value to assign to the suppression_conditions property of this AlarmSuppression.
display_name (str) – The value to assign to the display_name property of this AlarmSuppression.
description (str) – The value to assign to the description property of this AlarmSuppression.
dimensions (dict(str, str)) – The value to assign to the dimensions property of this AlarmSuppression.
time_suppress_from (datetime) – The value to assign to the time_suppress_from property of this AlarmSuppression.
time_suppress_until (datetime) – The value to assign to the time_suppress_until property of this AlarmSuppression.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this AlarmSuppression. Allowed values for this property are: “ACTIVE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this AlarmSuppression.
time_updated (datetime) – The value to assign to the time_updated property of this AlarmSuppression.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AlarmSuppression.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AlarmSuppression.

alarm_suppression_target¶

[Required] Gets the alarm_suppression_target of this AlarmSuppression.

Returns:	The alarm_suppression_target of this AlarmSuppression.
Return type:	oci.monitoring.models.AlarmSuppressionTarget

compartment_id¶

[Required] Gets the compartment_id of this AlarmSuppression. The OCID of the compartment containing the alarm suppression.

Returns:	The compartment_id of this AlarmSuppression.
Return type:	str

defined_tags¶

Gets the defined_tags of this AlarmSuppression. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this AlarmSuppression.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this AlarmSuppression. Human-readable reason for this alarm suppression. It does not have to be unique, and it’s changeable. Avoid entering confidential information.

Oracle recommends including tracking information for the event or associated work, such as a ticket number.

Example: Planned outage due to change IT-1234.

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

dimensions¶

Gets the dimensions of this AlarmSuppression. Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs.

Example: {“resourceId”: “ocid1.instance.region1.phx.exampleuniqueID”}

Returns:	The dimensions of this AlarmSuppression.
Return type:	dict(str, str)

display_name¶

[Required] Gets the display_name of this AlarmSuppression. A user-friendly name for the alarm suppression. It does not have to be unique, and it’s changeable. Avoid entering confidential information.

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

freeform_tags¶

Gets the freeform_tags of this AlarmSuppression. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this AlarmSuppression.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this AlarmSuppression. The OCID of the alarm suppression.

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

level¶

[Required] Gets the level of this AlarmSuppression. The level of this alarm suppression. ALARM indicates a suppression of the entire alarm, regardless of dimension. DIMENSION indicates a suppression configured for specified dimensions.

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

Returns:	The level of this AlarmSuppression.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this AlarmSuppression. The current lifecycle state of the alarm suppression.

Example: DELETED

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

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

suppression_conditions¶

Gets the suppression_conditions of this AlarmSuppression. Array of all preconditions for alarm suppression. Example: `[{

conditionType: “RECURRENCE”, suppressionRecurrence: “FRQ=DAILY;BYHOUR=10”, suppressionDuration: “PT1H”

}]`

Returns:	The suppression_conditions of this AlarmSuppression.
Return type:	list[oci.monitoring.models.SuppressionCondition]

time_created¶

[Required] Gets the time_created of this AlarmSuppression. The date and time the alarm suppression was created. Format defined by RFC3339.

Example: 2018-02-01T01:02:29.600Z

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

time_suppress_from¶

[Required] Gets the time_suppress_from of this AlarmSuppression. The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.

Example: 2018-02-01T01:02:29.600Z

Returns:	The time_suppress_from of this AlarmSuppression.
Return type:	datetime

time_suppress_until¶

[Required] Gets the time_suppress_until of this AlarmSuppression. The end date and time for the suppression to take place, inclusive. Format defined by RFC3339.

Example: 2018-02-01T02:02:29.600Z

Returns:	The time_suppress_until of this AlarmSuppression.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this AlarmSuppression. The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339.

Example: 2018-02-03T01:02:29.600Z

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