oci 2.125.3__py3-none-any.whl → 2.126.0__py3-none-any.whl

oci/cloud_guard/models/resource_vulnerability_summary.py

@@ -0,0 +1,279 @@
+# 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: 20200131
+
+
+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 ResourceVulnerabilitySummary(object):
+    """
+    Summary of CG vulnerability in the resourceView
+    """
+
+    #: A constant which can be used with the risk_level property of a ResourceVulnerabilitySummary.
+    #: This constant has a value of "CRITICAL"
+    RISK_LEVEL_CRITICAL = "CRITICAL"
+
+    #: A constant which can be used with the risk_level property of a ResourceVulnerabilitySummary.
+    #: This constant has a value of "HIGH"
+    RISK_LEVEL_HIGH = "HIGH"
+
+    #: A constant which can be used with the risk_level property of a ResourceVulnerabilitySummary.
+    #: This constant has a value of "MEDIUM"
+    RISK_LEVEL_MEDIUM = "MEDIUM"
+
+    #: A constant which can be used with the risk_level property of a ResourceVulnerabilitySummary.
+    #: This constant has a value of "LOW"
+    RISK_LEVEL_LOW = "LOW"
+
+    #: A constant which can be used with the risk_level property of a ResourceVulnerabilitySummary.
+    #: This constant has a value of "MINOR"
+    RISK_LEVEL_MINOR = "MINOR"
+
+    #: A constant which can be used with the risk_level property of a ResourceVulnerabilitySummary.
+    #: This constant has a value of "NONE"
+    RISK_LEVEL_NONE = "NONE"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ResourceVulnerabilitySummary object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param id:
+            The value to assign to the id property of this ResourceVulnerabilitySummary.
+        :type id: str
+
+        :param description:
+            The value to assign to the description property of this ResourceVulnerabilitySummary.
+        :type description: str
+
+        :param risk_level:
+            The value to assign to the risk_level property of this ResourceVulnerabilitySummary.
+            Allowed values for this property are: "CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR", "NONE", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type risk_level: str
+
+        :param freeform_tags:
+            The value to assign to the freeform_tags property of this ResourceVulnerabilitySummary.
+        :type freeform_tags: dict(str, str)
+
+        :param defined_tags:
+            The value to assign to the defined_tags property of this ResourceVulnerabilitySummary.
+        :type defined_tags: dict(str, dict(str, object))
+
+        :param system_tags:
+            The value to assign to the system_tags property of this ResourceVulnerabilitySummary.
+        :type system_tags: dict(str, dict(str, object))
+
+        """
+        self.swagger_types = {
+            'id': 'str',
+            'description': 'str',
+            'risk_level': 'str',
+            'freeform_tags': 'dict(str, str)',
+            'defined_tags': 'dict(str, dict(str, object))',
+            'system_tags': 'dict(str, dict(str, object))'
+        }
+
+        self.attribute_map = {
+            'id': 'id',
+            'description': 'description',
+            'risk_level': 'riskLevel',
+            'freeform_tags': 'freeformTags',
+            'defined_tags': 'definedTags',
+            'system_tags': 'systemTags'
+        }
+
+        self._id = None
+        self._description = None
+        self._risk_level = None
+        self._freeform_tags = None
+        self._defined_tags = None
+        self._system_tags = None
+
+    @property
+    def id(self):
+        """
+        **[Required]** Gets the id of this ResourceVulnerabilitySummary.
+        The cve id of the vulnerability
+
+
+        :return: The id of this ResourceVulnerabilitySummary.
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """
+        Sets the id of this ResourceVulnerabilitySummary.
+        The cve id of the vulnerability
+
+
+        :param id: The id of this ResourceVulnerabilitySummary.
+        :type: str
+        """
+        self._id = id
+
+    @property
+    def description(self):
+        """
+        **[Required]** Gets the description of this ResourceVulnerabilitySummary.
+        The description of the vulnerability
+
+
+        :return: The description of this ResourceVulnerabilitySummary.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """
+        Sets the description of this ResourceVulnerabilitySummary.
+        The description of the vulnerability
+
+
+        :param description: The description of this ResourceVulnerabilitySummary.
+        :type: str
+        """
+        self._description = description
+
+    @property
+    def risk_level(self):
+        """
+        **[Required]** Gets the risk_level of this ResourceVulnerabilitySummary.
+        The Risk Level
+
+        Allowed values for this property are: "CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR", "NONE", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The risk_level of this ResourceVulnerabilitySummary.
+        :rtype: str
+        """
+        return self._risk_level
+
+    @risk_level.setter
+    def risk_level(self, risk_level):
+        """
+        Sets the risk_level of this ResourceVulnerabilitySummary.
+        The Risk Level
+
+
+        :param risk_level: The risk_level of this ResourceVulnerabilitySummary.
+        :type: str
+        """
+        allowed_values = ["CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR", "NONE"]
+        if not value_allowed_none_or_none_sentinel(risk_level, allowed_values):
+            risk_level = 'UNKNOWN_ENUM_VALUE'
+        self._risk_level = risk_level
+
+    @property
+    def freeform_tags(self):
+        """
+        Gets the freeform_tags of this ResourceVulnerabilitySummary.
+        Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
+        Example: `{\"bar-key\": \"value\"}`
+
+        Avoid entering confidential information.
+
+
+        :return: The freeform_tags of this ResourceVulnerabilitySummary.
+        :rtype: dict(str, str)
+        """
+        return self._freeform_tags
+
+    @freeform_tags.setter
+    def freeform_tags(self, freeform_tags):
+        """
+        Sets the freeform_tags of this ResourceVulnerabilitySummary.
+        Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
+        Example: `{\"bar-key\": \"value\"}`
+
+        Avoid entering confidential information.
+
+
+        :param freeform_tags: The freeform_tags of this ResourceVulnerabilitySummary.
+        :type: dict(str, str)
+        """
+        self._freeform_tags = freeform_tags
+
+    @property
+    def defined_tags(self):
+        """
+        Gets the defined_tags of this ResourceVulnerabilitySummary.
+        Defined tags for this resource. Each key is predefined and scoped to a namespace.
+        Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
+
+
+        :return: The defined_tags of this ResourceVulnerabilitySummary.
+        :rtype: dict(str, dict(str, object))
+        """
+        return self._defined_tags
+
+    @defined_tags.setter
+    def defined_tags(self, defined_tags):
+        """
+        Sets the defined_tags of this ResourceVulnerabilitySummary.
+        Defined tags for this resource. Each key is predefined and scoped to a namespace.
+        Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
+
+
+        :param defined_tags: The defined_tags of this ResourceVulnerabilitySummary.
+        :type: dict(str, dict(str, object))
+        """
+        self._defined_tags = defined_tags
+
+    @property
+    def system_tags(self):
+        """
+        Gets the system_tags of this ResourceVulnerabilitySummary.
+        System tags for this resource. Each key is predefined and scoped to a namespace.
+        For more information, see `Resource Tags`__.
+        System tags can be viewed by users, but can only be created by the system.
+
+        Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
+
+
+        :return: The system_tags of this ResourceVulnerabilitySummary.
+        :rtype: dict(str, dict(str, object))
+        """
+        return self._system_tags
+
+    @system_tags.setter
+    def system_tags(self, system_tags):
+        """
+        Sets the system_tags of this ResourceVulnerabilitySummary.
+        System tags for this resource. Each key is predefined and scoped to a namespace.
+        For more information, see `Resource Tags`__.
+        System tags can be viewed by users, but can only be created by the system.
+
+        Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
+
+
+        :param system_tags: The system_tags of this ResourceVulnerabilitySummary.
+        :type: dict(str, dict(str, object))
+        """
+        self._system_tags = system_tags
+
+    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/cloud_guard/models/responder_activity_collection.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class ResponderActivityCollection(object):
     """
-    Provides the summary of responder activities and their corresponding count value.
+    Provides a summary of responder activities and their corresponding count values.
     """
 
     def __init__(self, **kwargs):
@@ -39,7 +39,7 @@ class ResponderActivityCollection(object):
     def items(self):
         """
         **[Required]** Gets the items of this ResponderActivityCollection.
-        List of ResponderActivitySummary
+        List of ResponderActivitySummary resources
 
 
         :return: The items of this ResponderActivityCollection.
@@ -51,7 +51,7 @@ class ResponderActivityCollection(object):
     def items(self, items):
         """
         Sets the items of this ResponderActivityCollection.
-        List of ResponderActivitySummary
+        List of ResponderActivitySummary resources
 
 
         :param items: The items of this ResponderActivityCollection.

oci/cloud_guard/models/responder_activity_summary.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class ResponderActivitySummary(object):
     """
-    Responder Activity summary Definition.
+    Responder activity summary definition.
     """
 
     #: A constant which can be used with the responder_type property of a ResponderActivitySummary.
@@ -145,7 +145,7 @@ class ResponderActivitySummary(object):
     def id(self):
         """
         **[Required]** Gets the id of this ResponderActivitySummary.
-        Unique id for Responder activity.
+        Unique ID for responder activity
 
 
         :return: The id of this ResponderActivitySummary.
@@ -157,7 +157,7 @@ class ResponderActivitySummary(object):
     def id(self, id):
         """
         Sets the id of this ResponderActivitySummary.
-        Unique id for Responder activity.
+        Unique ID for responder activity
 
 
         :param id: The id of this ResponderActivitySummary.
@@ -169,7 +169,7 @@ class ResponderActivitySummary(object):
     def problem_id(self):
         """
         **[Required]** Gets the problem_id of this ResponderActivitySummary.
-        problemId for which Responder activity is associated to.
+        Unique ID of problem associated with responder activity
 
 
         :return: The problem_id of this ResponderActivitySummary.
@@ -181,7 +181,7 @@ class ResponderActivitySummary(object):
     def problem_id(self, problem_id):
         """
         Sets the problem_id of this ResponderActivitySummary.
-        problemId for which Responder activity is associated to.
+        Unique ID of problem associated with responder activity
 
 
         :param problem_id: The problem_id of this ResponderActivitySummary.
@@ -193,7 +193,7 @@ class ResponderActivitySummary(object):
     def responder_rule_id(self):
         """
         **[Required]** Gets the responder_rule_id of this ResponderActivitySummary.
-        Id of the responder rule for the problem
+        Unique ID of the responder rule associated with the problem
 
 
         :return: The responder_rule_id of this ResponderActivitySummary.
@@ -205,7 +205,7 @@ class ResponderActivitySummary(object):
     def responder_rule_id(self, responder_rule_id):
         """
         Sets the responder_rule_id of this ResponderActivitySummary.
-        Id of the responder rule for the problem
+        Unique ID of the responder rule associated with the problem
 
 
         :param responder_rule_id: The responder_rule_id of this ResponderActivitySummary.
@@ -217,7 +217,7 @@ class ResponderActivitySummary(object):
     def responder_type(self):
         """
         **[Required]** Gets the responder_type of this ResponderActivitySummary.
-        responder rule type for performing the operation
+        Responder rule type for performing the operation
 
         Allowed values for this property are: "REMEDIATION", "NOTIFICATION", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
@@ -232,7 +232,7 @@ class ResponderActivitySummary(object):
     def responder_type(self, responder_type):
         """
         Sets the responder_type of this ResponderActivitySummary.
-        responder rule type for performing the operation
+        Responder rule type for performing the operation
 
 
         :param responder_type: The responder_type of this ResponderActivitySummary.
@@ -247,7 +247,7 @@ class ResponderActivitySummary(object):
     def responder_rule_name(self):
         """
         **[Required]** Gets the responder_rule_name of this ResponderActivitySummary.
-        responder rule name
+        Responder rule name
 
 
         :return: The responder_rule_name of this ResponderActivitySummary.
@@ -259,7 +259,7 @@ class ResponderActivitySummary(object):
     def responder_rule_name(self, responder_rule_name):
         """
         Sets the responder_rule_name of this ResponderActivitySummary.
-        responder rule name
+        Responder rule name
 
 
         :param responder_rule_name: The responder_rule_name of this ResponderActivitySummary.
@@ -271,7 +271,7 @@ class ResponderActivitySummary(object):
     def responder_activity_type(self):
         """
         **[Required]** Gets the responder_activity_type of this ResponderActivitySummary.
-        Responder activity types
+        Responder activity type
 
         Allowed values for this property are: "STARTED", "COMPLETED", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
@@ -286,7 +286,7 @@ class ResponderActivitySummary(object):
     def responder_activity_type(self, responder_activity_type):
         """
         Sets the responder_activity_type of this ResponderActivitySummary.
-        Responder activity types
+        Responder activity type
 
 
         :param responder_activity_type: The responder_activity_type of this ResponderActivitySummary.
@@ -301,7 +301,7 @@ class ResponderActivitySummary(object):
     def responder_execution_status(self):
         """
         **[Required]** Gets the responder_execution_status of this ResponderActivitySummary.
-        the responder execution status
+        Responder execution status
 
         Allowed values for this property are: "STARTED", "AWAITING_CONFIRMATION", "AWAITING_INPUT", "SUCCEEDED", "FAILED", "SKIPPED", "ALL", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
@@ -316,7 +316,7 @@ class ResponderActivitySummary(object):
     def responder_execution_status(self, responder_execution_status):
         """
         Sets the responder_execution_status of this ResponderActivitySummary.
-        the responder execution status
+        Responder execution status
 
 
         :param responder_execution_status: The responder_execution_status of this ResponderActivitySummary.
@@ -331,7 +331,7 @@ class ResponderActivitySummary(object):
     def time_created(self):
         """
         **[Required]** Gets the time_created of this ResponderActivitySummary.
-        responder activity starting time
+        Responder activity starting time
 
 
         :return: The time_created of this ResponderActivitySummary.
@@ -343,7 +343,7 @@ class ResponderActivitySummary(object):
     def time_created(self, time_created):
         """
         Sets the time_created of this ResponderActivitySummary.
-        responder activity starting time
+        Responder activity starting time
 
 
         :param time_created: The time_created of this ResponderActivitySummary.
@@ -355,7 +355,7 @@ class ResponderActivitySummary(object):
     def message(self):
         """
         **[Required]** Gets the message of this ResponderActivitySummary.
-        additional message related to this operation
+        Additional message related to this operation
 
 
         :return: The message of this ResponderActivitySummary.
@@ -367,7 +367,7 @@ class ResponderActivitySummary(object):
     def message(self, message):
         """
         Sets the message of this ResponderActivitySummary.
-        additional message related to this operation
+        Additional message related to this operation
 
 
         :param message: The message of this ResponderActivitySummary.

oci/cloud_guard/models/responder_configuration.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class ResponderConfiguration(object):
     """
-    A single configuration applied to a responder
+    Details for a configuration to be applied to a responder.
     """
 
     def __init__(self, **kwargs):
@@ -53,7 +53,7 @@ class ResponderConfiguration(object):
     def config_key(self):
         """
         **[Required]** Gets the config_key of this ResponderConfiguration.
-        Unique name of the configuration
+        Unique identifier of the configuration
 
 
         :return: The config_key of this ResponderConfiguration.
@@ -65,7 +65,7 @@ class ResponderConfiguration(object):
     def config_key(self, config_key):
         """
         Sets the config_key of this ResponderConfiguration.
-        Unique name of the configuration
+        Unique identifier of the configuration
 
 
         :param config_key: The config_key of this ResponderConfiguration.
@@ -77,7 +77,7 @@ class ResponderConfiguration(object):
     def name(self):
         """
         **[Required]** Gets the name of this ResponderConfiguration.
-        configuration name
+        Configuration name
 
 
         :return: The name of this ResponderConfiguration.
@@ -89,7 +89,7 @@ class ResponderConfiguration(object):
     def name(self, name):
         """
         Sets the name of this ResponderConfiguration.
-        configuration name
+        Configuration name
 
 
         :param name: The name of this ResponderConfiguration.
@@ -101,7 +101,7 @@ class ResponderConfiguration(object):
     def value(self):
         """
         **[Required]** Gets the value of this ResponderConfiguration.
-        configuration value
+        Configuration value
 
 
         :return: The value of this ResponderConfiguration.
@@ -113,7 +113,7 @@ class ResponderConfiguration(object):
     def value(self, value):
         """
         Sets the value of this ResponderConfiguration.
-        configuration value
+        Configuration value
 
 
         :param value: The value of this ResponderConfiguration.