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

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

@@ -0,0 +1,19 @@
+export default RecoveryPlanJobExecutionStatus;
+/**
+ * *
+ */
+type RecoveryPlanJobExecutionStatus = string;
+declare namespace RecoveryPlanJobExecutionStatus {
+    /**
+    * Returns a <code>RecoveryPlanJobExecutionStatus</code> enum value from a JavaScript object name.
+    * @param {Object} obj The plain JavaScript object containing the name of the enum value.
+    * @return {RecoveryPlanJobExecutionStatus} The enum <code>RecoveryPlanJobExecutionStatus</code> value.
+    */
+    function constructFromObject(obj: any): string;
+    /**
+    * Validates <code>RecoveryPlanJobExecutionStatus</code> enum value.
+    * @param {Object} obj The plain JavaScript object containing the name of the enum value.
+    * @return {null} Throws error for invalid value.
+    */
+    function validate(obj: any): null;
+}

package/dist/es/models/dataprotection/v4/config/RecoveryPlanJobExecutionStatus.js

@@ -0,0 +1,107 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _ValidationScopes = _interopRequireDefault(require("../../../validation/ValidationScopes"));
+var _ValidationUtils = _interopRequireDefault(require("../../../../utils/ValidationUtils"));
+var _ValidationError = _interopRequireDefault(require("../../../validation/ValidationError"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/*
+ * Nutanix Data Protection APIs
+ *
+ * OpenAPI spec version: 4.2.1
+ *
+ * NOTE: This class is auto generated by the Open API Dev Platform.
+ *
+ * Open API Dev Platform Codegen version: 17.5.0.10128-RELEASE
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+/**
+ * Enum class RecoveryPlanJobExecutionStatus.
+ * @enum {string}
+ * @readonly
+ */
+const RecoveryPlanJobExecutionStatus = {
+  /** 
+   * Unknown value.
+    * @const
+   */
+  $UNKNOWN: "$UNKNOWN",
+  /** 
+   * Redacted value.
+    * @const
+   */
+  $REDACTED: "$REDACTED",
+  /** 
+   * Operation is completed successfully.
+   * @const
+   */
+  SUCCEEDED: "SUCCEEDED",
+  /** 
+   * Operation is running.
+   * @const
+   */
+  RUNNING: "RUNNING",
+  /** 
+   * Operation is aborted.
+   * @const
+   */
+  ABORTED: "ABORTED",
+  /** 
+   * Operation is failed.
+   * @const
+   */
+  FAILED: "FAILED",
+  /** 
+   * Operation is queued.
+   * @const
+   */
+  QUEUED: "QUEUED",
+  /** 
+   * Operation is completed but with some validation warnings.
+   * @const
+   */
+  SUCCEEDED_WITH_VALIDATION_WARNING: "SUCCEEDED_WITH_VALIDATION_WARNING"
+};
+
+/**
+* Returns a <code>RecoveryPlanJobExecutionStatus</code> enum value from a JavaScript object name.
+* @param {Object} obj The plain JavaScript object containing the name of the enum value.
+* @return {RecoveryPlanJobExecutionStatus} The enum <code>RecoveryPlanJobExecutionStatus</code> value.
+*/
+RecoveryPlanJobExecutionStatus.constructFromObject = function (obj) {
+  if (typeof obj === 'string' || obj instanceof String) {
+    let enumVal = Object.keys(RecoveryPlanJobExecutionStatus).find(key => RecoveryPlanJobExecutionStatus[key] === obj);
+    return enumVal === undefined || enumVal === null ? RecoveryPlanJobExecutionStatus.$UNKNOWN : RecoveryPlanJobExecutionStatus[enumVal];
+  } else {
+    throw new Error("Received object name is not an instance of String");
+  }
+};
+
+/**
+* Validates <code>RecoveryPlanJobExecutionStatus</code> enum value.
+* @param {Object} obj The plain JavaScript object containing the name of the enum value.
+* @return {null} Throws error for invalid value.
+*/
+RecoveryPlanJobExecutionStatus.validate = function (obj) {
+  switch (obj) {
+    case RecoveryPlanJobExecutionStatus.$UNKNOWN:
+    case RecoveryPlanJobExecutionStatus.$REDACTED:
+    case RecoveryPlanJobExecutionStatus.SUCCEEDED:
+    case RecoveryPlanJobExecutionStatus.RUNNING:
+    case RecoveryPlanJobExecutionStatus.ABORTED:
+    case RecoveryPlanJobExecutionStatus.FAILED:
+    case RecoveryPlanJobExecutionStatus.QUEUED:
+    case RecoveryPlanJobExecutionStatus.SUCCEEDED_WITH_VALIDATION_WARNING:
+      return;
+    default:
+      throw new Error("Invalid : must be RecoveryPlanJobExecutionStatus.{ $UNKNOWN|$REDACTED|SUCCEEDED|RUNNING|ABORTED|FAILED|QUEUED|SUCCEEDED_WITH_VALIDATION_WARNING }");
+  }
+};
+Object.freeze(RecoveryPlanJobExecutionStatus);
+var _default = exports.default = RecoveryPlanJobExecutionStatus;

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

@@ -0,0 +1,132 @@
+/**
+ * The RecoveryPlanJobExecutionStep model module.
+ * @module Ntnx/RecoveryPlanJobExecutionStep
+ * @version 4.2.1
+ * @class RecoveryPlanJobExecutionStep
+ * @extends ExternalizableAbstractModel
+ */
+export default class RecoveryPlanJobExecutionStep extends ExternalizableAbstractModel {
+    /**
+     * @return {AppMessage}
+     */
+    getErrorMessage(): AppMessage;
+    /**
+     * @param {AppMessage} errorMessage
+     */
+    setErrorMessage(errorMessage: AppMessage): void;
+    errorMessage: AppMessage;
+    /**
+     * Returns External identifier of a recovery plan stage.
+     * @return {string}
+     */
+    getStageExtId(): string;
+    /**
+     * Sets External identifier of a recovery plan stage.
+     * @param {string} stageExtId External identifier of a recovery plan stage.
+     */
+    setStageExtId(stageExtId: string): void;
+    stageExtId: string;
+    /**
+     * @return {RecoveryPlanJobPhaseType}
+     */
+    getPhase(): RecoveryPlanJobPhaseType;
+    /**
+     * @param {RecoveryPlanJobPhaseType} phase
+     */
+    setPhase(phase: RecoveryPlanJobPhaseType): void;
+    phase: string;
+    /**
+     * @return {OperationType}
+     */
+    getOperationType(): OperationType;
+    /**
+     * @param {OperationType} operationType
+     */
+    setOperationType(operationType: OperationType): void;
+    operationType: string;
+    /**
+     * Returns User readable message for the action being performed for the current step.
+     * @return {string}
+     */
+    getStepDescription(): string;
+    /**
+     * Sets User readable message for the action being performed for the current step.
+     * @param {string} stepDescription User readable message for the action being performed for the current step.
+     */
+    setStepDescription(stepDescription: string): void;
+    stepDescription: string;
+    /**
+     * Returns List of affected entities.
+     * @return {ExecutionStepEntityReference[]}
+     */
+    getAffectedEntities(): ExecutionStepEntityReference[];
+    /**
+     * Sets List of affected entities.
+     * @param {ExecutionStepEntityReference[]} affectedEntities List of affected entities.
+     */
+    setAffectedEntities(affectedEntities: ExecutionStepEntityReference[]): void;
+    affectedEntities: ExecutionStepEntityReference[];
+    /**
+     * Returns Result for an execution step.
+     * @return {ExecutionStepResult[]}
+     */
+    getExecutionStepResults(): ExecutionStepResult[];
+    /**
+     * Sets Result for an execution step.
+     * @param {ExecutionStepResult[]} executionStepResults Result for an execution step.
+     */
+    setExecutionStepResults(executionStepResults: ExecutionStepResult[]): void;
+    executionStepResults: ExecutionStepResult[];
+    /**
+     * @return {RecoveryPlanJobExecutionStatus}
+     */
+    getStatus(): RecoveryPlanJobExecutionStatus;
+    /**
+     * @param {RecoveryPlanJobExecutionStatus} status
+     */
+    setStatus(status: RecoveryPlanJobExecutionStatus): void;
+    status: string;
+    /**
+     * Returns Time in ISO-8601 format when the current step started.
+     * @return {Date}
+     */
+    getStartTime(): Date;
+    /**
+     * Sets Time in ISO-8601 format when the current step started.
+     * @param {Date} startTime Time in ISO-8601 format when the current step started.
+     */
+    setStartTime(startTime: Date): void;
+    startTime: Date;
+    /**
+     * Returns Time in ISO-8601 format when the current step ended.
+     * @return {Date}
+     */
+    getEndTime(): Date;
+    /**
+     * Sets Time in ISO-8601 format when the current step ended.
+     * @param {Date} endTime Time in ISO-8601 format when the current step ended.
+     */
+    setEndTime(endTime: Date): void;
+    endTime: Date;
+    /**
+     * Returns The completed percentage for a step in the recovery plan job.
+     * minimum: 0
+     * maximum: 100
+     * @return {Number}
+     */
+    getPercentageComplete(): number;
+    /**
+     * Sets The completed percentage for a step in the recovery plan job.
+     * @param {Number} percentageComplete The completed percentage for a step in the recovery plan job.
+     */
+    setPercentageComplete(percentageComplete: number): void;
+    percentageComplete: number;
+    #private;
+}
+import ExternalizableAbstractModel from "../../../common/v1/response/ExternalizableAbstractModel";
+import AppMessage from "../error/AppMessage";
+import RecoveryPlanJobPhaseType from "./RecoveryPlanJobPhaseType";
+import OperationType from "./OperationType";
+import ExecutionStepEntityReference from "./ExecutionStepEntityReference";
+import ExecutionStepResult from "./ExecutionStepResult";
+import RecoveryPlanJobExecutionStatus from "./RecoveryPlanJobExecutionStatus";