oci 2.124.2__py3-none-any.whl → 2.125.1__py3-none-any.whl

oci/monitoring/models/alarm.py

@@ -160,6 +160,18 @@ class Alarm(object):
             The value to assign to the defined_tags property of this Alarm.
         :type defined_tags: dict(str, dict(str, object))
 
+        :param overrides:
+            The value to assign to the overrides property of this Alarm.
+        :type overrides: list[oci.monitoring.models.AlarmOverride]
+
+        :param rule_name:
+            The value to assign to the rule_name property of this Alarm.
+        :type rule_name: str
+
+        :param notification_version:
+            The value to assign to the notification_version property of this Alarm.
+        :type notification_version: str
+
         :param lifecycle_state:
             The value to assign to the lifecycle_state property of this Alarm.
             Allowed values for this property are: "ACTIVE", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'.
@@ -196,6 +208,9 @@ class Alarm(object):
             'is_enabled': 'bool',
             'freeform_tags': 'dict(str, str)',
             'defined_tags': 'dict(str, dict(str, object))',
+            'overrides': 'list[AlarmOverride]',
+            'rule_name': 'str',
+            'notification_version': 'str',
             'lifecycle_state': 'str',
             'time_created': 'datetime',
             'time_updated': 'datetime'
@@ -222,6 +237,9 @@ class Alarm(object):
             'is_enabled': 'isEnabled',
             'freeform_tags': 'freeformTags',
             'defined_tags': 'definedTags',
+            'overrides': 'overrides',
+            'rule_name': 'ruleName',
+            'notification_version': 'notificationVersion',
             'lifecycle_state': 'lifecycleState',
             'time_created': 'timeCreated',
             'time_updated': 'timeUpdated'
@@ -247,6 +265,9 @@ class Alarm(object):
         self._is_enabled = None
         self._freeform_tags = None
         self._defined_tags = None
+        self._overrides = None
+        self._rule_name = None
+        self._notification_version = None
         self._lifecycle_state = None
         self._time_created = None
         self._time_updated = None
@@ -931,6 +952,92 @@ class Alarm(object):
         """
         self._defined_tags = defined_tags
 
+    @property
+    def overrides(self):
+        """
+        Gets the overrides of this Alarm.
+        A set of overrides that control evaluations of the alarm.
+
+        Each override can specify values for query, severity, body, and pending duration.
+        When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position `0`),
+        and then evaluates the alarm's base values (`ruleName` value of `BASE`).
+
+
+        :return: The overrides of this Alarm.
+        :rtype: list[oci.monitoring.models.AlarmOverride]
+        """
+        return self._overrides
+
+    @overrides.setter
+    def overrides(self, overrides):
+        """
+        Sets the overrides of this Alarm.
+        A set of overrides that control evaluations of the alarm.
+
+        Each override can specify values for query, severity, body, and pending duration.
+        When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position `0`),
+        and then evaluates the alarm's base values (`ruleName` value of `BASE`).
+
+
+        :param overrides: The overrides of this Alarm.
+        :type: list[oci.monitoring.models.AlarmOverride]
+        """
+        self._overrides = overrides
+
+    @property
+    def rule_name(self):
+        """
+        Gets the rule_name of this Alarm.
+        Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides.
+        A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets.
+        Minimum number of characters: 3. Default value is `BASE`. For information about alarm overrides, see :func:`alarm_override`.
+
+
+        :return: The rule_name of this Alarm.
+        :rtype: str
+        """
+        return self._rule_name
+
+    @rule_name.setter
+    def rule_name(self, rule_name):
+        """
+        Sets the rule_name of this Alarm.
+        Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides.
+        A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets.
+        Minimum number of characters: 3. Default value is `BASE`. For information about alarm overrides, see :func:`alarm_override`.
+
+
+        :param rule_name: The rule_name of this Alarm.
+        :type: str
+        """
+        self._rule_name = rule_name
+
+    @property
+    def notification_version(self):
+        """
+        Gets the notification_version of this Alarm.
+        The version of the alarm notification to be delivered. Allowed value: `1.X`
+        The value must start with a number (up to four digits), followed by a period and an uppercase X.
+
+
+        :return: The notification_version of this Alarm.
+        :rtype: str
+        """
+        return self._notification_version
+
+    @notification_version.setter
+    def notification_version(self, notification_version):
+        """
+        Sets the notification_version of this Alarm.
+        The version of the alarm notification to be delivered. Allowed value: `1.X`
+        The value must start with a number (up to four digits), followed by a period and an uppercase X.
+
+
+        :param notification_version: The notification_version of this Alarm.
+        :type: str
+        """
+        self._notification_version = notification_version
+
     @property
     def lifecycle_state(self):
         """

oci/monitoring/models/alarm_dimension_states_entry.py

@@ -38,6 +38,10 @@ class AlarmDimensionStatesEntry(object):
             Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
         :type status: str
 
+        :param rule_name:
+            The value to assign to the rule_name property of this AlarmDimensionStatesEntry.
+        :type rule_name: str
+
         :param timestamp:
             The value to assign to the timestamp property of this AlarmDimensionStatesEntry.
         :type timestamp: datetime
@@ -46,17 +50,20 @@ class AlarmDimensionStatesEntry(object):
         self.swagger_types = {
             'dimensions': 'dict(str, str)',
             'status': 'str',
+            'rule_name': 'str',
             'timestamp': 'datetime'
         }
 
         self.attribute_map = {
             'dimensions': 'dimensions',
             'status': 'status',
+            'rule_name': 'ruleName',
             'timestamp': 'timestamp'
         }
 
         self._dimensions = None
         self._status = None
+        self._rule_name = None
         self._timestamp = None
 
     @property
@@ -117,6 +124,34 @@ class AlarmDimensionStatesEntry(object):
             status = 'UNKNOWN_ENUM_VALUE'
         self._status = status
 
+    @property
+    def rule_name(self):
+        """
+        **[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.
+        A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets.
+        Minimum number of characters: 3. Default value is `BASE`. For information about alarm overrides, see :func:`alarm_override`.
+
+
+        :return: The rule_name of this AlarmDimensionStatesEntry.
+        :rtype: str
+        """
+        return self._rule_name
+
+    @rule_name.setter
+    def rule_name(self, rule_name):
+        """
+        Sets the rule_name of this AlarmDimensionStatesEntry.
+        Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides.
+        A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets.
+        Minimum number of characters: 3. Default value is `BASE`. For information about alarm overrides, see :func:`alarm_override`.
+
+
+        :param rule_name: The rule_name of this AlarmDimensionStatesEntry.
+        :type: str
+        """
+        self._rule_name = rule_name
+
     @property
     def timestamp(self):
         """

oci/monitoring/models/alarm_override.py

@@ -0,0 +1,304 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20180401
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class AlarmOverride(object):
+    """
+    Values to use for an independent evaluation of the alarm.
+    You can specify values for query, severity, body, and pending duration.
+    When an alarm contains overrides, the Monitoring service evaluates each override in order,
+    beginning with the first override in the array (index position `0`),
+    and then evaluates the alarm's base values (`ruleName` value of `BASE`)
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new AlarmOverride object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param pending_duration:
+            The value to assign to the pending_duration property of this AlarmOverride.
+        :type pending_duration: str
+
+        :param severity:
+            The value to assign to the severity property of this AlarmOverride.
+        :type severity: str
+
+        :param body:
+            The value to assign to the body property of this AlarmOverride.
+        :type body: str
+
+        :param rule_name:
+            The value to assign to the rule_name property of this AlarmOverride.
+        :type rule_name: str
+
+        :param query:
+            The value to assign to the query property of this AlarmOverride.
+        :type query: str
+
+        """
+        self.swagger_types = {
+            'pending_duration': 'str',
+            'severity': 'str',
+            'body': 'str',
+            'rule_name': 'str',
+            'query': 'str'
+        }
+
+        self.attribute_map = {
+            'pending_duration': 'pendingDuration',
+            'severity': 'severity',
+            'body': 'body',
+            'rule_name': 'ruleName',
+            'query': 'query'
+        }
+
+        self._pending_duration = None
+        self._severity = None
+        self._body = None
+        self._rule_name = None
+        self._query = None
+
+    @property
+    def pending_duration(self):
+        """
+        Gets the pending_duration of this AlarmOverride.
+        The period of time that the condition defined in the alarm must persist before the alarm state
+        changes from \"OK\" to \"FIRING\". For example, a value of 5 minutes means that the
+        alarm must persist in breaching the condition for five minutes before the alarm updates its
+        state to \"FIRING\".
+
+        The duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H`
+        for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M.
+
+        Under the default value of PT1M, the first evaluation that breaches the alarm updates the
+        state to \"FIRING\".
+
+        The alarm updates its status to \"OK\" when the breaching condition has been clear for
+        the most recent minute.
+
+        Example: `PT5M`
+
+
+        :return: The pending_duration of this AlarmOverride.
+        :rtype: str
+        """
+        return self._pending_duration
+
+    @pending_duration.setter
+    def pending_duration(self, pending_duration):
+        """
+        Sets the pending_duration of this AlarmOverride.
+        The period of time that the condition defined in the alarm must persist before the alarm state
+        changes from \"OK\" to \"FIRING\". For example, a value of 5 minutes means that the
+        alarm must persist in breaching the condition for five minutes before the alarm updates its
+        state to \"FIRING\".
+
+        The duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H`
+        for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M.
+
+        Under the default value of PT1M, the first evaluation that breaches the alarm updates the
+        state to \"FIRING\".
+
+        The alarm updates its status to \"OK\" when the breaching condition has been clear for
+        the most recent minute.
+
+        Example: `PT5M`
+
+
+        :param pending_duration: The pending_duration of this AlarmOverride.
+        :type: str
+        """
+        self._pending_duration = pending_duration
+
+    @property
+    def severity(self):
+        """
+        Gets the severity of this AlarmOverride.
+        The perceived severity of the alarm with regard to the affected system.
+
+        Example: `CRITICAL`
+
+
+        :return: The severity of this AlarmOverride.
+        :rtype: str
+        """
+        return self._severity
+
+    @severity.setter
+    def severity(self, severity):
+        """
+        Sets the severity of this AlarmOverride.
+        The perceived severity of the alarm with regard to the affected system.
+
+        Example: `CRITICAL`
+
+
+        :param severity: The severity of this AlarmOverride.
+        :type: str
+        """
+        self._severity = severity
+
+    @property
+    def body(self):
+        """
+        Gets the body of this AlarmOverride.
+        The human-readable content of the delivered alarm notification. Oracle recommends providing guidance
+        to operators for resolving the alarm condition. Consider adding links to standard runbook
+        practices. Avoid entering confidential information.
+
+        Example: `High CPU usage alert. Follow runbook instructions for resolution.`
+
+
+        :return: The body of this AlarmOverride.
+        :rtype: str
+        """
+        return self._body
+
+    @body.setter
+    def body(self, body):
+        """
+        Sets the body of this AlarmOverride.
+        The human-readable content of the delivered alarm notification. Oracle recommends providing guidance
+        to operators for resolving the alarm condition. Consider adding links to standard runbook
+        practices. Avoid entering confidential information.
+
+        Example: `High CPU usage alert. Follow runbook instructions for resolution.`
+
+
+        :param body: The body of this AlarmOverride.
+        :type: str
+        """
+        self._body = body
+
+    @property
+    def rule_name(self):
+        """
+        Gets the rule_name of this AlarmOverride.
+        A user-friendly description for this alarm override. Must be unique across all `ruleName` values for the alarm.
+
+
+        :return: The rule_name of this AlarmOverride.
+        :rtype: str
+        """
+        return self._rule_name
+
+    @rule_name.setter
+    def rule_name(self, rule_name):
+        """
+        Sets the rule_name of this AlarmOverride.
+        A user-friendly description for this alarm override. Must be unique across all `ruleName` values for the alarm.
+
+
+        :param rule_name: The rule_name of this AlarmOverride.
+        :type: str
+        """
+        self._rule_name = rule_name
+
+    @property
+    def query(self):
+        """
+        Gets the query of this AlarmOverride.
+        The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of
+        the Monitoring service interprets results for each returned time series as Boolean values,
+        where zero represents false and a non-zero value represents true. A true value means that the trigger
+        rule condition has been met. The query must specify a metric, statistic, interval, and trigger
+        rule (threshold or absence). Supported values for interval depend on the specified time range. More
+        interval values are supported for smaller time ranges. You can optionally
+        specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`.
+        For information about writing MQL expressions, see
+        `Editing the MQL Expression for a Query`__.
+        For details about MQL, see
+        `Monitoring Query Language (MQL) Reference`__.
+        For available dimensions, review the metric definition for the supported service. See
+        `Supported Services`__.
+
+        Example of threshold alarm:
+
+          -----
+
+            CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.groupBy(availabilityDomain).percentile(0.9) > 85
+
+          -----
+
+        Example of absence alarm:
+
+          -----
+
+            CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.absent()
+
+          -----
+
+        __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm
+        __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm
+        __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices
+
+
+        :return: The query of this AlarmOverride.
+        :rtype: str
+        """
+        return self._query
+
+    @query.setter
+    def query(self, query):
+        """
+        Sets the query of this AlarmOverride.
+        The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of
+        the Monitoring service interprets results for each returned time series as Boolean values,
+        where zero represents false and a non-zero value represents true. A true value means that the trigger
+        rule condition has been met. The query must specify a metric, statistic, interval, and trigger
+        rule (threshold or absence). Supported values for interval depend on the specified time range. More
+        interval values are supported for smaller time ranges. You can optionally
+        specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`.
+        For information about writing MQL expressions, see
+        `Editing the MQL Expression for a Query`__.
+        For details about MQL, see
+        `Monitoring Query Language (MQL) Reference`__.
+        For available dimensions, review the metric definition for the supported service. See
+        `Supported Services`__.
+
+        Example of threshold alarm:
+
+          -----
+
+            CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.groupBy(availabilityDomain).percentile(0.9) > 85
+
+          -----
+
+        Example of absence alarm:
+
+          -----
+
+            CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.absent()
+
+          -----
+
+        __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm
+        __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm
+        __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices
+
+
+        :param query: The query of this AlarmOverride.
+        :type: str
+        """
+        self._query = query
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/monitoring/models/alarm_status_summary.py

@@ -78,6 +78,10 @@ class AlarmStatusSummary(object):
             Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
         :type severity: str
 
+        :param rule_name:
+            The value to assign to the rule_name property of this AlarmStatusSummary.
+        :type rule_name: str
+
         :param timestamp_triggered:
             The value to assign to the timestamp_triggered property of this AlarmStatusSummary.
         :type timestamp_triggered: datetime
@@ -97,6 +101,7 @@ class AlarmStatusSummary(object):
             'id': 'str',
             'display_name': 'str',
             'severity': 'str',
+            'rule_name': 'str',
             'timestamp_triggered': 'datetime',
             'status': 'str',
             'suppression': 'Suppression'
@@ -106,6 +111,7 @@ class AlarmStatusSummary(object):
             'id': 'id',
             'display_name': 'displayName',
             'severity': 'severity',
+            'rule_name': 'ruleName',
             'timestamp_triggered': 'timestampTriggered',
             'status': 'status',
             'suppression': 'suppression'
@@ -114,6 +120,7 @@ class AlarmStatusSummary(object):
         self._id = None
         self._display_name = None
         self._severity = None
+        self._rule_name = None
         self._timestamp_triggered = None
         self._status = None
         self._suppression = None
@@ -208,6 +215,34 @@ class AlarmStatusSummary(object):
             severity = 'UNKNOWN_ENUM_VALUE'
         self._severity = severity
 
+    @property
+    def rule_name(self):
+        """
+        **[Required]** Gets the rule_name of this AlarmStatusSummary.
+        Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides.
+        A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets.
+        Minimum number of characters: 3. Default value is `BASE`. For information about alarm overrides, see :func:`alarm_override`.
+
+
+        :return: The rule_name of this AlarmStatusSummary.
+        :rtype: str
+        """
+        return self._rule_name
+
+    @rule_name.setter
+    def rule_name(self, rule_name):
+        """
+        Sets the rule_name of this AlarmStatusSummary.
+        Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides.
+        A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets.
+        Minimum number of characters: 3. Default value is `BASE`. For information about alarm overrides, see :func:`alarm_override`.
+
+
+        :param rule_name: The rule_name of this AlarmStatusSummary.
+        :type: str
+        """
+        self._rule_name = rule_name
+
     @property
     def timestamp_triggered(self):
         """