OccMetricAlarm¶

class oci.demand_signal.models.OccMetricAlarm(**kwargs)¶

Bases: object

OccMetricAlarm represents an alarm configuration for OCI Control Center metric.

Attributes

`FREQUENCY_DAILY`	A constant which can be used with the frequency property of a OccMetricAlarm.
`FREQUENCY_MONTHLY`	A constant which can be used with the frequency property of a OccMetricAlarm.
`FREQUENCY_WEEKLY`	A constant which can be used with the frequency property of a OccMetricAlarm.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a OccMetricAlarm.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a OccMetricAlarm.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a OccMetricAlarm.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a OccMetricAlarm.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a OccMetricAlarm.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a OccMetricAlarm.
`THRESHOLD_TYPE_PERCENTAGE`	A constant which can be used with the threshold_type property of a OccMetricAlarm.
`THRESHOLD_TYPE_UNITS`	A constant which can be used with the threshold_type property of a OccMetricAlarm.
`compartment_id`	Gets the compartment_id of this OccMetricAlarm.
`defined_tags`	Gets the defined_tags of this OccMetricAlarm.
`description`	Gets the description of this OccMetricAlarm.
`display_name`	[Required] Gets the display_name of this OccMetricAlarm.
`freeform_tags`	Gets the freeform_tags of this OccMetricAlarm.
`frequency`	[Required] Gets the frequency of this OccMetricAlarm.
`id`	[Required] Gets the id of this OccMetricAlarm.
`is_active`	[Required] Gets the is_active of this OccMetricAlarm.
`lifecycle_state`	[Required] Gets the lifecycle_state of this OccMetricAlarm.
`resource_configuration`	[Required] Gets the resource_configuration of this OccMetricAlarm.
`subscribers`	[Required] Gets the subscribers of this OccMetricAlarm.
`system_tags`	Gets the system_tags of this OccMetricAlarm.
`threshold`	[Required] Gets the threshold of this OccMetricAlarm.
`threshold_type`	[Required] Gets the threshold_type of this OccMetricAlarm.
`time_created`	[Required] Gets the time_created of this OccMetricAlarm.
`time_updated`	[Required] Gets the time_updated of this OccMetricAlarm.

Methods

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

FREQUENCY_DAILY = 'DAILY'¶: A constant which can be used with the frequency property of a OccMetricAlarm. This constant has a value of “DAILY”

FREQUENCY_MONTHLY = 'MONTHLY'¶: A constant which can be used with the frequency property of a OccMetricAlarm. This constant has a value of “MONTHLY”

FREQUENCY_WEEKLY = 'WEEKLY'¶: A constant which can be used with the frequency property of a OccMetricAlarm. This constant has a value of “WEEKLY”

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

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a OccMetricAlarm. This constant has a value of “CREATING”

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

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a OccMetricAlarm. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a OccMetricAlarm. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a OccMetricAlarm. This constant has a value of “UPDATING”

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

THRESHOLD_TYPE_UNITS = 'UNITS'¶: A constant which can be used with the threshold_type property of a OccMetricAlarm. This constant has a value of “UNITS”

__init__(**kwargs)¶

Initializes a new OccMetricAlarm 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 OccMetricAlarm.
display_name (str) – The value to assign to the display_name property of this OccMetricAlarm.
description (str) – The value to assign to the description property of this OccMetricAlarm.
time_created (datetime) – The value to assign to the time_created property of this OccMetricAlarm.
time_updated (datetime) – The value to assign to the time_updated property of this OccMetricAlarm.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OccMetricAlarm. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
compartment_id (str) – The value to assign to the compartment_id property of this OccMetricAlarm.
is_active (bool) – The value to assign to the is_active property of this OccMetricAlarm.
subscribers (list[str]) – The value to assign to the subscribers property of this OccMetricAlarm.
frequency (str) – The value to assign to the frequency property of this OccMetricAlarm. Allowed values for this property are: “DAILY”, “WEEKLY”, “MONTHLY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
threshold (int) – The value to assign to the threshold property of this OccMetricAlarm.
threshold_type (str) – The value to assign to the threshold_type property of this OccMetricAlarm. Allowed values for this property are: “PERCENTAGE”, “UNITS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
resource_configuration (oci.demand_signal.models.BaseResourceConfiguration) – The value to assign to the resource_configuration property of this OccMetricAlarm.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OccMetricAlarm.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OccMetricAlarm.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OccMetricAlarm.

compartment_id¶

Gets the compartment_id of this OccMetricAlarm. Compartment OCID in which the alarm is created.

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

defined_tags¶

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

description¶

Gets the description of this OccMetricAlarm. Optional description for the alarm.

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

display_name¶

[Required] Gets the display_name of this OccMetricAlarm. Human-readable name for the alarm.

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

freeform_tags¶

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

frequency¶

[Required] Gets the frequency of this OccMetricAlarm. Frequency at which notifications should be sent.

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

Returns:	The frequency of this OccMetricAlarm.
Return type:	str

id¶

[Required] Gets the id of this OccMetricAlarm. Unique OCID for this alarm configuration.

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

is_active¶

[Required] Gets the is_active of this OccMetricAlarm. Alarm active status.

Returns:	The is_active of this OccMetricAlarm.
Return type:	bool

lifecycle_state¶

[Required] Gets the lifecycle_state of this OccMetricAlarm. The current lifecycle state of the resource.

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

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

resource_configuration¶

[Required] Gets the resource_configuration of this OccMetricAlarm.

Returns:	The resource_configuration of this OccMetricAlarm.
Return type:	oci.demand_signal.models.BaseResourceConfiguration

subscribers¶

[Required] Gets the subscribers of this OccMetricAlarm. List of topic OCIDs for notifications.

Returns:	The subscribers of this OccMetricAlarm.
Return type:	list[str]

system_tags¶

Gets the system_tags of this OccMetricAlarm. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this OccMetricAlarm.
Return type:	dict(str, dict(str, object))

threshold¶

[Required] Gets the threshold of this OccMetricAlarm. Threshold at which alarm must be triggered.

Returns:	The threshold of this OccMetricAlarm.
Return type:	int

threshold_type¶

[Required] Gets the threshold_type of this OccMetricAlarm. Units in which threshold is being stored.

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

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

time_created¶

[Required] Gets the time_created of this OccMetricAlarm. Creation timestamp (RFC 3339).

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

time_updated¶

[Required] Gets the time_updated of this OccMetricAlarm. Last update timestamp (RFC 3339).

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