UpdateOccMetricAlarmDetails¶
- class oci.demand_signal.models.UpdateOccMetricAlarmDetails(**kwargs)¶
Bases:
objectFields that can be updated for OccMetricAlarm.
Attributes:
A constant which can be used with the lifecycle_state property of a UpdateOccMetricAlarmDetails.
A constant which can be used with the lifecycle_state property of a UpdateOccMetricAlarmDetails.
A constant which can be used with the lifecycle_state property of a UpdateOccMetricAlarmDetails.
A constant which can be used with the lifecycle_state property of a UpdateOccMetricAlarmDetails.
A constant which can be used with the lifecycle_state property of a UpdateOccMetricAlarmDetails.
A constant which can be used with the lifecycle_state property of a UpdateOccMetricAlarmDetails.
A constant which can be used with the threshold_type property of a UpdateOccMetricAlarmDetails.
A constant which can be used with the threshold_type property of a UpdateOccMetricAlarmDetails.
Gets the defined_tags of this UpdateOccMetricAlarmDetails.
Gets the description of this UpdateOccMetricAlarmDetails.
Gets the display_name of this UpdateOccMetricAlarmDetails.
Gets the freeform_tags of this UpdateOccMetricAlarmDetails.
Gets the frequency of this UpdateOccMetricAlarmDetails.
Gets the is_active of this UpdateOccMetricAlarmDetails.
Gets the lifecycle_state of this UpdateOccMetricAlarmDetails.
Gets the subscribers of this UpdateOccMetricAlarmDetails.
Gets the threshold of this UpdateOccMetricAlarmDetails.
Gets the threshold_type of this UpdateOccMetricAlarmDetails.
Methods:
__init__(**kwargs)Initializes a new UpdateOccMetricAlarmDetails object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a UpdateOccMetricAlarmDetails. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a UpdateOccMetricAlarmDetails. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a UpdateOccMetricAlarmDetails. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a UpdateOccMetricAlarmDetails. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a UpdateOccMetricAlarmDetails. This constant has a value of “FAILED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a UpdateOccMetricAlarmDetails. This constant has a value of “UPDATING”
- THRESHOLD_TYPE_PERCENTAGE = 'PERCENTAGE'¶
A constant which can be used with the threshold_type property of a UpdateOccMetricAlarmDetails. This constant has a value of “PERCENTAGE”
- THRESHOLD_TYPE_UNITS = 'UNITS'¶
A constant which can be used with the threshold_type property of a UpdateOccMetricAlarmDetails. This constant has a value of “UNITS”
- __init__(**kwargs)¶
Initializes a new UpdateOccMetricAlarmDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
display_name (str) – The value to assign to the display_name property of this UpdateOccMetricAlarmDetails.
description (str) – The value to assign to the description property of this UpdateOccMetricAlarmDetails.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this UpdateOccMetricAlarmDetails. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”
is_active (bool) – The value to assign to the is_active property of this UpdateOccMetricAlarmDetails.
subscribers (list[str]) – The value to assign to the subscribers property of this UpdateOccMetricAlarmDetails.
frequency (str) – The value to assign to the frequency property of this UpdateOccMetricAlarmDetails.
threshold (int) – The value to assign to the threshold property of this UpdateOccMetricAlarmDetails.
threshold_type (str) – The value to assign to the threshold_type property of this UpdateOccMetricAlarmDetails. Allowed values for this property are: “PERCENTAGE”, “UNITS”
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateOccMetricAlarmDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateOccMetricAlarmDetails.
- property defined_tags¶
Gets the defined_tags of this UpdateOccMetricAlarmDetails. 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 UpdateOccMetricAlarmDetails.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this UpdateOccMetricAlarmDetails. Optional description for the alarm.
- Returns
The description of this UpdateOccMetricAlarmDetails.
- Return type
str
- property display_name¶
Gets the display_name of this UpdateOccMetricAlarmDetails. Human-readable name for the alarm.
- Returns
The display_name of this UpdateOccMetricAlarmDetails.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this UpdateOccMetricAlarmDetails. 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 UpdateOccMetricAlarmDetails.
- Return type
dict(str, str)
- property frequency¶
Gets the frequency of this UpdateOccMetricAlarmDetails. Frequency at which notifications should be sent.
- Returns
The frequency of this UpdateOccMetricAlarmDetails.
- Return type
str
- property is_active¶
Gets the is_active of this UpdateOccMetricAlarmDetails. Alarm active status.
- Returns
The is_active of this UpdateOccMetricAlarmDetails.
- Return type
bool
- property lifecycle_state¶
Gets the lifecycle_state of this UpdateOccMetricAlarmDetails. The current lifecycle state of the resource.
Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”
- Returns
The lifecycle_state of this UpdateOccMetricAlarmDetails.
- Return type
str
- property subscribers¶
Gets the subscribers of this UpdateOccMetricAlarmDetails. List of topic OCIDs for notifications.
- Returns
The subscribers of this UpdateOccMetricAlarmDetails.
- Return type
list[str]
- property threshold¶
Gets the threshold of this UpdateOccMetricAlarmDetails. Threshold at which alarm must be triggered.
- Returns
The threshold of this UpdateOccMetricAlarmDetails.
- Return type
int
- property threshold_type¶
Gets the threshold_type of this UpdateOccMetricAlarmDetails. Units in which threshold is being stored.
Allowed values for this property are: “PERCENTAGE”, “UNITS”
- Returns
The threshold_type of this UpdateOccMetricAlarmDetails.
- Return type
str