AlarmSuppressionSummary¶

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

Bases: object

A summary of properties for the specified alarm suppression.

Methods

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

Attributes

`alarm_suppression_target`	[Required] Gets the alarm_suppression_target of this AlarmSuppressionSummary.
`compartment_id`	[Required] Gets the compartment_id of this AlarmSuppressionSummary.
`defined_tags`	Gets the defined_tags of this AlarmSuppressionSummary.
`description`	Gets the description of this AlarmSuppressionSummary.
`dimensions`	Gets the dimensions of this AlarmSuppressionSummary.
`display_name`	[Required] Gets the display_name of this AlarmSuppressionSummary.
`freeform_tags`	Gets the freeform_tags of this AlarmSuppressionSummary.
`id`	[Required] Gets the id of this AlarmSuppressionSummary.
`level`	[Required] Gets the level of this AlarmSuppressionSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this AlarmSuppressionSummary.
`suppression_conditions`	Gets the suppression_conditions of this AlarmSuppressionSummary.
`time_created`	[Required] Gets the time_created of this AlarmSuppressionSummary.
`time_suppress_from`	[Required] Gets the time_suppress_from of this AlarmSuppressionSummary.
`time_suppress_until`	[Required] Gets the time_suppress_until of this AlarmSuppressionSummary.
`time_updated`	[Required] Gets the time_updated of this AlarmSuppressionSummary.

__init__(**kwargs)¶

Initializes a new AlarmSuppressionSummary 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 AlarmSuppressionSummary.
compartment_id (str) – The value to assign to the compartment_id property of this AlarmSuppressionSummary.
alarm_suppression_target (oci.monitoring.models.AlarmSuppressionTarget) – The value to assign to the alarm_suppression_target property of this AlarmSuppressionSummary.
level (str) – The value to assign to the level property of this AlarmSuppressionSummary.
suppression_conditions (list[oci.monitoring.models.SuppressionCondition]) – The value to assign to the suppression_conditions property of this AlarmSuppressionSummary.
display_name (str) – The value to assign to the display_name property of this AlarmSuppressionSummary.
description (str) – The value to assign to the description property of this AlarmSuppressionSummary.
dimensions (dict(str, str)) – The value to assign to the dimensions property of this AlarmSuppressionSummary.
time_suppress_from (datetime) – The value to assign to the time_suppress_from property of this AlarmSuppressionSummary.
time_suppress_until (datetime) – The value to assign to the time_suppress_until property of this AlarmSuppressionSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this AlarmSuppressionSummary.
time_created (datetime) – The value to assign to the time_created property of this AlarmSuppressionSummary.
time_updated (datetime) – The value to assign to the time_updated property of this AlarmSuppressionSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AlarmSuppressionSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AlarmSuppressionSummary.

alarm_suppression_target¶

[Required] Gets the alarm_suppression_target of this AlarmSuppressionSummary.

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

compartment_id¶

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

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

defined_tags¶

Gets the defined_tags of this AlarmSuppressionSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

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

description¶

Gets the description of this AlarmSuppressionSummary. 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 AlarmSuppressionSummary.
Return type:	str

dimensions¶

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

display_name¶

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

freeform_tags¶

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

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

id¶

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

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

level¶

[Required] Gets the level of this AlarmSuppressionSummary. 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.

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

lifecycle_state¶

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

Example: DELETED

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

suppression_conditions¶

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

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

}]`

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

time_created¶

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

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

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

time_suppress_from¶

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

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

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

time_suppress_until¶

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

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

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

time_updated¶

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

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

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