AlarmDimensionStatesEntry¶

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

Bases: object

A timestamped alarm state entry for a metric stream.

Attributes

`STATUS_FIRING`	A constant which can be used with the status property of a AlarmDimensionStatesEntry.
`STATUS_OK`	A constant which can be used with the status property of a AlarmDimensionStatesEntry.
`alarm_summary`	[Required] Gets the alarm_summary of this AlarmDimensionStatesEntry.
`dimensions`	[Required] Gets the dimensions of this AlarmDimensionStatesEntry.
`rule_name`	[Required] Gets the rule_name of this AlarmDimensionStatesEntry.
`status`	[Required] Gets the status of this AlarmDimensionStatesEntry.
`timestamp`	[Required] Gets the timestamp of this AlarmDimensionStatesEntry.

Methods

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

STATUS_FIRING = 'FIRING'¶: A constant which can be used with the status property of a AlarmDimensionStatesEntry. This constant has a value of “FIRING”

STATUS_OK = 'OK'¶: A constant which can be used with the status property of a AlarmDimensionStatesEntry. This constant has a value of “OK”

__init__(**kwargs)¶

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

Parameters:

alarm_summary (str) – The value to assign to the alarm_summary property of this AlarmDimensionStatesEntry.
dimensions (dict(str, str)) – The value to assign to the dimensions property of this AlarmDimensionStatesEntry.
status (str) – The value to assign to the status property of this AlarmDimensionStatesEntry. Allowed values for this property are: “FIRING”, “OK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
rule_name (str) – The value to assign to the rule_name property of this AlarmDimensionStatesEntry.
timestamp (datetime) – The value to assign to the timestamp property of this AlarmDimensionStatesEntry.

alarm_summary¶

[Required] Gets the alarm_summary of this AlarmDimensionStatesEntry. Customizable alarm summary (alarmSummary alarm message parameter). Optionally include dynamic variables. The alarm summary appears within the body of the alarm message and in responses to list_alarms_status() get_alarm_history() and retrieve_dimension_states().

Returns:	The alarm_summary of this AlarmDimensionStatesEntry.
Return type:	str

dimensions¶

[Required] Gets the dimensions of this AlarmDimensionStatesEntry. Indicator of the metric stream associated with the alarm state entry. Includes one or more dimension key-value pairs.

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

rule_name¶

[Required] Gets the rule_name of this AlarmDimensionStatesEntry. Identifier of the alarm’s base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see alarm_override().

Returns:	The rule_name of this AlarmDimensionStatesEntry.
Return type:	str

status¶

[Required] Gets the status of this AlarmDimensionStatesEntry. Transition state (status value) associated with the alarm state entry.

Example: FIRING

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

Returns:	The status of this AlarmDimensionStatesEntry.
Return type:	str

timestamp¶

[Required] Gets the timestamp of this AlarmDimensionStatesEntry. Transition time associated with the alarm state entry. Format defined by RFC3339.

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

Returns:	The timestamp of this AlarmDimensionStatesEntry.
Return type:	datetime