oci 2.134.0__py3-none-any.whl → 2.135.0__py3-none-any.whl

oci/monitoring/models/create_alarm_suppression_details.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class CreateAlarmSuppressionDetails(object):
     """
-    The configuration details for creating a dimension-specific alarm suppression.
+    The configuration details for creating an alarm suppression.
     """
 
     def __init__(self, **kwargs):
@@ -24,6 +24,10 @@ class CreateAlarmSuppressionDetails(object):
             The value to assign to the alarm_suppression_target property of this CreateAlarmSuppressionDetails.
         :type alarm_suppression_target: oci.monitoring.models.AlarmSuppressionTarget
 
+        :param level:
+            The value to assign to the level property of this CreateAlarmSuppressionDetails.
+        :type level: str
+
         :param display_name:
             The value to assign to the display_name property of this CreateAlarmSuppressionDetails.
         :type display_name: str
@@ -52,30 +56,39 @@ class CreateAlarmSuppressionDetails(object):
             The value to assign to the defined_tags property of this CreateAlarmSuppressionDetails.
         :type defined_tags: dict(str, dict(str, object))
 
+        :param suppression_conditions:
+            The value to assign to the suppression_conditions property of this CreateAlarmSuppressionDetails.
+        :type suppression_conditions: list[oci.monitoring.models.SuppressionCondition]
+
         """
         self.swagger_types = {
             'alarm_suppression_target': 'AlarmSuppressionTarget',
+            'level': 'str',
             'display_name': 'str',
             'description': 'str',
             'dimensions': 'dict(str, str)',
             'time_suppress_from': 'datetime',
             'time_suppress_until': 'datetime',
             'freeform_tags': 'dict(str, str)',
-            'defined_tags': 'dict(str, dict(str, object))'
+            'defined_tags': 'dict(str, dict(str, object))',
+            'suppression_conditions': 'list[SuppressionCondition]'
         }
 
         self.attribute_map = {
             'alarm_suppression_target': 'alarmSuppressionTarget',
+            'level': 'level',
             'display_name': 'displayName',
             'description': 'description',
             'dimensions': 'dimensions',
             'time_suppress_from': 'timeSuppressFrom',
             'time_suppress_until': 'timeSuppressUntil',
             'freeform_tags': 'freeformTags',
-            'defined_tags': 'definedTags'
+            'defined_tags': 'definedTags',
+            'suppression_conditions': 'suppressionConditions'
         }
 
         self._alarm_suppression_target = None
+        self._level = None
         self._display_name = None
         self._description = None
         self._dimensions = None
@@ -83,6 +96,7 @@ class CreateAlarmSuppressionDetails(object):
         self._time_suppress_until = None
         self._freeform_tags = None
         self._defined_tags = None
+        self._suppression_conditions = None
 
     @property
     def alarm_suppression_target(self):
@@ -104,6 +118,38 @@ class CreateAlarmSuppressionDetails(object):
         """
         self._alarm_suppression_target = alarm_suppression_target
 
+    @property
+    def level(self):
+        """
+        Gets the level of this CreateAlarmSuppressionDetails.
+        The level of this alarm suppression.
+        `ALARM` indicates a suppression of the entire alarm, regardless of dimension.
+        `DIMENSION` indicates a suppression configured for specified dimensions.
+
+        Defaut: `DIMENSION`
+
+
+        :return: The level of this CreateAlarmSuppressionDetails.
+        :rtype: str
+        """
+        return self._level
+
+    @level.setter
+    def level(self, level):
+        """
+        Sets the level of this CreateAlarmSuppressionDetails.
+        The level of this alarm suppression.
+        `ALARM` indicates a suppression of the entire alarm, regardless of dimension.
+        `DIMENSION` indicates a suppression configured for specified dimensions.
+
+        Defaut: `DIMENSION`
+
+
+        :param level: The level of this CreateAlarmSuppressionDetails.
+        :type: str
+        """
+        self._level = level
+
     @property
     def display_name(self):
         """
@@ -169,13 +215,13 @@ class CreateAlarmSuppressionDetails(object):
     @property
     def dimensions(self):
         """
-        **[Required]** Gets the dimensions of this CreateAlarmSuppressionDetails.
+        Gets the dimensions of this CreateAlarmSuppressionDetails.
         A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs.
         If you specify {\"availabilityDomain\": \"phx-ad-1\"}
         and the alarm state entry corresponds to the set {\"availabilityDomain\": \"phx-ad-1\" and \"resourceId\": \"ocid1.instance.region1.phx.exampleuniqueID\"},
         then this alarm will be included for suppression.
 
-        The value cannot be an empty object.
+        This is required only when the value of level is `DIMENSION`. If required, the value cannot be an empty object.
         Only a single value is allowed per key. No grouping of multiple values is allowed under the same key.
         Maximum characters (after serialization): 4000. This maximum satisfies typical use cases.
         The response for an exceeded maximum is `HTTP 400` with an \"dimensions values are too long\" message.
@@ -195,7 +241,7 @@ class CreateAlarmSuppressionDetails(object):
         and the alarm state entry corresponds to the set {\"availabilityDomain\": \"phx-ad-1\" and \"resourceId\": \"ocid1.instance.region1.phx.exampleuniqueID\"},
         then this alarm will be included for suppression.
 
-        The value cannot be an empty object.
+        This is required only when the value of level is `DIMENSION`. If required, the value cannot be an empty object.
         Only a single value is allowed per key. No grouping of multiple values is allowed under the same key.
         Maximum characters (after serialization): 4000. This maximum satisfies typical use cases.
         The response for an exceeded maximum is `HTTP 400` with an \"dimensions values are too long\" message.
@@ -314,6 +360,40 @@ class CreateAlarmSuppressionDetails(object):
         """
         self._defined_tags = defined_tags
 
+    @property
+    def suppression_conditions(self):
+        """
+        Gets the suppression_conditions of this CreateAlarmSuppressionDetails.
+        Array of all preconditions for alarm suppression.
+        Example: `[{
+          conditionType: \"RECURRENCE\",
+          suppressionRecurrence: \"FRQ=DAILY;BYHOUR=10\",
+          suppressionDuration: \"PT1H\"
+        }]`
+
+
+        :return: The suppression_conditions of this CreateAlarmSuppressionDetails.
+        :rtype: list[oci.monitoring.models.SuppressionCondition]
+        """
+        return self._suppression_conditions
+
+    @suppression_conditions.setter
+    def suppression_conditions(self, suppression_conditions):
+        """
+        Sets the suppression_conditions of this CreateAlarmSuppressionDetails.
+        Array of all preconditions for alarm suppression.
+        Example: `[{
+          conditionType: \"RECURRENCE\",
+          suppressionRecurrence: \"FRQ=DAILY;BYHOUR=10\",
+          suppressionDuration: \"PT1H\"
+        }]`
+
+
+        :param suppression_conditions: The suppression_conditions of this CreateAlarmSuppressionDetails.
+        :type: list[oci.monitoring.models.SuppressionCondition]
+        """
+        self._suppression_conditions = suppression_conditions
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/monitoring/models/recurrence.py

@@ -0,0 +1,127 @@
+# 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 .suppression_condition import SuppressionCondition
+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 Recurrence(SuppressionCondition):
+    """
+    Alarm suppression recurring schedule. Only one recurrence condition is supported within the list of preconditions for a suppression (`suppressionConditions`).
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new Recurrence object with values from keyword arguments. The default value of the :py:attr:`~oci.monitoring.models.Recurrence.condition_type` attribute
+        of this class is ``RECURRENCE`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param condition_type:
+            The value to assign to the condition_type property of this Recurrence.
+            Allowed values for this property are: "RECURRENCE"
+        :type condition_type: str
+
+        :param suppression_recurrence:
+            The value to assign to the suppression_recurrence property of this Recurrence.
+        :type suppression_recurrence: str
+
+        :param suppression_duration:
+            The value to assign to the suppression_duration property of this Recurrence.
+        :type suppression_duration: str
+
+        """
+        self.swagger_types = {
+            'condition_type': 'str',
+            'suppression_recurrence': 'str',
+            'suppression_duration': 'str'
+        }
+
+        self.attribute_map = {
+            'condition_type': 'conditionType',
+            'suppression_recurrence': 'suppressionRecurrence',
+            'suppression_duration': 'suppressionDuration'
+        }
+
+        self._condition_type = None
+        self._suppression_recurrence = None
+        self._suppression_duration = None
+        self._condition_type = 'RECURRENCE'
+
+    @property
+    def suppression_recurrence(self):
+        """
+        **[Required]** Gets the suppression_recurrence of this Recurrence.
+        Frequency and start time of the recurring suppression. The format follows
+        `the iCalendar specification (RFC 5545, section 3.3.10)`__.
+        Supported rule parts:
+        * `FREQ`: Frequency of the recurring suppression: `WEEKLY` or `DAILY` only.
+        * `BYDAY`: Comma separated days. Use with weekly suppressions only. Supported values: `MO`, `TU`, `WE`, `TH`, `FR`, `SA` ,`SU`.
+        * `BYHOUR`, `BYMINUTE`, `BYSECOND`: Start time in UTC, after `timeSuppressFrom` value. Default is 00:00:00 UTC after `timeSuppressFrom`.
+
+        __ https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10
+
+
+        :return: The suppression_recurrence of this Recurrence.
+        :rtype: str
+        """
+        return self._suppression_recurrence
+
+    @suppression_recurrence.setter
+    def suppression_recurrence(self, suppression_recurrence):
+        """
+        Sets the suppression_recurrence of this Recurrence.
+        Frequency and start time of the recurring suppression. The format follows
+        `the iCalendar specification (RFC 5545, section 3.3.10)`__.
+        Supported rule parts:
+        * `FREQ`: Frequency of the recurring suppression: `WEEKLY` or `DAILY` only.
+        * `BYDAY`: Comma separated days. Use with weekly suppressions only. Supported values: `MO`, `TU`, `WE`, `TH`, `FR`, `SA` ,`SU`.
+        * `BYHOUR`, `BYMINUTE`, `BYSECOND`: Start time in UTC, after `timeSuppressFrom` value. Default is 00:00:00 UTC after `timeSuppressFrom`.
+
+        __ https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10
+
+
+        :param suppression_recurrence: The suppression_recurrence of this Recurrence.
+        :type: str
+        """
+        self._suppression_recurrence = suppression_recurrence
+
+    @property
+    def suppression_duration(self):
+        """
+        **[Required]** Gets the suppression_duration of this Recurrence.
+        Duration of the recurring suppression. Specified as a string in ISO 8601 format. Minimum: `PT1M` (1 minute). Maximum: `PT24H` (24 hours).
+
+
+        :return: The suppression_duration of this Recurrence.
+        :rtype: str
+        """
+        return self._suppression_duration
+
+    @suppression_duration.setter
+    def suppression_duration(self, suppression_duration):
+        """
+        Sets the suppression_duration of this Recurrence.
+        Duration of the recurring suppression. Specified as a string in ISO 8601 format. Minimum: `PT1M` (1 minute). Maximum: `PT24H` (24 hours).
+
+
+        :param suppression_duration: The suppression_duration of this Recurrence.
+        :type: str
+        """
+        self._suppression_duration = suppression_duration
+
+    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/suppression.py

@@ -14,6 +14,7 @@ class Suppression(object):
     """
     The configuration details for an alarm-wide suppression.
     For dimension-specific suppressions, see :class:`AlarmSuppression`.
+
     For information about alarms, see
     `Alarms Overview`__.
 

oci/monitoring/models/suppression_condition.py

@@ -0,0 +1,101 @@
+# 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 SuppressionCondition(object):
+    """
+    Precondition for an alarm suppression within the suppression date and time range (`timeSuppressFrom` to `timeSuppressUntil`).
+    """
+
+    #: A constant which can be used with the condition_type property of a SuppressionCondition.
+    #: This constant has a value of "RECURRENCE"
+    CONDITION_TYPE_RECURRENCE = "RECURRENCE"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new SuppressionCondition object with values from keyword arguments. This class has the following subclasses and if you are using this class as input
+        to a service operations then you should favor using a subclass over the base class:
+
+        * :class:`~oci.monitoring.models.Recurrence`
+
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param condition_type:
+            The value to assign to the condition_type property of this SuppressionCondition.
+            Allowed values for this property are: "RECURRENCE", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type condition_type: str
+
+        """
+        self.swagger_types = {
+            'condition_type': 'str'
+        }
+
+        self.attribute_map = {
+            'condition_type': 'conditionType'
+        }
+
+        self._condition_type = None
+
+    @staticmethod
+    def get_subtype(object_dictionary):
+        """
+        Given the hash representation of a subtype of this class,
+        use the info in the hash to return the class of the subtype.
+        """
+        type = object_dictionary['conditionType']
+
+        if type == 'RECURRENCE':
+            return 'Recurrence'
+        else:
+            return 'SuppressionCondition'
+
+    @property
+    def condition_type(self):
+        """
+        **[Required]** Gets the condition_type of this SuppressionCondition.
+        Type of suppression condition.
+
+        Allowed values for this property are: "RECURRENCE", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The condition_type of this SuppressionCondition.
+        :rtype: str
+        """
+        return self._condition_type
+
+    @condition_type.setter
+    def condition_type(self, condition_type):
+        """
+        Sets the condition_type of this SuppressionCondition.
+        Type of suppression condition.
+
+
+        :param condition_type: The condition_type of this SuppressionCondition.
+        :type: str
+        """
+        allowed_values = ["RECURRENCE"]
+        if not value_allowed_none_or_none_sentinel(condition_type, allowed_values):
+            condition_type = 'UNKNOWN_ENUM_VALUE'
+        self._condition_type = condition_type
+
+    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