oci-disasterrecovery 2.76.1 → 2.77.1

package/lib/model/load-balancer-backend-set-mapping.d.ts

@@ -24,21 +24,21 @@ export interface LoadBalancerBackendSetMapping {
   * Backend sets that point to non-movable instances are only enabled or disabled during DR. For non-movable instances this flag should be set to 'true'.
   * Backend sets that point to movable instances are emptied and their contents are transferred to the destination region load balancer.  For movable instances this flag should be set to 'false'.
   * <p>
-  Example: `true`
+  Example: {@code true}
   *
       */
     "isBackendSetForNonMovable": boolean;
     /**
       * The name of the source backend set.
   * <p>
-  Example: `My_Source_Backend_Set`
+  Example: {@code My_Source_Backend_Set}
   *
       */
     "sourceBackendSetName": string;
     /**
       * The name of the destination backend set.
   * <p>
-  Example: `My_Destination_Backend_Set`
+  Example: {@code My_Destination_Backend_Set}
   *
       */
     "destinationBackendSetName": string;

package/lib/model/network-load-balancer-backend-set-mapping-details.d.ts

@@ -25,21 +25,21 @@ export interface NetworkLoadBalancerBackendSetMappingDetails {
   * Backend sets that point to movable instances are emptied and their contents are transferred to the
   * destination region load balancer.  For movable instances this flag should be set to 'false'.
   * <p>
-  Example: `true`
+  Example: {@code true}
   *
       */
     "isBackendSetForNonMovable": boolean;
     /**
       * The name of the source backend set.
   * <p>
-  Example: `Source-BackendSet-1`
+  Example: {@code Source-BackendSet-1}
   *
       */
     "sourceBackendSetName": string;
     /**
       * The name of the destination backend set.
   * <p>
-  Example: `Destination-BackendSet-1`
+  Example: {@code Destination-BackendSet-1}
   *
       */
     "destinationBackendSetName": string;

package/lib/model/network-load-balancer-backend-set-mapping.d.ts

@@ -24,21 +24,21 @@ export interface NetworkLoadBalancerBackendSetMapping {
   * Backend sets that point to non-movable instances are only enabled or disabled during DR. For non-movable instances this flag should be set to 'true'.
   * Backend sets that point to movable instances are emptied and their contents are transferred to the destination region network load balancer.  For movable instances this flag should be set to 'false'.
   * <p>
-  Example: `true`
+  Example: {@code true}
   *
       */
     "isBackendSetForNonMovable": boolean;
     /**
       * The name of the source backend set.
   * <p>
-  Example: `example_backend_set`
+  Example: {@code example_backend_set}
   *
       */
     "sourceBackendSetName": string;
     /**
       * The name of the destination backend set.
   * <p>
-  Example: `example_backend_set`
+  Example: {@code example_backend_set}
   *
       */
     "destinationBackendSetName": string;

package/lib/model/object-storage-log-location.d.ts

@@ -21,21 +21,21 @@ export interface ObjectStorageLogLocation {
     /**
       * The namespace in object storage (Note - this is usually the tenancy name).
   * <p>
-  Example: `myocitenancy`
+  Example: {@code myocitenancy}
   *
       */
     "namespace": string;
     /**
       * The bucket name inside the object storage namespace.
   * <p>
-  Example: `operation_logs`
+  Example: {@code operation_logs}
   *
       */
     "bucket": string;
     /**
       * The object name inside the object storage bucket.
   * <p>
-  Example: `switchover_plan_executions`
+  Example: {@code switchover_plan_executions}
   *
       */
     "object"?: string;

package/lib/model/object-storage-script-location.d.ts

@@ -21,21 +21,21 @@ export interface ObjectStorageScriptLocation {
     /**
       * The namespace in object storage (Note - this is usually the tenancy name).
   * <p>
-  Example: `myocitenancy`
+  Example: {@code myocitenancy}
   *
       */
     "namespace": string;
     /**
       * The bucket name inside the object storage namespace.
   * <p>
-  Example: `custom_dr_scripts`
+  Example: {@code custom_dr_scripts}
   *
       */
     "bucket": string;
     /**
       * The object name inside the object storage bucket.
   * <p>
-  Example: `validate_app_start.sh`
+  Example: {@code validate_app_start.sh}
   *
       */
     "object": string;

package/lib/model/retry-dr-plan-execution-details.d.ts

@@ -21,14 +21,14 @@ export interface RetryDrPlanExecutionDetails {
     /**
       * The unique id of the group to retry as a whole, or the group containing the step being retried.
   * <p>
-  Example: `sgid1.group..uniqueID`
+  Example: {@code sgid1.group..uniqueID}
   *
       */
     "groupId": string;
     /**
       * The unique id of the step to retry (optional). Only needed when retrying a step.
   * <p>
-  Example: `sgid1.step..uniqueID`
+  Example: {@code sgid1.step..uniqueID}
   *
       */
     "stepId"?: string;

package/lib/model/run-local-script-user-defined-step.d.ts

@@ -27,28 +27,28 @@ export interface RunLocalScriptUserDefinedStep extends model.DrPlanUserDefinedSt
   * <p>
   **For non-moving instances:** *runOnInstanceId* must be the OCID of the non-moving instance.
   * <p>
-  Example: `ocid1.instance.oc1..uniqueID`
+  Example: {@code ocid1.instance.oc1..uniqueID}
   *
       */
     "runOnInstanceId": string;
     /**
       * The region in which the instance is present.
   * <p>
-  Example: `us-ashburn-1`
+  Example: {@code us-ashburn-1}
   *
       */
     "runOnInstanceRegion": string;
     /**
       * The script name and arguments.
   * <p>
-  Example: `/usr/bin/python3 /home/opc/scripts/my_app_script.py arg1 arg2 arg3`
+  Example: {@code /usr/bin/python3 /home/opc/scripts/my_app_script.py arg1 arg2 arg3}
   *
       */
     "scriptCommand": string;
     /**
       * The userid on the instance to be used for executing the script or command.
   * <p>
-  Example: `opc`
+  Example: {@code opc}
   *
       */
     "runAsUser"?: string;

package/lib/model/run-object-store-script-user-defined-step.d.ts

@@ -27,14 +27,14 @@ export interface RunObjectStoreScriptUserDefinedStep extends model.DrPlanUserDef
   * <p>
   **For non-moving instances:** *runOnInstanceId* must be the OCID of the non-moving instance.
   * <p>
-  Example: `ocid1.instance.oc1..uniqueID`
+  Example: {@code ocid1.instance.oc1..uniqueID}
   *
       */
     "runOnInstanceId": string;
     /**
       * The region of the instance where this script or command should be executed.
   * <p>
-  Example: `us-ashburn-1`
+  Example: {@code us-ashburn-1}
   *
       */
     "runOnInstanceRegion": string;

package/lib/model/start-drill-execution-option-details.d.ts

@@ -22,14 +22,14 @@ export interface StartDrillExecutionOptionDetails extends model.DrPlanExecutionO
     /**
       * A flag indicating whether prechecks should be executed before the plan execution.
   * <p>
-  Example: `false`
+  Example: {@code false}
   *
       */
     "arePrechecksEnabled"?: boolean;
     /**
       * A flag indicating whether warnings should be ignored during the plan execution.
   * <p>
-  Example: `true`
+  Example: {@code true}
   *
       */
     "areWarningsIgnored"?: boolean;

package/lib/model/start-drill-execution-options.d.ts

@@ -22,14 +22,14 @@ export interface StartDrillExecutionOptions extends model.DrPlanExecutionOptions
     /**
       * A flag indicating whether prechecks should be executed before the plan execution.
   * <p>
-  Example: `true`
+  Example: {@code true}
   *
       */
     "arePrechecksEnabled"?: boolean;
     /**
       * A flag indicating whether warnings should be ignored during the plan execution.
   * <p>
-  Example: `false`
+  Example: {@code false}
   *
       */
     "areWarningsIgnored"?: boolean;

package/lib/model/start-drill-precheck-execution-option-details.d.ts

@@ -22,7 +22,7 @@ export interface StartDrillPrecheckExecutionOptionDetails extends model.DrPlanEx
     /**
       * A flag indicating whether warnings should be ignored during the precheck.
   * <p>
-  Example: `true`
+  Example: {@code true}
   *
       */
     "areWarningsIgnored"?: boolean;

package/lib/model/start-drill-precheck-execution-options.d.ts

@@ -22,7 +22,7 @@ export interface StartDrillPrecheckExecutionOptions extends model.DrPlanExecutio
     /**
       * A flag indicating whether warnings should be ignored during the precheck.
   * <p>
-  Example: `false`
+  Example: {@code false}
   *
       */
     "areWarningsIgnored"?: boolean;

package/lib/model/stop-drill-execution-option-details.d.ts

@@ -22,14 +22,14 @@ export interface StopDrillExecutionOptionDetails extends model.DrPlanExecutionOp
     /**
       * A flag indicating whether prechecks should be executed before the plan execution.
   * <p>
-  Example: `false`
+  Example: {@code false}
   *
       */
     "arePrechecksEnabled"?: boolean;
     /**
       * A flag indicating whether warnings should be ignored during the plan execution.
   * <p>
-  Example: `true`
+  Example: {@code true}
   *
       */
     "areWarningsIgnored"?: boolean;

package/lib/model/stop-drill-execution-options.d.ts

@@ -22,14 +22,14 @@ export interface StopDrillExecutionOptions extends model.DrPlanExecutionOptions
     /**
       * A flag indicating whether a precheck should be executed before the plan execution.
   * <p>
-  Example: `true`
+  Example: {@code true}
   *
       */
     "arePrechecksEnabled"?: boolean;
     /**
       * A flag indicating whether warnings should be ignored during the plan execution.
   * <p>
-  Example: `false`
+  Example: {@code false}
   *
       */
     "areWarningsIgnored"?: boolean;

package/lib/model/stop-drill-precheck-execution-option-details.d.ts

@@ -22,7 +22,7 @@ export interface StopDrillPrecheckExecutionOptionDetails extends model.DrPlanExe
     /**
       * A flag indicating whether warnings should be ignored during the precheck.
   * <p>
-  Example: `true`
+  Example: {@code true}
   *
       */
     "areWarningsIgnored"?: boolean;

package/lib/model/stop-drill-precheck-execution-options.d.ts

@@ -22,7 +22,7 @@ export interface StopDrillPrecheckExecutionOptions extends model.DrPlanExecution
     /**
       * A flag indicating whether warnings should be ignored during the precheck.
   * <p>
-  Example: `false`
+  Example: {@code false}
   *
       */
     "areWarningsIgnored"?: boolean;

package/lib/model/switchover-execution-option-details.d.ts

@@ -22,14 +22,14 @@ export interface SwitchoverExecutionOptionDetails extends model.DrPlanExecutionO
     /**
       * A flag indicating whether prechecks should be executed before the plan execution.
   * <p>
-  Example: `false`
+  Example: {@code false}
   *
       */
     "arePrechecksEnabled"?: boolean;
     /**
       * A flag indicating whether warnings should be ignored during the switchover.
   * <p>
-  Example: `true`
+  Example: {@code true}
   *
       */
     "areWarningsIgnored"?: boolean;

package/lib/model/switchover-execution-options.d.ts

@@ -22,14 +22,14 @@ export interface SwitchoverExecutionOptions extends model.DrPlanExecutionOptions
     /**
       * A flag indicating whether prechecks should be executed before the plan execution.
   * <p>
-  Example: `false`
+  Example: {@code false}
   *
       */
     "arePrechecksEnabled"?: boolean;
     /**
       * A flag indicating whether warnings should be ignored during the plan execution.
   * <p>
-  Example: `true`
+  Example: {@code true}
   *
       */
     "areWarningsIgnored"?: boolean;

package/lib/model/switchover-precheck-execution-option-details.d.ts

@@ -22,7 +22,7 @@ export interface SwitchoverPrecheckExecutionOptionDetails extends model.DrPlanEx
     /**
       * A flag indicating whether warnings should be ignored during the switchover precheck.
   * <p>
-  Example: `true`
+  Example: {@code true}
   *
       */
     "areWarningsIgnored"?: boolean;

package/lib/model/switchover-precheck-execution-options.d.ts

@@ -22,7 +22,7 @@ export interface SwitchoverPrecheckExecutionOptions extends model.DrPlanExecutio
     /**
       * A flag indicating whether warnings should be ignored during the precheck.
   * <p>
-  Example: `true`
+  Example: {@code true}
   *
       */
     "areWarningsIgnored"?: boolean;

package/lib/model/update-block-volume-attachment-details.d.ts

@@ -23,7 +23,7 @@ export interface UpdateBlockVolumeAttachmentDetails {
       * The OCID of the reference compute instance from which to obtain the attachment details for the volume.
   * This reference compute instance is from the peer DR protection group.
   * <p>
-  Example: `ocid1.instance.oc1..uniqueID`
+  Example: {@code ocid1.instance.oc1..uniqueID}
   *
       */
     "volumeAttachmentReferenceInstanceId"?: string;

package/lib/model/update-block-volume-mount-details.d.ts

@@ -22,7 +22,7 @@ export interface UpdateBlockVolumeMountDetails {
     /**
       * The physical mount point used for mounting the file system on a block volume.
   * <p>
-  Example: `/mnt/yourmountpoint`
+  Example: {@code /mnt/yourmountpoint}
   *
       */
     "mountPoint"?: string;

package/lib/model/update-compute-instance-movable-file-system-operation-details.d.ts

@@ -23,14 +23,14 @@ export interface UpdateComputeInstanceMovableFileSystemOperationDetails {
     /**
       * The export path of the file system.
   * <p>
-  Example: `/fs-export-path`
+  Example: {@code /fs-export-path}
   *
       */
     "exportPath": string;
     /**
       * The physical mount point of the file system on a host.
   * <p>
-  Example: `/mnt/yourmountpoint`
+  Example: {@code /mnt/yourmountpoint}
   *
       */
     "mountPoint": string;

package/lib/model/update-compute-instance-non-movable-block-volume-operation-details.d.ts

@@ -23,7 +23,7 @@ export interface UpdateComputeInstanceNonMovableBlockVolumeOperationDetails {
     /**
       * The OCID of the block volume.
   * <p>
-  Example: `ocid1.volume.oc1..uniqueID`
+  Example: {@code ocid1.volume.oc1..uniqueID}
   *
       */
     "blockVolumeId": string;

package/lib/model/update-compute-instance-non-movable-file-system-operation-details.d.ts

@@ -22,21 +22,21 @@ export interface UpdateComputeInstanceNonMovableFileSystemOperationDetails {
     /**
       * The export path of the file system.
   * <p>
-  Example: `/fs-export-path`
+  Example: {@code /fs-export-path}
   *
       */
     "exportPath": string;
     /**
       * The physical mount point of the file system on a host.
   * <p>
-  Example: `/mnt/yourmountpoint`
+  Example: {@code /mnt/yourmountpoint}
   *
       */
     "mountPoint": string;
     /**
       * The OCID of mount target.
   * <p>
-  Example: `ocid1.mounttarget.oc1..uniqueID`
+  Example: {@code ocid1.mounttarget.oc1..uniqueID}
   *
       */
     "mountTargetId": string;

package/lib/model/update-dr-plan-details.d.ts

@@ -22,7 +22,7 @@ export interface UpdateDrPlanDetails {
     /**
       * The display name of the DR plan being updated.
   * <p>
-  Example: `EBS Switchover PHX to IAD`
+  Example: {@code EBS Switchover PHX to IAD}
   *
       */
     "displayName"?: string;
@@ -34,7 +34,7 @@ export interface UpdateDrPlanDetails {
     /**
       * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
   * <p>
-  Example: `{\"Department\": \"Finance\"}`
+  Example: {@code {\"Department\": \"Finance\"}}
   *
       */
     "freeformTags"?: {
@@ -43,7 +43,7 @@ export interface UpdateDrPlanDetails {
     /**
       * Defined tags for this resource. Each key is predefined and scoped to a namespace.
   * <p>
-  Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
+  Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
   *
       */
     "definedTags"?: {

package/lib/model/update-dr-plan-execution-details.d.ts

@@ -21,14 +21,14 @@ export interface UpdateDrPlanExecutionDetails {
     /**
       * The display name of the DR protection group to update.
   * <p>
-  Example: `EBS IAD Group`
+  Example: {@code EBS IAD Group}
   *
       */
     "displayName"?: string;
     /**
       * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
   * <p>
-  Example: `{\"Department\": \"Finance\"}`
+  Example: {@code {\"Department\": \"Finance\"}}
   *
       */
     "freeformTags"?: {
@@ -37,7 +37,7 @@ export interface UpdateDrPlanExecutionDetails {
     /**
       * Defined tags for this resource. Each key is predefined and scoped to a namespace.
   * <p>
-  Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
+  Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
   *
       */
     "definedTags"?: {

package/lib/model/update-dr-plan-group-details.d.ts

@@ -22,21 +22,21 @@ export interface UpdateDrPlanGroupDetails {
     /**
       * The unique id of the group. Must not be modified by user.
   * <p>
-  Example: `sgid1.group..uniqueID`
+  Example: {@code sgid1.group..uniqueID}
   *
       */
     "id"?: string;
     /**
       * The display name of the group.
   * <p>
-  Example: `My_GROUP_3 - EBS Start`
+  Example: {@code My_GROUP_3 - EBS Start}
   *
       */
     "displayName"?: string;
     /**
       * The group type.
   * <p>
-  Example: `BUILT_IN`
+  Example: {@code BUILT_IN}
   *
       */
     "type"?: model.DrPlanGroupType;

package/lib/model/update-dr-plan-step-details.d.ts

@@ -22,14 +22,14 @@ export interface UpdateDrPlanStepDetails {
     /**
       * The unique id of the step.
   * <p>
-  Example: `sgid1.step..uniqueID`
+  Example: {@code sgid1.step..uniqueID}
   *
       */
     "id"?: string;
     /**
       * The display name of the step in a group.
   * <p>
-  Example: `My_STEP_3A - EBS Start - STAGE A`
+  Example: {@code My_STEP_3A - EBS Start - STAGE A}
   *
       */
     "displayName"?: string;
@@ -41,14 +41,14 @@ export interface UpdateDrPlanStepDetails {
     /**
       * The timeout in seconds for executing this step.
   * <p>
-  Example: `600`
+  Example: {@code 600}
   *  Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
       */
     "timeout"?: number;
     /**
       * A flag indicating whether this step should be enabled for execution.
   * <p>
-  Example: `true`
+  Example: {@code true}
   *
       */
     "isEnabled"?: boolean;

package/lib/model/update-dr-protection-group-details.d.ts

@@ -22,7 +22,7 @@ export interface UpdateDrProtectionGroupDetails {
     /**
       * The display name of the DR protection group.
   * <p>
-  Example: `EBS PHX Group`
+  Example: {@code EBS PHX Group}
   *
       */
     "displayName"?: string;
@@ -36,7 +36,7 @@ export interface UpdateDrProtectionGroupDetails {
     /**
       * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
   * <p>
-  Example: `{\"Department\": \"Finance\"}`
+  Example: {@code {\"Department\": \"Finance\"}}
   *
       */
     "freeformTags"?: {
@@ -45,7 +45,7 @@ export interface UpdateDrProtectionGroupDetails {
     /**
       * Defined tags for this resource. Each key is predefined and scoped to a namespace.
   * <p>
-  Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
+  Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
   *
       */
     "definedTags"?: {

package/lib/model/update-dr-protection-group-member-compute-instance-details.d.ts

@@ -22,7 +22,7 @@ export interface UpdateDrProtectionGroupMemberComputeInstanceDetails extends mod
     /**
       * A flag indicating if the compute instance should be moved during DR operations.
   * <p>
-  Example: `false`
+  Example: {@code false}
   *
       */
     "isMovable"?: boolean;
@@ -35,7 +35,7 @@ export interface UpdateDrProtectionGroupMemberComputeInstanceDetails extends mod
       * The OCID of a compartment in the destination region in which the compute instance
   * should be launched.
   * <p>
-  Example: `ocid1.compartment.oc1..uniqueID`
+  Example: {@code ocid1.compartment.oc1..uniqueID}
   *
       */
     "destinationCompartmentId"?: string;
@@ -43,7 +43,7 @@ export interface UpdateDrProtectionGroupMemberComputeInstanceDetails extends mod
       * The OCID of a dedicated VM host in the destination region on which the compute instance
   * should be launched.
   * <p>
-  Example: `ocid1.dedicatedvmhost.oc1..uniqueID`
+  Example: {@code ocid1.dedicatedvmhost.oc1..uniqueID}
   *
       */
     "destinationDedicatedVmHostId"?: string;

package/lib/model/update-dr-protection-group-member-compute-instance-movable-details.d.ts

@@ -24,7 +24,7 @@ export interface UpdateDrProtectionGroupMemberComputeInstanceMovableDetails exte
   * The compute instance launch will fail if this flag is set to true and capacity is not available in the
   * specified fault domain in the destination region.
   * <p>
-  Example: `false`
+  Example: {@code false}
   *
       */
     "isRetainFaultDomain"?: boolean;
@@ -32,7 +32,7 @@ export interface UpdateDrProtectionGroupMemberComputeInstanceMovableDetails exte
       * The OCID of a capacity reservation in the destination region which will be used to launch
   * the compute instance.
   * <p>
-  Example: `ocid1.capacityreservation.oc1..uniqueID`
+  Example: {@code ocid1.capacityreservation.oc1..uniqueID}
   *
       */
     "destinationCapacityReservationId"?: string;
@@ -45,7 +45,7 @@ export interface UpdateDrProtectionGroupMemberComputeInstanceMovableDetails exte
       * The OCID of a compartment in the destination region in which the compute instance
   * should be launched.
   * <p>
-  Example: `ocid1.compartment.oc1..uniqueID`
+  Example: {@code ocid1.compartment.oc1..uniqueID}
   *
       */
     "destinationCompartmentId"?: string;
@@ -53,7 +53,7 @@ export interface UpdateDrProtectionGroupMemberComputeInstanceMovableDetails exte
       * The OCID of a dedicated VM host in the destination region where the compute instance
   * should be launched.
   * <p>
-  Example: `ocid1.dedicatedvmhost.oc1..uniqueID`
+  Example: {@code ocid1.dedicatedvmhost.oc1..uniqueID}
   *
       */
     "destinationDedicatedVmHostId"?: string;