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

oci/cloud_guard/models/responder_recipe.py

@@ -12,7 +12,22 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class ResponderRecipe(object):
     """
-    Details of ResponderRecipe.
+    A ResponderRecipe resource contains a specific instance of one of
+    the supported detector types (for example, activity, configuration,
+    or threat).
+
+    A ResponderRecipe resource:
+    * Is effectively a copy of a Responder resource in which users can make
+    very limited changes if it\u2019s Oracle-managed, and more changes if it\u2019s user-managed.
+    * Can also be created by cloning an existing ResponderRecipe resource, either
+    user-managed or Oracle-managed.
+    * Is visible on Cloud Guard\u2019s Responder Recipes page.
+    * Is located in a specific OCI compartment.
+    * Can be modified by users, programmatically or through the UI.
+    * Changes that can be made here apply globally, to resources in all OCI compartments
+    mapped to a target that attaches the responder recipe, but are overridden by
+    any changes made in the corresponding TargetResponderRecipe resource (effectively
+    created when the responder recipe is attached to the target).
     """
 
     #: A constant which can be used with the owner property of a ResponderRecipe.
@@ -177,7 +192,7 @@ class ResponderRecipe(object):
     def id(self):
         """
         **[Required]** Gets the id of this ResponderRecipe.
-        Identifier for ResponderRecipe.
+        Unique identifier for the responder recip
 
 
         :return: The id of this ResponderRecipe.
@@ -189,7 +204,7 @@ class ResponderRecipe(object):
     def id(self, id):
         """
         Sets the id of this ResponderRecipe.
-        Identifier for ResponderRecipe.
+        Unique identifier for the responder recip
 
 
         :param id: The id of this ResponderRecipe.
@@ -201,7 +216,7 @@ class ResponderRecipe(object):
     def display_name(self):
         """
         Gets the display_name of this ResponderRecipe.
-        ResponderRecipe display name.
+        Responder recipe display name
 
 
         :return: The display_name of this ResponderRecipe.
@@ -213,7 +228,7 @@ class ResponderRecipe(object):
     def display_name(self, display_name):
         """
         Sets the display_name of this ResponderRecipe.
-        ResponderRecipe display name.
+        Responder recipe display name
 
 
         :param display_name: The display_name of this ResponderRecipe.
@@ -225,7 +240,7 @@ class ResponderRecipe(object):
     def description(self):
         """
         Gets the description of this ResponderRecipe.
-        ResponderRecipe description.
+        Responder recipe description
 
 
         :return: The description of this ResponderRecipe.
@@ -237,7 +252,7 @@ class ResponderRecipe(object):
     def description(self, description):
         """
         Sets the description of this ResponderRecipe.
-        ResponderRecipe description.
+        Responder recipe description
 
 
         :param description: The description of this ResponderRecipe.
@@ -249,7 +264,7 @@ class ResponderRecipe(object):
     def owner(self):
         """
         Gets the owner of this ResponderRecipe.
-        Owner of ResponderRecipe
+        Owner of responder recipe
 
         Allowed values for this property are: "CUSTOMER", "ORACLE", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
@@ -264,7 +279,7 @@ class ResponderRecipe(object):
     def owner(self, owner):
         """
         Sets the owner of this ResponderRecipe.
-        Owner of ResponderRecipe
+        Owner of responder recipe
 
 
         :param owner: The owner of this ResponderRecipe.
@@ -303,7 +318,7 @@ class ResponderRecipe(object):
     def effective_responder_rules(self):
         """
         Gets the effective_responder_rules of this ResponderRecipe.
-        List of responder rules associated with the recipe
+        List of currently enabled responder rules for the responder type, for recipe after applying defaults
 
 
         :return: The effective_responder_rules of this ResponderRecipe.
@@ -315,7 +330,7 @@ class ResponderRecipe(object):
     def effective_responder_rules(self, effective_responder_rules):
         """
         Sets the effective_responder_rules of this ResponderRecipe.
-        List of responder rules associated with the recipe
+        List of currently enabled responder rules for the responder type, for recipe after applying defaults
 
 
         :param effective_responder_rules: The effective_responder_rules of this ResponderRecipe.
@@ -327,7 +342,7 @@ class ResponderRecipe(object):
     def source_responder_recipe_id(self):
         """
         Gets the source_responder_recipe_id of this ResponderRecipe.
-        The id of the source responder recipe.
+        The unique identifier of the source responder recipe
 
 
         :return: The source_responder_recipe_id of this ResponderRecipe.
@@ -339,7 +354,7 @@ class ResponderRecipe(object):
     def source_responder_recipe_id(self, source_responder_recipe_id):
         """
         Sets the source_responder_recipe_id of this ResponderRecipe.
-        The id of the source responder recipe.
+        The unique identifier of the source responder recipe
 
 
         :param source_responder_recipe_id: The source_responder_recipe_id of this ResponderRecipe.
@@ -351,7 +366,7 @@ class ResponderRecipe(object):
     def compartment_id(self):
         """
         **[Required]** Gets the compartment_id of this ResponderRecipe.
-        Compartment Identifier
+        Compartment OCID
 
 
         :return: The compartment_id of this ResponderRecipe.
@@ -363,7 +378,7 @@ class ResponderRecipe(object):
     def compartment_id(self, compartment_id):
         """
         Sets the compartment_id of this ResponderRecipe.
-        Compartment Identifier
+        Compartment OCID
 
 
         :param compartment_id: The compartment_id of this ResponderRecipe.
@@ -399,7 +414,7 @@ class ResponderRecipe(object):
     def time_updated(self):
         """
         Gets the time_updated of this ResponderRecipe.
-        The date and time the responder recipe was updated. Format defined by RFC3339.
+        The date and time the responder recipe was last updated. Format defined by RFC3339.
 
 
         :return: The time_updated of this ResponderRecipe.
@@ -411,7 +426,7 @@ class ResponderRecipe(object):
     def time_updated(self, time_updated):
         """
         Sets the time_updated of this ResponderRecipe.
-        The date and time the responder recipe was updated. Format defined by RFC3339.
+        The date and time the responder recipe was last updated. Format defined by RFC3339.
 
 
         :param time_updated: The time_updated of this ResponderRecipe.
@@ -423,7 +438,7 @@ class ResponderRecipe(object):
     def lifecycle_state(self):
         """
         Gets the lifecycle_state of this ResponderRecipe.
-        The current state of the Example.
+        The current lifecycle state of the example
 
         Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
@@ -438,7 +453,7 @@ class ResponderRecipe(object):
     def lifecycle_state(self, lifecycle_state):
         """
         Sets the lifecycle_state of this ResponderRecipe.
-        The current state of the Example.
+        The current lifecycle state of the example
 
 
         :param lifecycle_state: The lifecycle_state of this ResponderRecipe.

oci/cloud_guard/models/responder_recipe_collection.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class ResponderRecipeCollection(object):
     """
-    Summary of the ResponderRecipe.
+    Collection of responder recipe summary information.
     """
 
     def __init__(self, **kwargs):
@@ -24,22 +24,29 @@ class ResponderRecipeCollection(object):
             The value to assign to the items property of this ResponderRecipeCollection.
         :type items: list[oci.cloud_guard.models.ResponderRecipeSummary]
 
+        :param locks:
+            The value to assign to the locks property of this ResponderRecipeCollection.
+        :type locks: list[oci.cloud_guard.models.ResourceLock]
+
         """
         self.swagger_types = {
-            'items': 'list[ResponderRecipeSummary]'
+            'items': 'list[ResponderRecipeSummary]',
+            'locks': 'list[ResourceLock]'
         }
 
         self.attribute_map = {
-            'items': 'items'
+            'items': 'items',
+            'locks': 'locks'
         }
 
         self._items = None
+        self._locks = None
 
     @property
     def items(self):
         """
         **[Required]** Gets the items of this ResponderRecipeCollection.
-        List of ResponderRecipeSummary
+        List of ResponderRecipeSummary resources
 
 
         :return: The items of this ResponderRecipeCollection.
@@ -51,7 +58,7 @@ class ResponderRecipeCollection(object):
     def items(self, items):
         """
         Sets the items of this ResponderRecipeCollection.
-        List of ResponderRecipeSummary
+        List of ResponderRecipeSummary resources
 
 
         :param items: The items of this ResponderRecipeCollection.
@@ -59,6 +66,30 @@ class ResponderRecipeCollection(object):
         """
         self._items = items
 
+    @property
+    def locks(self):
+        """
+        Gets the locks of this ResponderRecipeCollection.
+        Locks associated with this resource.
+
+
+        :return: The locks of this ResponderRecipeCollection.
+        :rtype: list[oci.cloud_guard.models.ResourceLock]
+        """
+        return self._locks
+
+    @locks.setter
+    def locks(self, locks):
+        """
+        Sets the locks of this ResponderRecipeCollection.
+        Locks associated with this resource.
+
+
+        :param locks: The locks of this ResponderRecipeCollection.
+        :type: list[oci.cloud_guard.models.ResourceLock]
+        """
+        self._locks = locks
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/cloud_guard/models/responder_recipe_responder_rule.py

@@ -12,7 +12,25 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class ResponderRecipeResponderRule(object):
     """
-    Details of ResponderRule.
+    A ResponderRecipeRule resource contains a specific instance of a
+    single responder rule.
+
+    A ResponderRecipeRule resource:
+    * Is effectively a copy of a ResponderRule resource in which users can
+    make certain changes if it\u2019s Oracle-managed, and other changes if it\u2019s user-managed.
+    * Can also be created by cloning an existing ResponderRecipe resource, either
+    user-managed or Oracle-managed; cloning the ResponderRecipe resource also clones
+    its associated ResponderRule resources as ResponderRecipeRule resources.
+    * Is visible on the Cloud Guard Responder Recipes, Responder Details page.
+    * Is effectively located in a specific OCI compartment, through the ResponderRecipe
+    resource to which it belongs.
+    * Can be modified by users, programmatically or through the UI.
+    * Changes that can be made here apply globally, to all resources in OCI compartments
+    mapped to a target that attaches the associated responder recipe (in a
+    TargetResponderRecipe resource), but are overridden by changes made in the
+    corresponding TargetResponderRecipe resource (which is effectively a copy of the
+    ResponderRecipe resource).
+    type: object
     """
 
     #: A constant which can be used with the type property of a ResponderRecipeResponderRule.
@@ -118,6 +136,10 @@ class ResponderRecipeResponderRule(object):
             The value to assign to the lifecycle_details property of this ResponderRecipeResponderRule.
         :type lifecycle_details: str
 
+        :param locks:
+            The value to assign to the locks property of this ResponderRecipeResponderRule.
+        :type locks: list[oci.cloud_guard.models.ResourceLock]
+
         """
         self.swagger_types = {
             'responder_rule_id': 'str',
@@ -131,7 +153,8 @@ class ResponderRecipeResponderRule(object):
             'time_created': 'datetime',
             'time_updated': 'datetime',
             'lifecycle_state': 'str',
-            'lifecycle_details': 'str'
+            'lifecycle_details': 'str',
+            'locks': 'list[ResourceLock]'
         }
 
         self.attribute_map = {
@@ -146,7 +169,8 @@ class ResponderRecipeResponderRule(object):
             'time_created': 'timeCreated',
             'time_updated': 'timeUpdated',
             'lifecycle_state': 'lifecycleState',
-            'lifecycle_details': 'lifecycleDetails'
+            'lifecycle_details': 'lifecycleDetails',
+            'locks': 'locks'
         }
 
         self._responder_rule_id = None
@@ -161,12 +185,13 @@ class ResponderRecipeResponderRule(object):
         self._time_updated = None
         self._lifecycle_state = None
         self._lifecycle_details = None
+        self._locks = None
 
     @property
     def responder_rule_id(self):
         """
         **[Required]** Gets the responder_rule_id of this ResponderRecipeResponderRule.
-        Identifier for ResponderRule.
+        Unique identifier for the responder rule
 
 
         :return: The responder_rule_id of this ResponderRecipeResponderRule.
@@ -178,7 +203,7 @@ class ResponderRecipeResponderRule(object):
     def responder_rule_id(self, responder_rule_id):
         """
         Sets the responder_rule_id of this ResponderRecipeResponderRule.
-        Identifier for ResponderRule.
+        Unique identifier for the responder rule
 
 
         :param responder_rule_id: The responder_rule_id of this ResponderRecipeResponderRule.
@@ -190,7 +215,7 @@ class ResponderRecipeResponderRule(object):
     def display_name(self):
         """
         Gets the display_name of this ResponderRecipeResponderRule.
-        ResponderRule display name.
+        Responder rule display name
 
 
         :return: The display_name of this ResponderRecipeResponderRule.
@@ -202,7 +227,7 @@ class ResponderRecipeResponderRule(object):
     def display_name(self, display_name):
         """
         Sets the display_name of this ResponderRecipeResponderRule.
-        ResponderRule display name.
+        Responder rule display name
 
 
         :param display_name: The display_name of this ResponderRecipeResponderRule.
@@ -214,7 +239,7 @@ class ResponderRecipeResponderRule(object):
     def description(self):
         """
         Gets the description of this ResponderRecipeResponderRule.
-        ResponderRule description.
+        Responder rule description
 
 
         :return: The description of this ResponderRecipeResponderRule.
@@ -226,7 +251,7 @@ class ResponderRecipeResponderRule(object):
     def description(self, description):
         """
         Sets the description of this ResponderRecipeResponderRule.
-        ResponderRule description.
+        Responder rule description
 
 
         :param description: The description of this ResponderRecipeResponderRule.
@@ -238,7 +263,7 @@ class ResponderRecipeResponderRule(object):
     def type(self):
         """
         Gets the type of this ResponderRecipeResponderRule.
-        Type of Responder
+        Type of responder
 
         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'.
@@ -253,7 +278,7 @@ class ResponderRecipeResponderRule(object):
     def type(self, type):
         """
         Sets the type of this ResponderRecipeResponderRule.
-        Type of Responder
+        Type of responder
 
 
         :param type: The type of this ResponderRecipeResponderRule.
@@ -268,7 +293,7 @@ class ResponderRecipeResponderRule(object):
     def policies(self):
         """
         Gets the policies of this ResponderRecipeResponderRule.
-        List of Policy
+        List of policies
 
 
         :return: The policies of this ResponderRecipeResponderRule.
@@ -280,7 +305,7 @@ class ResponderRecipeResponderRule(object):
     def policies(self, policies):
         """
         Sets the policies of this ResponderRecipeResponderRule.
-        List of Policy
+        List of policies
 
 
         :param policies: The policies of this ResponderRecipeResponderRule.
@@ -292,7 +317,7 @@ class ResponderRecipeResponderRule(object):
     def supported_modes(self):
         """
         Gets the supported_modes of this ResponderRecipeResponderRule.
-        Supported Execution Modes
+        Supported execution modes for the responder rule
 
         Allowed values for items in this list are: "AUTOACTION", "USERACTION", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
@@ -307,7 +332,7 @@ class ResponderRecipeResponderRule(object):
     def supported_modes(self, supported_modes):
         """
         Sets the supported_modes of this ResponderRecipeResponderRule.
-        Supported Execution Modes
+        Supported execution modes for the responder rule
 
 
         :param supported_modes: The supported_modes of this ResponderRecipeResponderRule.
@@ -342,7 +367,7 @@ class ResponderRecipeResponderRule(object):
     def compartment_id(self):
         """
         **[Required]** Gets the compartment_id of this ResponderRecipeResponderRule.
-        Compartment Identifier
+        Compartment OCID
 
 
         :return: The compartment_id of this ResponderRecipeResponderRule.
@@ -354,7 +379,7 @@ class ResponderRecipeResponderRule(object):
     def compartment_id(self, compartment_id):
         """
         Sets the compartment_id of this ResponderRecipeResponderRule.
-        Compartment Identifier
+        Compartment OCID
 
 
         :param compartment_id: The compartment_id of this ResponderRecipeResponderRule.
@@ -390,7 +415,7 @@ class ResponderRecipeResponderRule(object):
     def time_updated(self):
         """
         Gets the time_updated of this ResponderRecipeResponderRule.
-        The date and time the responder recipe rule was updated. Format defined by RFC3339.
+        The date and time the responder recipe rule was last updated. Format defined by RFC3339.
 
 
         :return: The time_updated of this ResponderRecipeResponderRule.
@@ -402,7 +427,7 @@ class ResponderRecipeResponderRule(object):
     def time_updated(self, time_updated):
         """
         Sets the time_updated of this ResponderRecipeResponderRule.
-        The date and time the responder recipe rule was updated. Format defined by RFC3339.
+        The date and time the responder recipe rule was last updated. Format defined by RFC3339.
 
 
         :param time_updated: The time_updated of this ResponderRecipeResponderRule.
@@ -414,7 +439,7 @@ class ResponderRecipeResponderRule(object):
     def lifecycle_state(self):
         """
         Gets the lifecycle_state of this ResponderRecipeResponderRule.
-        The current state of the ResponderRule.
+        The current lifecycle state of the responder rule
 
         Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
@@ -429,7 +454,7 @@ class ResponderRecipeResponderRule(object):
     def lifecycle_state(self, lifecycle_state):
         """
         Sets the lifecycle_state of this ResponderRecipeResponderRule.
-        The current state of the ResponderRule.
+        The current lifecycle state of the responder rule
 
 
         :param lifecycle_state: The lifecycle_state of this ResponderRecipeResponderRule.
@@ -464,6 +489,30 @@ class ResponderRecipeResponderRule(object):
         """
         self._lifecycle_details = lifecycle_details
 
+    @property
+    def locks(self):
+        """
+        Gets the locks of this ResponderRecipeResponderRule.
+        Locks associated with this resource.
+
+
+        :return: The locks of this ResponderRecipeResponderRule.
+        :rtype: list[oci.cloud_guard.models.ResourceLock]
+        """
+        return self._locks
+
+    @locks.setter
+    def locks(self, locks):
+        """
+        Sets the locks of this ResponderRecipeResponderRule.
+        Locks associated with this resource.
+
+
+        :param locks: The locks of this ResponderRecipeResponderRule.
+        :type: list[oci.cloud_guard.models.ResourceLock]
+        """
+        self._locks = locks
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/cloud_guard/models/responder_recipe_responder_rule_collection.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class ResponderRecipeResponderRuleCollection(object):
     """
-    Summary of the ResponderRule within ResponderRecipe.
+    The collection of responder rule summaries for a responder recipe.
     """
 
     def __init__(self, **kwargs):
@@ -39,7 +39,7 @@ class ResponderRecipeResponderRuleCollection(object):
     def items(self):
         """
         **[Required]** Gets the items of this ResponderRecipeResponderRuleCollection.
-        List of ResponderRecipeResponderRuleSummary
+        List of ResponderRecipeResponderRuleSummary resources
 
 
         :return: The items of this ResponderRecipeResponderRuleCollection.
@@ -51,7 +51,7 @@ class ResponderRecipeResponderRuleCollection(object):
     def items(self, items):
         """
         Sets the items of this ResponderRecipeResponderRuleCollection.
-        List of ResponderRecipeResponderRuleSummary
+        List of ResponderRecipeResponderRuleSummary resources
 
 
         :param items: The items of this ResponderRecipeResponderRuleCollection.