@nutanix-scratch/dataprotection-js-client 4.0.1 → 4.2.1

package/dist/es/models/dataprotection/v4/config/RecoveryPlanJob.d.ts

@@ -0,0 +1,166 @@
+/**
+ * The RecoveryPlanJob model module.
+ * @module Ntnx/RecoveryPlanJob
+ * @version 4.2.1
+ * @class RecoveryPlanJob
+ * @extends ExternalizableAbstractModel
+ */
+export default class RecoveryPlanJob extends ExternalizableAbstractModel {
+    /**
+     * Returns Name of the Recovery Plan Job.
+     * @return {string}
+     */
+    getName(): string;
+    /**
+     * Sets Name of the Recovery Plan Job.
+     * @param {string} name Name of the Recovery Plan Job.
+     */
+    setName(name: string): void;
+    name: string;
+    /**
+     * Returns The external identifier of the recovery plan.
+     * @return {string}
+     */
+    getRecoveryPlanExtId(): string;
+    /**
+     * Sets The external identifier of the recovery plan.
+     * @param {string} recoveryPlanExtId The external identifier of the recovery plan.
+     */
+    setRecoveryPlanExtId(recoveryPlanExtId: string): void;
+    recoveryPlanExtId: string;
+    /**
+     * Returns List of failover directions from source disaster recovery location to target disaster recovery location.<br> For example, when failing over virtual machines (VMs) and volume groups from clusters C1, C2 registered to domain manager PC1 on source location to cluster C3 registered to domain manager PC1 on target location, there must be one direction between source location (PC1, C1) to target location (PC1, C3) and another mapping between source location (PC1, C2) and target location (PC1, C3).<br> Domain manager is a required parameter while describing disaster recovery location in failover directions.<br> When creating a Recovery Plan Job across two domain managers, the source clusters are not required.<br> Failover direction contains clusters only when failing over between primary and secondary clusters registered to the same domain manager.
+     * @return {FailoverDirection[]}
+     */
+    getFailoverDirections(): FailoverDirection[];
+    /**
+     * Sets List of failover directions from source disaster recovery location to target disaster recovery location.<br> For example, when failing over virtual machines (VMs) and volume groups from clusters C1, C2 registered to domain manager PC1 on source location to cluster C3 registered to domain manager PC1 on target location, there must be one direction between source location (PC1, C1) to target location (PC1, C3) and another mapping between source location (PC1, C2) and target location (PC1, C3).<br> Domain manager is a required parameter while describing disaster recovery location in failover directions.<br> When creating a Recovery Plan Job across two domain managers, the source clusters are not required.<br> Failover direction contains clusters only when failing over between primary and secondary clusters registered to the same domain manager.
+     * @param {FailoverDirection[]} failoverDirections List of failover directions from source disaster recovery location to target disaster recovery location.<br> For example, when failing over virtual machines (VMs) and volume groups from clusters C1, C2 registered to domain manager PC1 on source location to cluster C3 registered to domain manager PC1 on target location, there must be one direction between source location (PC1, C1) to target location (PC1, C3) and another mapping between source location (PC1, C2) and target location (PC1, C3).<br> Domain manager is a required parameter while describing disaster recovery location in failover directions.<br> When creating a Recovery Plan Job across two domain managers, the source clusters are not required.<br> Failover direction contains clusters only when failing over between primary and secondary clusters registered to the same domain manager.
+     */
+    setFailoverDirections(failoverDirections: FailoverDirection[]): void;
+    failoverDirections: FailoverDirection[];
+    /**
+     * @return {RecoveryPlanActionType}
+     */
+    getActionType(): RecoveryPlanActionType;
+    /**
+     * @param {RecoveryPlanActionType} actionType
+     */
+    setActionType(actionType: RecoveryPlanActionType): void;
+    actionType: string;
+    /**
+     * Returns Point in time from which to restore the entities during an `UNPLANNED_FAILOVER` operation. Only ISO-8601 formatted timestamps are supported. For example, `2023-01-02T03:04:05Z`.<br> When specified, virtual machines (VMs) and volume groups are restored from the latest recovery points created on or before the specified timestamp. If not specified, virtual machines (VMs) and volume groups are restored from the latest recovery points created on or before the start of the Recovery plan job.
+     * @return {Date}
+     */
+    getRecoveryReferenceTime(): Date;
+    /**
+     * Sets Point in time from which to restore the entities during an `UNPLANNED_FAILOVER` operation. Only ISO-8601 formatted timestamps are supported. For example, `2023-01-02T03:04:05Z`.<br> When specified, virtual machines (VMs) and volume groups are restored from the latest recovery points created on or before the specified timestamp. If not specified, virtual machines (VMs) and volume groups are restored from the latest recovery points created on or before the start of the Recovery plan job.
+     * @param {Date} recoveryReferenceTime Point in time from which to restore the entities during an `UNPLANNED_FAILOVER` operation. Only ISO-8601 formatted timestamps are supported. For example, `2023-01-02T03:04:05Z`.<br> When specified, virtual machines (VMs) and volume groups are restored from the latest recovery points created on or before the specified timestamp. If not specified, virtual machines (VMs) and volume groups are restored from the latest recovery points created on or before the start of the Recovery plan job.
+     */
+    setRecoveryReferenceTime(recoveryReferenceTime: Date): void;
+    recoveryReferenceTime: Date;
+    /**
+     * Returns Indicates whether to perform a live migration of virtual machines (VMs) during a `PLANNED_FAILOVER` operation. When not specified or specified as false, the migration is performed for all virtual machines (VMs) in offline mode. When specified as true, the migration is performed for all virtual machines (VMs) in a running state.
+     * @return {boolean}
+     */
+    getIsLiveMigrateVMs(): boolean;
+    /**
+     * Sets Indicates whether to perform a live migration of virtual machines (VMs) during a `PLANNED_FAILOVER` operation. When not specified or specified as false, the migration is performed for all virtual machines (VMs) in offline mode. When specified as true, the migration is performed for all virtual machines (VMs) in a running state.
+     * @param {boolean} isLiveMigrateVMs Indicates whether to perform a live migration of virtual machines (VMs) during a `PLANNED_FAILOVER` operation. When not specified or specified as false, the migration is performed for all virtual machines (VMs) in offline mode. When specified as true, the migration is performed for all virtual machines (VMs) in a running state.
+     */
+    setIsLiveMigrateVMs(isLiveMigrateVMs: boolean): void;
+    isLiveMigrateVMs: boolean;
+    /**
+     * Returns Recovery plan job start time in ISO-8601 format.
+     * @return {Date}
+     */
+    getStartTime(): Date;
+    /**
+     * Sets Recovery plan job start time in ISO-8601 format.
+     * @param {Date} startTime Recovery plan job start time in ISO-8601 format.
+     */
+    setStartTime(startTime: Date): void;
+    startTime: Date;
+    /**
+     * Returns Recovery plan job completion time in ISO-8601 format.
+     * @return {Date}
+     */
+    getEndTime(): Date;
+    /**
+     * Sets Recovery plan job completion time in ISO-8601 format.
+     * @param {Date} endTime Recovery plan job completion time in ISO-8601 format.
+     */
+    setEndTime(endTime: Date): void;
+    endTime: Date;
+    /**
+     * @return {RecoveryPlanJobExecutionStatus}
+     */
+    getStatus(): RecoveryPlanJobExecutionStatus;
+    /**
+     * @param {RecoveryPlanJobExecutionStatus} status
+     */
+    setStatus(status: RecoveryPlanJobExecutionStatus): void;
+    status: string;
+    /**
+     * Returns Percentage complete for the recovery plan job.
+     * minimum: 0
+     * maximum: 100
+     * @return {Number}
+     */
+    getPercentageComplete(): number;
+    /**
+     * Sets Percentage complete for the recovery plan job.
+     * @param {Number} percentageComplete Percentage complete for the recovery plan job.
+     */
+    setPercentageComplete(percentageComplete: number): void;
+    percentageComplete: number;
+    /**
+     * @return {Summary}
+     */
+    getValidationStatus(): Summary;
+    /**
+     * @param {Summary} validationStatus
+     */
+    setValidationStatus(validationStatus: Summary): void;
+    validationStatus: Summary;
+    /**
+     * Returns Summary of all the phases involved in the recovery plan job execution:<br> - Pre-processing: Actions carried out prior to the recovery of entities, such as creating a network or synchronizing recovery points as part of a `PLANNED_FAILOVER` operation.<br> - Entity recovery: Steps performed for the recovery of the entities for the recovery plan job.<br> - Post-processing: Actions taken after the recovery of entities, such as creating a Consistency group or auditing the recovery plan job information.
+     * @return {PhaseSummary[]}
+     */
+    getExecutionPhases(): PhaseSummary[];
+    /**
+     * Sets Summary of all the phases involved in the recovery plan job execution:<br> - Pre-processing: Actions carried out prior to the recovery of entities, such as creating a network or synchronizing recovery points as part of a `PLANNED_FAILOVER` operation.<br> - Entity recovery: Steps performed for the recovery of the entities for the recovery plan job.<br> - Post-processing: Actions taken after the recovery of entities, such as creating a Consistency group or auditing the recovery plan job information.
+     * @param {PhaseSummary[]} executionPhases Summary of all the phases involved in the recovery plan job execution:<br> - Pre-processing: Actions carried out prior to the recovery of entities, such as creating a network or synchronizing recovery points as part of a `PLANNED_FAILOVER` operation.<br> - Entity recovery: Steps performed for the recovery of the entities for the recovery plan job.<br> - Post-processing: Actions taken after the recovery of entities, such as creating a Consistency group or auditing the recovery plan job information.
+     */
+    setExecutionPhases(executionPhases: PhaseSummary[]): void;
+    executionPhases: PhaseSummary[];
+    /**
+     * Returns Indicates whether the recovery plan job was initiated by the witness or not.
+     * @return {boolean}
+     */
+    getIsInitiatedByWitness(): boolean;
+    /**
+     * Sets Indicates whether the recovery plan job was initiated by the witness or not.
+     * @param {boolean} isInitiatedByWitness Indicates whether the recovery plan job was initiated by the witness or not.
+     */
+    setIsInitiatedByWitness(isInitiatedByWitness: boolean): void;
+    isInitiatedByWitness: boolean;
+    /**
+     * Returns External identifier of the owner of the recovery plan job.
+     * @return {string}
+     */
+    getOwnerExtId(): string;
+    /**
+     * Sets External identifier of the owner of the recovery plan job.
+     * @param {string} ownerExtId External identifier of the owner of the recovery plan job.
+     */
+    setOwnerExtId(ownerExtId: string): void;
+    ownerExtId: string;
+    #private;
+}
+import ExternalizableAbstractModel from "../../../common/v1/response/ExternalizableAbstractModel";
+import FailoverDirection from "./FailoverDirection";
+import RecoveryPlanActionType from "./RecoveryPlanActionType";
+import RecoveryPlanJobExecutionStatus from "./RecoveryPlanJobExecutionStatus";
+import Summary from "./Summary";
+import PhaseSummary from "./PhaseSummary";