oci 2.114.0__py3-none-any.whl → 2.115.1__py3-none-any.whl

oci/disaster_recovery/models/dr_plan_summary.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class DrPlanSummary(object):
     """
-    Summary information about a DR Plan Execution.
+    The summary of a DR plan.
     """
 
     #: A constant which can be used with the type property of a DrPlanSummary.
@@ -23,6 +23,14 @@ class DrPlanSummary(object):
     #: This constant has a value of "FAILOVER"
     TYPE_FAILOVER = "FAILOVER"
 
+    #: A constant which can be used with the type property of a DrPlanSummary.
+    #: This constant has a value of "START_DRILL"
+    TYPE_START_DRILL = "START_DRILL"
+
+    #: A constant which can be used with the type property of a DrPlanSummary.
+    #: This constant has a value of "STOP_DRILL"
+    TYPE_STOP_DRILL = "STOP_DRILL"
+
     #: A constant which can be used with the lifecycle_state property of a DrPlanSummary.
     #: This constant has a value of "CREATING"
     LIFECYCLE_STATE_CREATING = "CREATING"
@@ -74,7 +82,7 @@ class DrPlanSummary(object):
 
         :param type:
             The value to assign to the type property of this DrPlanSummary.
-            Allowed values for this property are: "SWITCHOVER", "FAILOVER", 'UNKNOWN_ENUM_VALUE'.
+            Allowed values for this property are: "SWITCHOVER", "FAILOVER", "START_DRILL", "STOP_DRILL", 'UNKNOWN_ENUM_VALUE'.
             Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
         :type type: str
 
@@ -174,9 +182,9 @@ class DrPlanSummary(object):
     def id(self):
         """
         **[Required]** Gets the id of this DrPlanSummary.
-        The OCID of this DR Plan.
+        The OCID of the DR plan.
 
-        Example: `ocid1.drplan.oc1.iad.<unique_id>`
+        Example: `ocid1.drplan.oc1..uniqueID`
 
 
         :return: The id of this DrPlanSummary.
@@ -188,9 +196,9 @@ class DrPlanSummary(object):
     def id(self, id):
         """
         Sets the id of this DrPlanSummary.
-        The OCID of this DR Plan.
+        The OCID of the DR plan.
 
-        Example: `ocid1.drplan.oc1.iad.<unique_id>`
+        Example: `ocid1.drplan.oc1..uniqueID`
 
 
         :param id: The id of this DrPlanSummary.
@@ -202,9 +210,9 @@ class DrPlanSummary(object):
     def compartment_id(self):
         """
         **[Required]** Gets the compartment_id of this DrPlanSummary.
-        The OCID of the compartment containing the DR Plan.
+        The OCID of the compartment containing the DR plan.
 
-        Example: `ocid1.compartment.oc1..<unique_id>`
+        Example: `ocid1.compartment.oc1..uniqueID`
 
 
         :return: The compartment_id of this DrPlanSummary.
@@ -216,9 +224,9 @@ class DrPlanSummary(object):
     def compartment_id(self, compartment_id):
         """
         Sets the compartment_id of this DrPlanSummary.
-        The OCID of the compartment containing the DR Plan.
+        The OCID of the compartment containing the DR plan.
 
-        Example: `ocid1.compartment.oc1..<unique_id>`
+        Example: `ocid1.compartment.oc1..uniqueID`
 
 
         :param compartment_id: The compartment_id of this DrPlanSummary.
@@ -230,7 +238,7 @@ class DrPlanSummary(object):
     def display_name(self):
         """
         **[Required]** Gets the display_name of this DrPlanSummary.
-        The display name of this DR Plan.
+        The display name of the DR plan.
 
         Example: `EBS Switchover PHX to IAD`
 
@@ -244,7 +252,7 @@ class DrPlanSummary(object):
     def display_name(self, display_name):
         """
         Sets the display_name of this DrPlanSummary.
-        The display name of this DR Plan.
+        The display name of the DR plan.
 
         Example: `EBS Switchover PHX to IAD`
 
@@ -258,9 +266,11 @@ class DrPlanSummary(object):
     def type(self):
         """
         **[Required]** Gets the type of this DrPlanSummary.
-        The type of this DR Plan.
+        The type of the DR plan.
 
-        Allowed values for this property are: "SWITCHOVER", "FAILOVER", 'UNKNOWN_ENUM_VALUE'.
+        Example: `SWITCHOVER`
+
+        Allowed values for this property are: "SWITCHOVER", "FAILOVER", "START_DRILL", "STOP_DRILL", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
 
 
@@ -273,13 +283,15 @@ class DrPlanSummary(object):
     def type(self, type):
         """
         Sets the type of this DrPlanSummary.
-        The type of this DR Plan.
+        The type of the DR plan.
+
+        Example: `SWITCHOVER`
 
 
         :param type: The type of this DrPlanSummary.
         :type: str
         """
-        allowed_values = ["SWITCHOVER", "FAILOVER"]
+        allowed_values = ["SWITCHOVER", "FAILOVER", "START_DRILL", "STOP_DRILL"]
         if not value_allowed_none_or_none_sentinel(type, allowed_values):
             type = 'UNKNOWN_ENUM_VALUE'
         self._type = type
@@ -288,9 +300,9 @@ class DrPlanSummary(object):
     def dr_protection_group_id(self):
         """
         **[Required]** Gets the dr_protection_group_id of this DrPlanSummary.
-        The OCID of the DR Protection Group with which this DR Plan is associated.
+        The OCID of the DR protection group to which this DR plan belongs.
 
-        Example: `ocid1.drprotectiongroup.oc1.iad.<unique_id>`
+        Example: `ocid1.drprotectiongroup.oc1..uniqueID`
 
 
         :return: The dr_protection_group_id of this DrPlanSummary.
@@ -302,9 +314,9 @@ class DrPlanSummary(object):
     def dr_protection_group_id(self, dr_protection_group_id):
         """
         Sets the dr_protection_group_id of this DrPlanSummary.
-        The OCID of the DR Protection Group with which this DR Plan is associated.
+        The OCID of the DR protection group to which this DR plan belongs.
 
-        Example: `ocid1.drprotectiongroup.oc1.iad.<unique_id>`
+        Example: `ocid1.drprotectiongroup.oc1..uniqueID`
 
 
         :param dr_protection_group_id: The dr_protection_group_id of this DrPlanSummary.
@@ -316,10 +328,10 @@ class DrPlanSummary(object):
     def peer_dr_protection_group_id(self):
         """
         **[Required]** Gets the peer_dr_protection_group_id of this DrPlanSummary.
-        The OCID of peer (remote) DR Protection Group associated with this plan execution's
-        DR Protection Group.
+        The OCID of the peer DR protection group associated with this plan's
+        DR protection group.
 
-        Example: `ocid1.drprotectiongroup.oc1.phx.<unique_id>`
+        Example: `ocid1.drprotectiongroup.oc1..uniqueID`
 
 
         :return: The peer_dr_protection_group_id of this DrPlanSummary.
@@ -331,10 +343,10 @@ class DrPlanSummary(object):
     def peer_dr_protection_group_id(self, peer_dr_protection_group_id):
         """
         Sets the peer_dr_protection_group_id of this DrPlanSummary.
-        The OCID of peer (remote) DR Protection Group associated with this plan execution's
-        DR Protection Group.
+        The OCID of the peer DR protection group associated with this plan's
+        DR protection group.
 
-        Example: `ocid1.drprotectiongroup.oc1.phx.<unique_id>`
+        Example: `ocid1.drprotectiongroup.oc1..uniqueID`
 
 
         :param peer_dr_protection_group_id: The peer_dr_protection_group_id of this DrPlanSummary.
@@ -346,9 +358,10 @@ class DrPlanSummary(object):
     def peer_region(self):
         """
         **[Required]** Gets the peer_region of this DrPlanSummary.
-        The region of the peer (remote) DR Protection Group.
+        The region of the peer DR protection group associated with this plan's
+        DR protection group.
 
-        Example: `us-phoenix-1`
+        Example: `us-ashburn-1`
 
 
         :return: The peer_region of this DrPlanSummary.
@@ -360,9 +373,10 @@ class DrPlanSummary(object):
     def peer_region(self, peer_region):
         """
         Sets the peer_region of this DrPlanSummary.
-        The region of the peer (remote) DR Protection Group.
+        The region of the peer DR protection group associated with this plan's
+        DR protection group.
 
-        Example: `us-phoenix-1`
+        Example: `us-ashburn-1`
 
 
         :param peer_region: The peer_region of this DrPlanSummary.
@@ -374,7 +388,7 @@ class DrPlanSummary(object):
     def time_created(self):
         """
         **[Required]** Gets the time_created of this DrPlanSummary.
-        The date and time the DR Plan was created. An RFC3339 formatted datetime string.
+        The date and time the DR plan was created. An RFC3339 formatted datetime string.
 
         Example: `2019-03-29T09:36:42Z`
 
@@ -388,7 +402,7 @@ class DrPlanSummary(object):
     def time_created(self, time_created):
         """
         Sets the time_created of this DrPlanSummary.
-        The date and time the DR Plan was created. An RFC3339 formatted datetime string.
+        The date and time the DR plan was created. An RFC3339 formatted datetime string.
 
         Example: `2019-03-29T09:36:42Z`
 
@@ -402,7 +416,7 @@ class DrPlanSummary(object):
     def time_updated(self):
         """
         **[Required]** Gets the time_updated of this DrPlanSummary.
-        The date and time the DR Plan was updated. An RFC3339 formatted datetime string.
+        The date and time the DR plan was updated. An RFC3339 formatted datetime string.
 
         Example: `2019-03-29T09:36:42Z`
 
@@ -416,7 +430,7 @@ class DrPlanSummary(object):
     def time_updated(self, time_updated):
         """
         Sets the time_updated of this DrPlanSummary.
-        The date and time the DR Plan was updated. An RFC3339 formatted datetime string.
+        The date and time the DR plan was updated. An RFC3339 formatted datetime string.
 
         Example: `2019-03-29T09:36:42Z`
 
@@ -430,7 +444,9 @@ class DrPlanSummary(object):
     def lifecycle_state(self):
         """
         **[Required]** Gets the lifecycle_state of this DrPlanSummary.
-        The current state of the DR Plan.
+        The current state of the DR plan.
+
+        Example: `ACTIVE`
 
         Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED", "NEEDS_ATTENTION", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
@@ -445,7 +461,9 @@ class DrPlanSummary(object):
     def lifecycle_state(self, lifecycle_state):
         """
         Sets the lifecycle_state of this DrPlanSummary.
-        The current state of the DR Plan.
+        The current state of the DR plan.
+
+        Example: `ACTIVE`
 
 
         :param lifecycle_state: The lifecycle_state of this DrPlanSummary.
@@ -460,7 +478,7 @@ class DrPlanSummary(object):
     def life_cycle_details(self):
         """
         Gets the life_cycle_details of this DrPlanSummary.
-        A message describing the DR Plan's current state in more detail.
+        A message describing the DR plan's current state in more detail.
 
 
         :return: The life_cycle_details of this DrPlanSummary.
@@ -472,7 +490,7 @@ class DrPlanSummary(object):
     def life_cycle_details(self, life_cycle_details):
         """
         Sets the life_cycle_details of this DrPlanSummary.
-        A message describing the DR Plan's current state in more detail.
+        A message describing the DR plan's current state in more detail.
 
 
         :param life_cycle_details: The life_cycle_details of this DrPlanSummary.
@@ -485,6 +503,7 @@ class DrPlanSummary(object):
         """
         Gets the freeform_tags of this DrPlanSummary.
         Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
+
         Example: `{\"Department\": \"Finance\"}`
 
 
@@ -498,6 +517,7 @@ class DrPlanSummary(object):
         """
         Sets the freeform_tags of this DrPlanSummary.
         Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
+
         Example: `{\"Department\": \"Finance\"}`
 
 
@@ -511,6 +531,7 @@ class DrPlanSummary(object):
         """
         Gets the defined_tags of this DrPlanSummary.
         Defined tags for this resource. Each key is predefined and scoped to a namespace.
+
         Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
 
 
@@ -524,6 +545,7 @@ class DrPlanSummary(object):
         """
         Sets the defined_tags of this DrPlanSummary.
         Defined tags for this resource. Each key is predefined and scoped to a namespace.
+
         Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
 
 
@@ -537,6 +559,7 @@ class DrPlanSummary(object):
         """
         Gets the system_tags of this DrPlanSummary.
         Usage of system tag keys. These predefined keys are scoped to namespaces.
+
         Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
 
 
@@ -550,6 +573,7 @@ class DrPlanSummary(object):
         """
         Sets the system_tags of this DrPlanSummary.
         Usage of system tag keys. These predefined keys are scoped to namespaces.
+
         Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
 
 

oci/disaster_recovery/models/dr_plan_user_defined_step.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class DrPlanUserDefinedStep(object):
     """
-    The details for a user-defined step in a DR Plan.
+    The details for a user-defined step in a DR plan.
     """
 
     #: A constant which can be used with the step_type property of a DrPlanUserDefinedStep.
@@ -102,24 +102,22 @@ class DrPlanUserDefinedStep(object):
     def step_type(self):
         """
         **[Required]** Gets the step_type of this DrPlanUserDefinedStep.
-        The type of the step.
+        The type of the user-defined step.
 
-          RUN_OBJECTSTORE_SCRIPT_PRECHECK - A step which performs a precheck on a script stored
-            in Oracle Object Storage Service
+          **RUN_OBJECTSTORE_SCRIPT_PRECHECK** - A step which performs a precheck on a script stored
+            in OCI object storage.
 
-          RUN_LOCAL_SCRIPT_PRECHECK - A step which performs a precheck on a script which resides
-            locally on a compute instance
+          **RUN_LOCAL_SCRIPT_PRECHECK** - A step which performs a precheck on a script which resides
+            locally on a compute instance.
 
-          INVOKE_FUNCTION_PRECHECK - A step which performs a precheck on an Oracle Function.
+          **INVOKE_FUNCTION_PRECHECK** - A step which performs a precheck on an OCI function.
             See https://docs.oracle.com/en-us/iaas/Content/Functions/home.htm.
 
-          RUN_OBJECTSTORE_SCRIPT - A step which runs a script stored in
-            Oracle Object Storage Service
+          **RUN_OBJECTSTORE_SCRIPT** - A step which runs a script stored in OCI object storage.
 
-          RUN_LOCAL_SCRIPT - A step which runs a script that resides locally
-            on a compute instance
+          **RUN_LOCAL_SCRIPT** - A step which runs a script that resides locally on a compute instance.
 
-          INVOKE_FUNCTION - A step which invokes an Oracle Function.
+          **INVOKE_FUNCTION** - A step which invokes an OCI function.
             See https://docs.oracle.com/en-us/iaas/Content/Functions/home.htm.
 
         Allowed values for this property are: "RUN_OBJECTSTORE_SCRIPT_PRECHECK", "RUN_LOCAL_SCRIPT_PRECHECK", "INVOKE_FUNCTION_PRECHECK", "RUN_OBJECTSTORE_SCRIPT", "RUN_LOCAL_SCRIPT", "INVOKE_FUNCTION", 'UNKNOWN_ENUM_VALUE'.
@@ -135,24 +133,22 @@ class DrPlanUserDefinedStep(object):
     def step_type(self, step_type):
         """
         Sets the step_type of this DrPlanUserDefinedStep.
-        The type of the step.
+        The type of the user-defined step.
 
-          RUN_OBJECTSTORE_SCRIPT_PRECHECK - A step which performs a precheck on a script stored
-            in Oracle Object Storage Service
+          **RUN_OBJECTSTORE_SCRIPT_PRECHECK** - A step which performs a precheck on a script stored
+            in OCI object storage.
 
-          RUN_LOCAL_SCRIPT_PRECHECK - A step which performs a precheck on a script which resides
-            locally on a compute instance
+          **RUN_LOCAL_SCRIPT_PRECHECK** - A step which performs a precheck on a script which resides
+            locally on a compute instance.
 
-          INVOKE_FUNCTION_PRECHECK - A step which performs a precheck on an Oracle Function.
+          **INVOKE_FUNCTION_PRECHECK** - A step which performs a precheck on an OCI function.
             See https://docs.oracle.com/en-us/iaas/Content/Functions/home.htm.
 
-          RUN_OBJECTSTORE_SCRIPT - A step which runs a script stored in
-            Oracle Object Storage Service
+          **RUN_OBJECTSTORE_SCRIPT** - A step which runs a script stored in OCI object storage.
 
-          RUN_LOCAL_SCRIPT - A step which runs a script that resides locally
-            on a compute instance
+          **RUN_LOCAL_SCRIPT** - A step which runs a script that resides locally on a compute instance.
 
-          INVOKE_FUNCTION - A step which invokes an Oracle Function.
+          **INVOKE_FUNCTION** - A step which invokes an OCI function.
             See https://docs.oracle.com/en-us/iaas/Content/Functions/home.htm.