oci-disasterrecovery 2.76.1 → 2.77.0

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;

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

@@ -22,7 +22,7 @@ export interface UpdateDrProtectionGroupMemberDatabaseDetails extends model.Upda
     /**
       * The OCID of the vault secret where the database SYSDBA password is stored.
   * <p>
-  Example: `ocid1.vaultsecret.oc1..uniqueID`
+  Example: {@code ocid1.vaultsecret.oc1..uniqueID}
   *
       */
     "passwordVaultSecretId"?: string;

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

@@ -21,7 +21,7 @@ export interface UpdateDrProtectionGroupMemberDetails {
     /**
       * The OCID of the member.
   * <p>
-  Example: `ocid1.database.oc1..uniqueID`
+  Example: {@code ocid1.database.oc1..uniqueID}
   *
       */
     "memberId": string;

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

@@ -22,7 +22,7 @@ export interface UpdateDrProtectionGroupMemberFileSystemDetails extends model.Up
     /**
       * The availability domain of the destination mount target.
   * <p>
-  Example: `BBTh:region-AD`
+  Example: {@code BBTh:region-AD}
   *
       */
     "destinationAvailabilityDomain"?: string;

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

@@ -22,7 +22,7 @@ export interface UpdateDrProtectionGroupMemberLoadBalancerDetails extends model.
     /**
       * The OCID of the destination load balancer.
   * <p>
-  Example: `ocid1.loadbalancer.oc1..uniqueID`
+  Example: {@code ocid1.loadbalancer.oc1..uniqueID}
   *
       */
     "destinationLoadBalancerId"?: string;

package/lib/model/update-dr-protection-group-member-network-load-balancer-details.d.ts

@@ -22,7 +22,7 @@ export interface UpdateDrProtectionGroupMemberNetworkLoadBalancerDetails extends
     /**
       * The OCID of the destination network load balancer.
   * <p>
-  Example: `ocid1.networkloadbalancer.oc1..uniqueID`
+  Example: {@code ocid1.networkloadbalancer.oc1..uniqueID}
   *
       */
     "destinationNetworkLoadBalancerId"?: string;

package/lib/model/update-file-system-mount-details.d.ts

@@ -21,7 +21,7 @@ export interface UpdateFileSystemMountDetails {
     /**
       * The OCID of the mount target for this file system.
   * <p>
-  Example: `ocid1.mounttarget.oc1..uniqueID`
+  Example: {@code ocid1.mounttarget.oc1..uniqueID}
   *
       */
     "mountTargetId"?: string;

package/lib/model/update-file-system-unmount-details.d.ts

@@ -21,7 +21,7 @@ export interface UpdateFileSystemUnmountDetails {
     /**
       * The OCID of the mount target for this file system.
   * <p>
-  Example: `ocid1.mounttarget.oc1..uniqueID`
+  Example: {@code ocid1.mounttarget.oc1..uniqueID}
   *
       */
     "mountTargetId"?: string;

package/lib/model/update-invoke-function-user-defined-step-details.d.ts

@@ -23,14 +23,14 @@ export interface UpdateInvokeFunctionUserDefinedStepDetails extends model.Update
     /**
       * The OCID of function to be invoked.
   * <p>
-  Example: `ocid1.fnfunc.oc1..uniqueID`
+  Example: {@code ocid1.fnfunc.oc1..uniqueID}
   *
       */
     "functionId": string;
     /**
       * The request body for the function.
   * <p>
-  Example: `{ \"FnParam1\", \"FnParam2\" }`
+  Example: {@code { \"FnParam1\", \"FnParam2\" }}
   *
       */
     "requestBody"?: string;

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

@@ -21,14 +21,14 @@ export interface UpdateObjectStorageLogLocationDetails {
     /**
       * 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;

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

@@ -21,21 +21,21 @@ export interface UpdateObjectStorageScriptLocationDetails {
     /**
       * 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/update-run-local-script-user-defined-step-details.d.ts

@@ -28,21 +28,21 @@ export interface UpdateRunLocalScriptUserDefinedStepDetails extends model.Update
   * <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 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/update-run-object-store-script-user-defined-step-details.d.ts

@@ -28,7 +28,7 @@ export interface UpdateRunObjectStoreScriptUserDefinedStepDetails extends model.
   * <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;

package/lib/model/work-request-error.d.ts

@@ -22,21 +22,21 @@ export interface WorkRequestError {
       * A machine-usable code for the error that occured. Error codes are listed here --
   * (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm).
   * <p>
-  Example: `429`
+  Example: {@code 429}
   *
       */
     "code": string;
     /**
       * A human-readable description of the issue encountered.
   * <p>
-  Example: `TooManyRequests`
+  Example: {@code TooManyRequests}
   *
       */
     "message": string;
     /**
       * The time the error occured. An RFC3339 formatted datetime string.
   * <p>
-  Example: `2019-03-29T09:36:42Z`
+  Example: {@code 2019-03-29T09:36:42Z}
   *
       */
     "timestamp": Date;

package/lib/model/work-request-log-entry.d.ts

@@ -21,14 +21,14 @@ export interface WorkRequestLogEntry {
     /**
       * A human-readable log message.
   * <p>
-  Example: `DR plan execution is in progress`
+  Example: {@code DR plan execution is in progress}
   *
       */
     "message": string;
     /**
       * The time the log message was written. An RFC3339 formatted datetime string.
   * <p>
-  Example: `2019-03-29T09:36:42Z`
+  Example: {@code 2019-03-29T09:36:42Z}
   *
       */
     "timestamp": Date;

package/lib/model/work-request-resource.d.ts

@@ -22,7 +22,7 @@ export interface WorkRequestResource {
     /**
       * The resource type the work request affects.
   * <p>
-  Example: `DrPlanExecution`
+  Example: {@code DrPlanExecution}
   *
       */
     "entityType": string;
@@ -37,7 +37,7 @@ export interface WorkRequestResource {
     /**
       * The identifier (OCID) of the resource the work request affects.
   * <p>
-  Example: `ocid1.drplanexecution.oc1..uniqueID`
+  Example: {@code ocid1.drplanexecution.oc1..uniqueID}
   *
       */
     "identifier": string;

package/lib/model/work-request-summary.d.ts

@@ -32,7 +32,7 @@ export interface WorkRequestSummary {
     /**
       * The OCID of the work request.
   * <p>
-  Example: `ocid1.workrequest.oc1..uniqueID`
+  Example: {@code ocid1.workrequest.oc1..uniqueID}
   *
       */
     "id": string;
@@ -42,7 +42,7 @@ export interface WorkRequestSummary {
   * and those resources are not in the same compartment, it is up to the service team to pick the primary
   * resource whose compartment should be used.
   * <p>
-  Example: `ocid1.compartment.oc1..uniqueID`
+  Example: {@code ocid1.compartment.oc1..uniqueID}
   *
       */
     "compartmentId": string;
@@ -54,28 +54,28 @@ export interface WorkRequestSummary {
     /**
       * The percentage of the request completed.
   * <p>
-  Example: `75`
+  Example: {@code 75}
   *  Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
       */
     "percentComplete": number;
     /**
       * The date and time the request was created. An RFC3339 formatted datetime string.
   * <p>
-  Example: `2019-03-29T09:36:42Z`
+  Example: {@code 2019-03-29T09:36:42Z}
   *
       */
     "timeAccepted": Date;
     /**
       * The date and time the request was started. An RFC3339 formatted datetime string.
   * <p>
-  Example: `2019-03-29T09:36:42Z`
+  Example: {@code 2019-03-29T09:36:42Z}
   *
       */
     "timeStarted"?: Date;
     /**
       * The date and time the request was finished. An RFC3339 formatted datetime string.
   * <p>
-  Example: `2019-03-29T09:36:42Z`
+  Example: {@code 2019-03-29T09:36:42Z}
   *
       */
     "timeFinished"?: Date;