AlarmCondition¶
- class oci.stack_monitoring.models.AlarmCondition(**kwargs)¶
Bases:
objectThe information about template condition in the same monitoringTemplate in a compartment.
Attributes:
A constant which can be used with the condition_type property of a AlarmCondition.
A constant which can be used with the condition_type property of a AlarmCondition.
A constant which can be used with the lifecycle_state property of a AlarmCondition.
A constant which can be used with the lifecycle_state property of a AlarmCondition.
A constant which can be used with the lifecycle_state property of a AlarmCondition.
A constant which can be used with the lifecycle_state property of a AlarmCondition.
A constant which can be used with the lifecycle_state property of a AlarmCondition.
A constant which can be used with the status property of a AlarmCondition.
A constant which can be used with the status property of a AlarmCondition.
A constant which can be used with the status property of a AlarmCondition.
A constant which can be used with the status property of a AlarmCondition.
Gets the composite_type of this AlarmCondition.
[Required] Gets the condition_type of this AlarmCondition.
[Required] Gets the conditions of this AlarmCondition.
Gets the defined_tags of this AlarmCondition.
Gets the freeform_tags of this AlarmCondition.
[Required] Gets the id of this AlarmCondition.
[Required] Gets the lifecycle_state of this AlarmCondition.
[Required] Gets the metric_name of this AlarmCondition.
[Required] Gets the monitoring_template_id of this AlarmCondition.
[Required] Gets the namespace of this AlarmCondition.
[Required] Gets the resource_type of this AlarmCondition.
[Required] Gets the status of this AlarmCondition.
Gets the system_tags of this AlarmCondition.
Gets the time_created of this AlarmCondition.
Gets the time_updated of this AlarmCondition.
Methods:
__init__(**kwargs)Initializes a new AlarmCondition object with values from keyword arguments.
- CONDITION_TYPE_AVAILABILITY = 'AVAILABILITY'¶
A constant which can be used with the condition_type property of a AlarmCondition. This constant has a value of “AVAILABILITY”
- CONDITION_TYPE_FIXED = 'FIXED'¶
A constant which can be used with the condition_type property of a AlarmCondition. This constant has a value of “FIXED”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a AlarmCondition. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a AlarmCondition. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a AlarmCondition. This constant has a value of “DELETED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a AlarmCondition. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a AlarmCondition. This constant has a value of “UPDATING”
- STATUS_APPLIED = 'APPLIED'¶
A constant which can be used with the status property of a AlarmCondition. This constant has a value of “APPLIED”
- STATUS_ERROR = 'ERROR'¶
A constant which can be used with the status property of a AlarmCondition. This constant has a value of “ERROR”
- STATUS_NOT_APPLIED = 'NOT_APPLIED'¶
A constant which can be used with the status property of a AlarmCondition. This constant has a value of “NOT_APPLIED”
- STATUS_PARTIAL_APPLIED = 'PARTIAL_APPLIED'¶
A constant which can be used with the status property of a AlarmCondition. This constant has a value of “PARTIAL_APPLIED”
- __init__(**kwargs)¶
Initializes a new AlarmCondition 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 AlarmCondition.
monitoring_template_id (str) – The value to assign to the monitoring_template_id property of this AlarmCondition.
namespace (str) – The value to assign to the namespace property of this AlarmCondition.
composite_type (str) – The value to assign to the composite_type property of this AlarmCondition.
resource_type (str) – The value to assign to the resource_type property of this AlarmCondition.
metric_name (str) – The value to assign to the metric_name property of this AlarmCondition.
condition_type (str) – The value to assign to the condition_type property of this AlarmCondition. Allowed values for this property are: “FIXED”, “AVAILABILITY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
conditions (list[oci.stack_monitoring.models.Condition]) – The value to assign to the conditions property of this AlarmCondition.
status (str) – The value to assign to the status property of this AlarmCondition. Allowed values for this property are: “NOT_APPLIED”, “APPLIED”, “PARTIAL_APPLIED”, “ERROR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this AlarmCondition. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “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 AlarmCondition.
time_updated (datetime) – The value to assign to the time_updated property of this AlarmCondition.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AlarmCondition.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AlarmCondition.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this AlarmCondition.
- property composite_type¶
Gets the composite_type of this AlarmCondition. The OCID of the composite resource type like EBS/PEOPLE_SOFT.
- Returns
The composite_type of this AlarmCondition.
- Return type
str
- property condition_type¶
[Required] Gets the condition_type of this AlarmCondition. Type of defined monitoring template.
Allowed values for this property are: “FIXED”, “AVAILABILITY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The condition_type of this AlarmCondition.
- Return type
str
- property conditions¶
[Required] Gets the conditions of this AlarmCondition. Monitoring template conditions
- Returns
The conditions of this AlarmCondition.
- Return type
- property defined_tags¶
Gets the defined_tags of this AlarmCondition. 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 AlarmCondition.
- Return type
dict(str, dict(str, object))
- property freeform_tags¶
Gets the freeform_tags of this AlarmCondition. 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 AlarmCondition.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this AlarmCondition. The OCID of the Alarm Condition.
- Returns
The id of this AlarmCondition.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this AlarmCondition. The current lifecycle state of the monitoring template
Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this AlarmCondition.
- Return type
str
- property metric_name¶
[Required] Gets the metric_name of this AlarmCondition. The metric name.
- Returns
The metric_name of this AlarmCondition.
- Return type
str
- property monitoring_template_id¶
[Required] Gets the monitoring_template_id of this AlarmCondition. The OCID of the monitoring template.
- Returns
The monitoring_template_id of this AlarmCondition.
- Return type
str
- property namespace¶
[Required] Gets the namespace of this AlarmCondition. The stack monitoring service or application emitting the metric that is evaluated by the alarm.
- Returns
The namespace of this AlarmCondition.
- Return type
str
- property resource_type¶
[Required] Gets the resource_type of this AlarmCondition. The resource type OCID.
- Returns
The resource_type of this AlarmCondition.
- Return type
str
- property status¶
[Required] Gets the status of this AlarmCondition. The current status of the monitoring template i.e. whether it is Published or Unpublished
Allowed values for this property are: “NOT_APPLIED”, “APPLIED”, “PARTIAL_APPLIED”, “ERROR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The status of this AlarmCondition.
- Return type
str
- property system_tags¶
Gets the system_tags of this AlarmCondition. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this AlarmCondition.
- Return type
dict(str, dict(str, object))
- property time_created¶
Gets the time_created of this AlarmCondition. The date and time the alarm condition was created. Format defined by RFC3339.
- Returns
The time_created of this AlarmCondition.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this AlarmCondition. The date and time the alarm condition was updated. Format defined by RFC3339.
- Returns
The time_updated of this AlarmCondition.
- Return type
datetime