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

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

@@ -0,0 +1,129 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _TenantAwareModel = _interopRequireDefault(require("../../../common/v1/config/TenantAwareModel"));
+var _ExternalizableAbstractModel = _interopRequireDefault(require("../../../common/v1/response/ExternalizableAbstractModel"));
+var _ExecutionStepEntityReference = _interopRequireDefault(require("./ExecutionStepEntityReference"));
+var _ExecutionStepResult = _interopRequireDefault(require("./ExecutionStepResult"));
+var _OperationType = _interopRequireDefault(require("./OperationType"));
+var _RecoveryPlanJobExecutionStatus = _interopRequireDefault(require("./RecoveryPlanJobExecutionStatus"));
+var _RecoveryPlanJobExecutionStep = _interopRequireDefault(require("./RecoveryPlanJobExecutionStep"));
+var _RecoveryPlanJobPhaseType = _interopRequireDefault(require("./RecoveryPlanJobPhaseType"));
+var _AppMessage = _interopRequireDefault(require("../error/AppMessage"));
+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.
+ *
+ */
+
+/**
+ * The RecoveryPlanJobExecutionStepProjection model module.
+ * @module Ntnx/RecoveryPlanJobExecutionStepProjection
+ * @version 4.2.1
+ * @class RecoveryPlanJobExecutionStepProjection
+ * @extends RecoveryPlanJobExecutionStep
+ */
+class RecoveryPlanJobExecutionStepProjection extends _RecoveryPlanJobExecutionStep.default {
+  /**
+   * Constructs a new <code>RecoveryPlanJobExecutionStepProjection</code>.
+   * @alias module:Ntnx/RecoveryPlanJobExecutionStepProjection
+   * @extends module:Ntnx/RecoveryPlanJobExecutionStep
+  */
+  constructor() {
+    super();
+    this.$objectType = "dataprotection.v4.config.RecoveryPlanJobExecutionStepProjection";
+    /** @type {object<string, any>} */
+    this.$reserved = {
+      '$fv': "v4.r2"
+    };
+    /** @type {object<string, any>} */
+    this.$unknownFields = {};
+  }
+
+  /**
+   * Constructs a <code>RecoveryPlanJobExecutionStepProjection</code> from a plain JavaScript object, optionally creating a new instance.
+   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+   * @param {Object} data The plain JavaScript object bearing properties of interest.
+   * @param {module:Ntnx/RecoveryPlanJobExecutionStepProjection} obj Optional instance to populate.
+   * @param callFromChild {Boolean} Flag to recognise calling instance
+   * @return {module:Ntnx/RecoveryPlanJobExecutionStepProjection} The populated <code>RecoveryPlanJobExecutionStepProjection</code> instance.
+   */
+  static constructFromObject(data, obj = null, callFromChild = false) {
+    let items, item, i, itemArr, discriminator;
+    if (data) {
+      obj = obj || new RecoveryPlanJobExecutionStepProjection();
+      _RecoveryPlanJobExecutionStep.default.constructFromObject(data, obj, true);
+      if (!callFromChild) {
+        obj.$unknownFields = {
+          ...data.$unknownFields
+        };
+        for (const property in data) {
+          // Check if the `property` is not already present in `obj` keys, either in snake_case or camelCase,
+          // as the model's fields are generated in camelCase, but the server might return snake_case (e.g., due to standards like OIDC).
+          // Also, ensure the `property` does not start with '$' and end with 'ItemDiscriminator'.
+          // If all conditions are true, add the `property` from `data` to `obj.$unknownFields` as an unknown field.
+          if (!Object.keys(obj).includes(property) && !Object.keys(obj).includes(this.snakeToCamel(property)) && !(property[0] === "$" && property.endsWith("ItemDiscriminator"))) {
+            obj.$unknownFields[property] = data[property];
+          }
+        }
+      }
+    }
+    return obj;
+  }
+
+  /**
+  * Converts a given snake_case string to camelCase.
+  * @param {string} snakeStr - The input string in snake_case format.
+  * @returns {string} - The converted string in camelCase format.
+  */
+  static snakeToCamel(snakeStr) {
+    return snakeStr.replace(/(_\w)/g, match => match[1].toUpperCase());
+  }
+  validate(scope, properties) {
+    let propList = [];
+    if (arguments.length === 0 || arguments.length === 1 && arguments[0] instanceof _ValidationScopes.default) {
+      //cases validate() and validate(scope)
+      propList = [];
+    } else if (arguments.length === 1) {
+      //case validate(properties)
+      propList = arguments[0];
+      scope = null;
+    } else {
+      //case validate(scope, properties)
+      propList = arguments[1];
+    }
+    let res = [];
+    let err = null;
+    propList.forEach(property => {
+      err = this.validateProperty(property, scope);
+      if (err) {
+        res.push(err);
+      }
+    });
+    return new Promise(function (resolve, reject) {
+      if (res.length !== 0) {
+        reject(err);
+      } else {
+        resolve();
+      }
+    });
+  }
+  validateProperty(scope, property) {
+    return new _ValidationError.default(property, "no such property exists");
+  }
+}
+exports.default = RecoveryPlanJobExecutionStepProjection;

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

@@ -0,0 +1,19 @@
+export default RecoveryPlanJobPhaseType;
+/**
+ * *
+ */
+type RecoveryPlanJobPhaseType = string;
+declare namespace RecoveryPlanJobPhaseType {
+    /**
+    * Returns a <code>RecoveryPlanJobPhaseType</code> enum value from a JavaScript object name.
+    * @param {Object} obj The plain JavaScript object containing the name of the enum value.
+    * @return {RecoveryPlanJobPhaseType} The enum <code>RecoveryPlanJobPhaseType</code> value.
+    */
+    function constructFromObject(obj: any): string;
+    /**
+    * Validates <code>RecoveryPlanJobPhaseType</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/RecoveryPlanJobPhaseType.js

@@ -0,0 +1,89 @@
+"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 RecoveryPlanJobPhaseType.
+ * @enum {string}
+ * @readonly
+ */
+const RecoveryPlanJobPhaseType = {
+  /** 
+   * Unknown value.
+    * @const
+   */
+  $UNKNOWN: "$UNKNOWN",
+  /** 
+   * Redacted value.
+    * @const
+   */
+  $REDACTED: "$REDACTED",
+  /** 
+   * The PRE_PROCESSING phase is the initial stage of a recovery plan job execution. It encompasses all preparatory actions and validations performed before the main recovery operation (like FAILOVER) starts. Key activities in this phase include system and environment checks, entity validation, infrastructure preparation at the recovery site, data synchronization for planned failovers, and conflict checks to ensure the environment is fully prepared for a successful recovery.
+   * @const
+   */
+  PRE_PROCESSING: "PRE_PROCESSING",
+  /** 
+   * The ENTITY_RECOVERY phase is the core stage of a recovery plan job, where the actual recovery of specified entities takes place at the recovery location. Occurring after the preparatory PRE_PROCESSING phase, its key operations include restoring or migrating entities from their snapshots, powering on virtual machines once they are recovered, and executing the recovery in predefined stages according to the plan's configuration.
+   * @const
+   */
+  ENTITY_RECOVERY: "ENTITY_RECOVERY",
+  /** 
+   * The POST_PROCESSING phase is the final stage of a recovery plan job, executing after the main entity recovery is complete. It handles all concluding clean-up and finalization tasks to wrap up the process. Key actions include auditing the entire job to verify its completion and creating a new Consistency Group from the successfully recovered entities.
+   * @const
+   */
+  POST_PROCESSING: "POST_PROCESSING"
+};
+
+/**
+* Returns a <code>RecoveryPlanJobPhaseType</code> enum value from a JavaScript object name.
+* @param {Object} obj The plain JavaScript object containing the name of the enum value.
+* @return {RecoveryPlanJobPhaseType} The enum <code>RecoveryPlanJobPhaseType</code> value.
+*/
+RecoveryPlanJobPhaseType.constructFromObject = function (obj) {
+  if (typeof obj === 'string' || obj instanceof String) {
+    let enumVal = Object.keys(RecoveryPlanJobPhaseType).find(key => RecoveryPlanJobPhaseType[key] === obj);
+    return enumVal === undefined || enumVal === null ? RecoveryPlanJobPhaseType.$UNKNOWN : RecoveryPlanJobPhaseType[enumVal];
+  } else {
+    throw new Error("Received object name is not an instance of String");
+  }
+};
+
+/**
+* Validates <code>RecoveryPlanJobPhaseType</code> enum value.
+* @param {Object} obj The plain JavaScript object containing the name of the enum value.
+* @return {null} Throws error for invalid value.
+*/
+RecoveryPlanJobPhaseType.validate = function (obj) {
+  switch (obj) {
+    case RecoveryPlanJobPhaseType.$UNKNOWN:
+    case RecoveryPlanJobPhaseType.$REDACTED:
+    case RecoveryPlanJobPhaseType.PRE_PROCESSING:
+    case RecoveryPlanJobPhaseType.ENTITY_RECOVERY:
+    case RecoveryPlanJobPhaseType.POST_PROCESSING:
+      return;
+    default:
+      throw new Error("Invalid : must be RecoveryPlanJobPhaseType.{ $UNKNOWN|$REDACTED|PRE_PROCESSING|ENTITY_RECOVERY|POST_PROCESSING }");
+  }
+};
+Object.freeze(RecoveryPlanJobPhaseType);
+var _default = exports.default = RecoveryPlanJobPhaseType;

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

@@ -0,0 +1,10 @@
+/**
+ * The RecoveryPlanJobProjection model module.
+ * @module Ntnx/RecoveryPlanJobProjection
+ * @version 4.2.1
+ * @class RecoveryPlanJobProjection
+ * @extends RecoveryPlanJob
+ */
+export default class RecoveryPlanJobProjection extends RecoveryPlanJob {
+}
+import RecoveryPlanJob from "./RecoveryPlanJob";

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

@@ -0,0 +1,128 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _TenantAwareModel = _interopRequireDefault(require("../../../common/v1/config/TenantAwareModel"));
+var _ExternalizableAbstractModel = _interopRequireDefault(require("../../../common/v1/response/ExternalizableAbstractModel"));
+var _FailoverDirection = _interopRequireDefault(require("./FailoverDirection"));
+var _PhaseSummary = _interopRequireDefault(require("./PhaseSummary"));
+var _RecoveryPlanActionType = _interopRequireDefault(require("./RecoveryPlanActionType"));
+var _RecoveryPlanJob = _interopRequireDefault(require("./RecoveryPlanJob"));
+var _RecoveryPlanJobExecutionStatus = _interopRequireDefault(require("./RecoveryPlanJobExecutionStatus"));
+var _Summary = _interopRequireDefault(require("./Summary"));
+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.
+ *
+ */
+
+/**
+ * The RecoveryPlanJobProjection model module.
+ * @module Ntnx/RecoveryPlanJobProjection
+ * @version 4.2.1
+ * @class RecoveryPlanJobProjection
+ * @extends RecoveryPlanJob
+ */
+class RecoveryPlanJobProjection extends _RecoveryPlanJob.default {
+  /**
+   * Constructs a new <code>RecoveryPlanJobProjection</code>.
+   * @alias module:Ntnx/RecoveryPlanJobProjection
+   * @extends module:Ntnx/RecoveryPlanJob
+  */
+  constructor() {
+    super();
+    this.$objectType = "dataprotection.v4.config.RecoveryPlanJobProjection";
+    /** @type {object<string, any>} */
+    this.$reserved = {
+      '$fv': "v4.r2"
+    };
+    /** @type {object<string, any>} */
+    this.$unknownFields = {};
+  }
+
+  /**
+   * Constructs a <code>RecoveryPlanJobProjection</code> from a plain JavaScript object, optionally creating a new instance.
+   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+   * @param {Object} data The plain JavaScript object bearing properties of interest.
+   * @param {module:Ntnx/RecoveryPlanJobProjection} obj Optional instance to populate.
+   * @param callFromChild {Boolean} Flag to recognise calling instance
+   * @return {module:Ntnx/RecoveryPlanJobProjection} The populated <code>RecoveryPlanJobProjection</code> instance.
+   */
+  static constructFromObject(data, obj = null, callFromChild = false) {
+    let items, item, i, itemArr, discriminator;
+    if (data) {
+      obj = obj || new RecoveryPlanJobProjection();
+      _RecoveryPlanJob.default.constructFromObject(data, obj, true);
+      if (!callFromChild) {
+        obj.$unknownFields = {
+          ...data.$unknownFields
+        };
+        for (const property in data) {
+          // Check if the `property` is not already present in `obj` keys, either in snake_case or camelCase,
+          // as the model's fields are generated in camelCase, but the server might return snake_case (e.g., due to standards like OIDC).
+          // Also, ensure the `property` does not start with '$' and end with 'ItemDiscriminator'.
+          // If all conditions are true, add the `property` from `data` to `obj.$unknownFields` as an unknown field.
+          if (!Object.keys(obj).includes(property) && !Object.keys(obj).includes(this.snakeToCamel(property)) && !(property[0] === "$" && property.endsWith("ItemDiscriminator"))) {
+            obj.$unknownFields[property] = data[property];
+          }
+        }
+      }
+    }
+    return obj;
+  }
+
+  /**
+  * Converts a given snake_case string to camelCase.
+  * @param {string} snakeStr - The input string in snake_case format.
+  * @returns {string} - The converted string in camelCase format.
+  */
+  static snakeToCamel(snakeStr) {
+    return snakeStr.replace(/(_\w)/g, match => match[1].toUpperCase());
+  }
+  validate(scope, properties) {
+    let propList = [];
+    if (arguments.length === 0 || arguments.length === 1 && arguments[0] instanceof _ValidationScopes.default) {
+      //cases validate() and validate(scope)
+      propList = [];
+    } else if (arguments.length === 1) {
+      //case validate(properties)
+      propList = arguments[0];
+      scope = null;
+    } else {
+      //case validate(scope, properties)
+      propList = arguments[1];
+    }
+    let res = [];
+    let err = null;
+    propList.forEach(property => {
+      err = this.validateProperty(property, scope);
+      if (err) {
+        res.push(err);
+      }
+    });
+    return new Promise(function (resolve, reject) {
+      if (res.length !== 0) {
+        reject(err);
+      } else {
+        resolve();
+      }
+    });
+  }
+  validateProperty(scope, property) {
+    return new _ValidationError.default(property, "no such property exists");
+  }
+}
+exports.default = RecoveryPlanJobProjection;

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

@@ -0,0 +1,32 @@
+/**
+ * The RecoveryPlanValidationError model module.
+ * @module Ntnx/RecoveryPlanValidationError
+ * @version 4.2.1
+ * @class RecoveryPlanValidationError
+ * @extends ErrorMessage
+ */
+export default class RecoveryPlanValidationError extends ErrorMessage {
+    /**
+     * Returns List of affected entities.
+     * @return {EntityReference[]}
+     */
+    getAffectedEntities(): EntityReference[];
+    /**
+     * Sets List of affected entities.
+     * @param {EntityReference[]} affectedEntities List of affected entities.
+     */
+    setAffectedEntities(affectedEntities: EntityReference[]): void;
+    affectedEntities: EntityReference[];
+    /**
+     * @return {RootCauseAnalysis}
+     */
+    getRootCauseAnalysis(): RootCauseAnalysis;
+    /**
+     * @param {RootCauseAnalysis} rootCauseAnalysis
+     */
+    setRootCauseAnalysis(rootCauseAnalysis: RootCauseAnalysis): void;
+    rootCauseAnalysis: RootCauseAnalysis;
+    #private;
+}
+import ErrorMessage from "./ErrorMessage";
+import RootCauseAnalysis from "./RootCauseAnalysis";