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

package/dist/es/models/dataprotection/v4/operations/PlannedFailoverRecoveryPlanApiResponse.d.ts

@@ -0,0 +1,58 @@
+/**
+ * The PlannedFailoverRecoveryPlanApiResponse model module.
+ * @module Ntnx/PlannedFailoverRecoveryPlanApiResponse
+ * @version 4.2.1
+ * @class PlannedFailoverRecoveryPlanApiResponse
+ */
+export default class PlannedFailoverRecoveryPlanApiResponse extends Paginable {
+    /**
+     * Constructs a <code>PlannedFailoverRecoveryPlanApiResponse</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/PlannedFailoverRecoveryPlanApiResponse} obj Optional instance to populate.
+     * @param callFromChild {Boolean} Flag to recognise calling instance
+     * @return {module:Ntnx/PlannedFailoverRecoveryPlanApiResponse} The populated <code>PlannedFailoverRecoveryPlanApiResponse</code> instance.
+     */
+    static constructFromObject(data: any, obj?: any, callFromChild?: boolean): any;
+    /**
+    * 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: string): string;
+    $objectType: string;
+    /** @type {object<string, any>} */
+    $reserved: object;
+    /** @type {object<string, any>} */
+    $unknownFields: object;
+    /**
+     * @return {ApiResponseMetadata}
+     */
+    getMetadata(): ApiResponseMetadata;
+    /**
+     * @param {ApiResponseMetadata} metadata
+     */
+    setMetadata(metadata: ApiResponseMetadata): void;
+    metadata: ApiResponseMetadata;
+    /**
+     * @return {TaskReference | ErrorResponse}
+     */
+    getData(): TaskReference | ErrorResponse;
+    /**
+     * @param {TaskReference | ErrorResponse} data
+     */
+    setData(data: TaskReference | ErrorResponse): void;
+    data: ErrorResponse | TaskReference;
+    get$Reserved(): any;
+    get$ObjectType(): string;
+    get$UnknownFields(): any;
+    toJson(forMutation: any): any;
+    validate(scope: any, properties: any, ...args: any[]): Promise<any>;
+    validateProperty(scope: any, property: any): ValidationError;
+    #private;
+}
+import Paginable from "../../../../Paginable";
+import ApiResponseMetadata from "../../../common/v1/response/ApiResponseMetadata";
+import TaskReference from "../../../prism/v4/config/TaskReference";
+import ErrorResponse from "../error/ErrorResponse";
+import ValidationError from "../../../validation/ValidationError";

package/dist/es/models/dataprotection/v4/operations/PlannedFailoverRecoveryPlanApiResponse.js

@@ -0,0 +1,288 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _ApiResponseMetadata = _interopRequireDefault(require("../../../common/v1/response/ApiResponseMetadata"));
+var _ErrorResponse = _interopRequireDefault(require("../error/ErrorResponse"));
+var _TaskReference = _interopRequireDefault(require("../../../prism/v4/config/TaskReference"));
+var _ValidationScopes = _interopRequireDefault(require("../../../validation/ValidationScopes"));
+var _ValidationUtils = _interopRequireDefault(require("../../../../utils/ValidationUtils"));
+var _ValidationError = _interopRequireDefault(require("../../../validation/ValidationError"));
+var _Paginable = _interopRequireDefault(require("../../../../Paginable"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+function _classPrivateMethodInitSpec(e, a) { _checkPrivateRedeclaration(e, a), a.add(e); }
+function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object"); }
+function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this object"); } /*
+ * 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 PlannedFailoverRecoveryPlanApiResponse model module.
+ * @module Ntnx/PlannedFailoverRecoveryPlanApiResponse
+ * @version 4.2.1
+ * @class PlannedFailoverRecoveryPlanApiResponse
+ */
+var _PlannedFailoverRecoveryPlanApiResponse_brand = /*#__PURE__*/new WeakSet();
+class PlannedFailoverRecoveryPlanApiResponse extends _Paginable.default {
+  /**
+   * Constructs a new <code>PlannedFailoverRecoveryPlanApiResponse</code>.
+   * REST response for all response codes in API path /dataprotection/v4.2/operations/recovery-plans/{recoveryPlanExtId}/$actions/planned-failover Post operation
+   * @alias module:Ntnx/PlannedFailoverRecoveryPlanApiResponse
+  */
+  constructor() {
+    super();
+    /*
+    * toJson method for a map type which supports map with primitive keys and values of object types
+    * @param {Object} obj
+    * @returns {Object|Map} Returns a new transofrmed Map by calling toJson on the values if applicable.
+    * Otherwise, just returns the input object.
+    */
+    _classPrivateMethodInitSpec(this, _PlannedFailoverRecoveryPlanApiResponse_brand);
+    this.$objectType = "dataprotection.v4.operations.PlannedFailoverRecoveryPlanApiResponse";
+    /** @type {object<string, any>} */
+    this.$reserved = {
+      '$fv': "v4.r2"
+    };
+    /** @type {object<string, any>} */
+    this.$unknownFields = {};
+  }
+
+  /**
+   * Constructs a <code>PlannedFailoverRecoveryPlanApiResponse</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/PlannedFailoverRecoveryPlanApiResponse} obj Optional instance to populate.
+   * @param callFromChild {Boolean} Flag to recognise calling instance
+   * @return {module:Ntnx/PlannedFailoverRecoveryPlanApiResponse} The populated <code>PlannedFailoverRecoveryPlanApiResponse</code> instance.
+   */
+  static constructFromObject(data, obj = null, callFromChild = false) {
+    let items, item, i, itemArr, discriminator;
+    if (data) {
+      obj = obj || new PlannedFailoverRecoveryPlanApiResponse();
+      if (data.hasOwnProperty('metadata')) {
+        _Paginable.default.constructFromObject(data['metadata'], obj);
+      }
+      if (data.hasOwnProperty('metadata') && data.metadata !== null && data.metadata !== undefined) {
+        obj.setMetadata(_ApiResponseMetadata.default.constructFromObject(data['metadata']));
+      }
+      if (data.hasOwnProperty('data') && data.data !== null && data.data !== undefined) {
+        if (data['data'].hasOwnProperty('$objectType')) {
+          discriminator = data['data']['$objectType'];
+        } else {
+          discriminator = typeof data['data'];
+        }
+        switch (discriminator) {
+          case 'prism.v4.config.TaskReference':
+            obj.setData(_TaskReference.default.constructFromObject(data['data'], undefined));
+            break;
+          case 'dataprotection.v4.error.ErrorResponse':
+            obj.setData(_ErrorResponse.default.constructFromObject(data['data'], undefined));
+            break;
+          default:
+            throw "Unknown datatype " + discriminator + " in data";
+        }
+      }
+      if (data.hasOwnProperty('$reserved')) {
+        obj.$reserved = data['$reserved'];
+      }
+      if (data.hasOwnProperty('$objectType')) {
+        obj.$objectType = data['$objectType'];
+      }
+      if (data.hasOwnProperty('$unknownFields')) {
+        obj.$unknownFields = data['$unknownFields'];
+      }
+      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());
+  }
+
+  /**
+   * @return {ApiResponseMetadata}
+   */
+  getMetadata() {
+    return this.metadata;
+  }
+
+  /**
+   * @param {ApiResponseMetadata} metadata
+   */
+  setMetadata(metadata) {
+    this.metadata = metadata;
+  }
+
+  /**
+   * @return {TaskReference | ErrorResponse}
+   */
+  getData() {
+    return this.data;
+  }
+
+  /**
+   * @param {TaskReference | ErrorResponse} data
+   */
+  setData(data) {
+    this.data = data;
+  }
+  get$Reserved() {
+    return this.$reserved;
+  }
+  get$ObjectType() {
+    return this.$objectType;
+  }
+  get$UnknownFields() {
+    return this.$unknownFields;
+  }
+  toJson(forMutation) {
+    if (forMutation === false) {
+      return {
+        ...(typeof this.getMetadata() !== 'undefined' && this.getMetadata() !== null ? {
+          'metadata': this.getMetadata().toJson(false)
+        } : {}),
+        ...(typeof this.getData() !== 'undefined' && this.getData() !== null ? {
+          'data': typeof this.getData().toJson !== "undefined" ? this.getData().toJson(false) : Array.isArray(this.getData()) ? this.getData().map(item => typeof item.toJson !== "undefined" ? item.toJson(false) : item) : _assertClassBrand(_PlannedFailoverRecoveryPlanApiResponse_brand, this, _toJsonMapType).call(this, this.getData(), false)
+        } : {}),
+        '$reserved': this.get$Reserved(),
+        '$objectType': this.get$ObjectType(),
+        ...(typeof this.get$UnknownFields() !== 'undefined' && this.get$UnknownFields() !== null ? this.get$UnknownFields() : {}),
+        '$unknownFields': {}
+      };
+    }
+    return {
+      ...(typeof this.getMetadata() !== 'undefined' && this.getMetadata() !== null ? {
+        'metadata': this.getMetadata().toJson(false)
+      } : {}),
+      ...(typeof this.getData() !== 'undefined' && this.getData() !== null ? {
+        'data': typeof this.getData().toJson !== "undefined" ? this.getData().toJson() : Array.isArray(this.getData()) ? this.getData().map(item => typeof item.toJson !== "undefined" ? item.toJson() : item) : _assertClassBrand(_PlannedFailoverRecoveryPlanApiResponse_brand, this, _toJsonMapType).call(this, this.getData())
+      } : {}),
+      '$reserved': this.get$Reserved(),
+      '$objectType': this.get$ObjectType(),
+      ...(typeof this.get$UnknownFields() !== 'undefined' && this.get$UnknownFields() !== null ? this.get$UnknownFields() : {}),
+      '$unknownFields': {}
+    };
+  }
+  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) {
+    if (property === "metadata") {
+      if (typeof this.metadata === 'undefined' || this.metadata === null) {
+        return new _ValidationError.default("metadata", "undefined or null");
+      }
+    }
+    if (property === "data") {
+      if (typeof this.data === 'undefined' || this.data === null) {
+        return new _ValidationError.default("data", "undefined or null");
+      }
+    }
+    if (property === "$reserved") {
+      if (typeof this.$reserved === 'undefined' || this.$reserved === null) {
+        return new _ValidationError.default("$reserved", "undefined or null");
+      }
+    }
+    if (property === "$objectType") {
+      if (typeof this.$objectType === 'undefined' || this.$objectType === null) {
+        return new _ValidationError.default("$objectType", "undefined or null");
+      }
+    }
+    if (property === "$unknownFields") {
+      if (typeof this.$unknownFields === 'undefined' || this.$unknownFields === null) {
+        return new _ValidationError.default("$unknownFields", "undefined or null");
+      }
+    }
+    return new _ValidationError.default(property, "no such property exists");
+  }
+}
+
+/**
+ * @memberof PlannedFailoverRecoveryPlanApiResponse
+ */
+exports.default = PlannedFailoverRecoveryPlanApiResponse;
+function _toJsonMapType(obj, forMutation) {
+  if (obj instanceof Map) {
+    return Object.fromEntries(Array.from(obj, ([k, v]) => [k, typeof v.toJson !== "undefined" ? v.toJson(forMutation) : v]));
+  } else if (typeof obj === 'object' && obj != null && obj.constructor === Object) {
+    return Object.fromEntries(Array.from(Object.entries(obj), entry => {
+      return [entry[0], typeof entry[1].toJson !== "undefined" ? entry[1].toJson(forMutation) : entry[1]];
+    }));
+  }
+  return obj;
+}
+/*
+* toJson method for a date type which serializes a Date object to proper Date or DateTime formatting
+* @param {Object} obj Object to serialize
+* @param {boolean} isDateOnly Boolean variable to identify Date or DateTime format for serialization
+* @returns {Object|string} Returns serialized date object or original input object
+*/
+function _handleDateType(obj, isDateOnly) {
+  if (obj instanceof Date && isDateOnly !== undefined) {
+    return isDateOnly ? obj.toISOString().slice(0, 10) : obj.toISOString();
+  }
+  return obj;
+}
+PlannedFailoverRecoveryPlanApiResponse.prototype.metadata = undefined;
+
+/**
+ * @memberof PlannedFailoverRecoveryPlanApiResponse
+ */
+PlannedFailoverRecoveryPlanApiResponse.prototype.data = undefined;
+PlannedFailoverRecoveryPlanApiResponse.prototype.$reserved = undefined;
+PlannedFailoverRecoveryPlanApiResponse.prototype.$objectType = undefined;
+PlannedFailoverRecoveryPlanApiResponse.prototype.$unknownFields = undefined;

package/dist/es/models/dataprotection/v4/operations/PlannedFailoverSpec.d.ts

@@ -0,0 +1,37 @@
+/**
+ * The PlannedFailoverSpec model module.
+ * @module Ntnx/PlannedFailoverSpec
+ * @version 4.2.1
+ * @class PlannedFailoverSpec
+ * @extends BaseRecoveryPlanActionSpec
+ *
+ * @param { string } name Name of the Recovery Plan Job.
+ *
+ * @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.
+ */
+export default class PlannedFailoverSpec extends BaseRecoveryPlanActionSpec {
+    /**
+     * Returns Indicates whether to continue the recovery plan action despite validation warnings. For example, if the IP of some virtual machines (VMs) cannot be preserved after recovery, the Recovery Plan action can still be initiated by passing `shouldIgnoreWarnings` as `true`. This value allows the recovery operations to continue despite the validation warnings. Alternatively, the user can choose to resolve the validation warnings and trigger another failover action on recovery plan.
+     * @return {boolean}
+     */
+    getShouldIgnoreWarnings(): boolean;
+    /**
+     * Sets Indicates whether to continue the recovery plan action despite validation warnings. For example, if the IP of some virtual machines (VMs) cannot be preserved after recovery, the Recovery Plan action can still be initiated by passing `shouldIgnoreWarnings` as `true`. This value allows the recovery operations to continue despite the validation warnings. Alternatively, the user can choose to resolve the validation warnings and trigger another failover action on recovery plan.
+     * @param {boolean} shouldIgnoreWarnings Indicates whether to continue the recovery plan action despite validation warnings. For example, if the IP of some virtual machines (VMs) cannot be preserved after recovery, the Recovery Plan action can still be initiated by passing `shouldIgnoreWarnings` as `true`. This value allows the recovery operations to continue despite the validation warnings. Alternatively, the user can choose to resolve the validation warnings and trigger another failover action on recovery plan.
+     */
+    setShouldIgnoreWarnings(shouldIgnoreWarnings: boolean): void;
+    shouldIgnoreWarnings: boolean;
+    /**
+     * 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}
+     */
+    getShouldLiveMigrateVMs(): 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} shouldLiveMigrateVMs 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.
+     */
+    setShouldLiveMigrateVMs(shouldLiveMigrateVMs: boolean): void;
+    shouldLiveMigrateVMs: boolean;
+    #private;
+}
+import BaseRecoveryPlanActionSpec from "./BaseRecoveryPlanActionSpec";

package/dist/es/models/dataprotection/v4/operations/PlannedFailoverSpec.js

@@ -0,0 +1,274 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _FailoverDirection = _interopRequireDefault(require("../config/FailoverDirection"));
+var _BaseRecoveryPlanActionSpec = _interopRequireDefault(require("./BaseRecoveryPlanActionSpec"));
+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 }; }
+function _classPrivateMethodInitSpec(e, a) { _checkPrivateRedeclaration(e, a), a.add(e); }
+function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object"); } /*
+ * 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 PlannedFailoverSpec model module.
+ * @module Ntnx/PlannedFailoverSpec
+ * @version 4.2.1
+ * @class PlannedFailoverSpec
+ * @extends BaseRecoveryPlanActionSpec
+ * 
+ * @param { string } name Name of the Recovery Plan Job.
+ * 
+ * @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.
+ */
+var _PlannedFailoverSpec_brand = /*#__PURE__*/new WeakSet();
+class PlannedFailoverSpec extends _BaseRecoveryPlanActionSpec.default {
+  /**
+   * Constructs a new <code>PlannedFailoverSpec</code>.
+   * The planned failover recovery plan action is used to perform a planned failover on the recovery plan.
+   * @alias module:Ntnx/PlannedFailoverSpec
+   * @extends module:Ntnx/BaseRecoveryPlanActionSpec
+   * 
+   * @param { string } name Name of the Recovery Plan Job.
+   * 
+   * @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.
+  */
+  constructor(name, failoverDirections) {
+    super(name, failoverDirections);
+    /*
+    * toJson method for a map type which supports map with primitive keys and values of object types
+    * @param {Object} obj
+    * @returns {Object|Map} Returns a new transofrmed Map by calling toJson on the values if applicable.
+    * Otherwise, just returns the input object.
+    */
+    _classPrivateMethodInitSpec(this, _PlannedFailoverSpec_brand);
+    this.$objectType = "dataprotection.v4.operations.PlannedFailoverSpec";
+    /** @type {object<string, any>} */
+    this.$reserved = {
+      '$fv': "v4.r2"
+    };
+    /** @type {object<string, any>} */
+    this.$unknownFields = {};
+  }
+
+  /**
+   * Constructs a <code>PlannedFailoverSpec</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/PlannedFailoverSpec} obj Optional instance to populate.
+   * @param callFromChild {Boolean} Flag to recognise calling instance
+   * @return {module:Ntnx/PlannedFailoverSpec} The populated <code>PlannedFailoverSpec</code> instance.
+   */
+  static constructFromObject(data, obj = null, callFromChild = false) {
+    let items, item, i, itemArr, discriminator;
+    if (data) {
+      obj = obj || new PlannedFailoverSpec();
+      _BaseRecoveryPlanActionSpec.default.constructFromObject(data, obj, true);
+      if (data.hasOwnProperty('shouldIgnoreWarnings') && data.shouldIgnoreWarnings !== null && data.shouldIgnoreWarnings !== undefined) {
+        obj.setShouldIgnoreWarnings(data['shouldIgnoreWarnings']);
+      }
+      if (data.hasOwnProperty('shouldLiveMigrateVMs') && data.shouldLiveMigrateVMs !== null && data.shouldLiveMigrateVMs !== undefined) {
+        obj.setShouldLiveMigrateVMs(data['shouldLiveMigrateVMs']);
+      }
+      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());
+  }
+
+  /**
+   * Returns Indicates whether to continue the recovery plan action despite validation warnings. For example, if the IP of some virtual machines (VMs) cannot be preserved after recovery, the Recovery Plan action can still be initiated by passing `shouldIgnoreWarnings` as `true`. This value allows the recovery operations to continue despite the validation warnings. Alternatively, the user can choose to resolve the validation warnings and trigger another failover action on recovery plan.
+   * @return {boolean}
+   */
+  getShouldIgnoreWarnings() {
+    return this.shouldIgnoreWarnings;
+  }
+
+  /**
+   * Sets Indicates whether to continue the recovery plan action despite validation warnings. For example, if the IP of some virtual machines (VMs) cannot be preserved after recovery, the Recovery Plan action can still be initiated by passing `shouldIgnoreWarnings` as `true`. This value allows the recovery operations to continue despite the validation warnings. Alternatively, the user can choose to resolve the validation warnings and trigger another failover action on recovery plan.
+   * @param {boolean} shouldIgnoreWarnings Indicates whether to continue the recovery plan action despite validation warnings. For example, if the IP of some virtual machines (VMs) cannot be preserved after recovery, the Recovery Plan action can still be initiated by passing `shouldIgnoreWarnings` as `true`. This value allows the recovery operations to continue despite the validation warnings. Alternatively, the user can choose to resolve the validation warnings and trigger another failover action on recovery plan.
+   */
+  setShouldIgnoreWarnings(shouldIgnoreWarnings) {
+    this.shouldIgnoreWarnings = shouldIgnoreWarnings;
+  }
+
+  /**
+   * 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}
+   */
+  getShouldLiveMigrateVMs() {
+    return this.shouldLiveMigrateVMs;
+  }
+
+  /**
+   * 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} shouldLiveMigrateVMs 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.
+   */
+  setShouldLiveMigrateVMs(shouldLiveMigrateVMs) {
+    this.shouldLiveMigrateVMs = shouldLiveMigrateVMs;
+  }
+  toJson(forMutation) {
+    if (forMutation === false) {
+      return {
+        ...(typeof this.getShouldIgnoreWarnings() !== 'undefined' && this.getShouldIgnoreWarnings() !== null ? {
+          'shouldIgnoreWarnings': this.getShouldIgnoreWarnings()
+        } : {}),
+        ...(typeof this.getShouldLiveMigrateVMs() !== 'undefined' && this.getShouldLiveMigrateVMs() !== null ? {
+          'shouldLiveMigrateVMs': this.getShouldLiveMigrateVMs()
+        } : {}),
+        ...(typeof this.getName() !== 'undefined' && this.getName() !== null ? {
+          'name': this.getName()
+        } : {}),
+        ...(typeof this.getFailoverDirections() !== 'undefined' && this.getFailoverDirections() !== null ? {
+          'failoverDirections': this.getFailoverDirections().map(item => item.toJson(false))
+        } : {}),
+        '$reserved': this.get$Reserved(),
+        '$objectType': this.get$ObjectType(),
+        ...(typeof this.get$UnknownFields() !== 'undefined' && this.get$UnknownFields() !== null ? this.get$UnknownFields() : {}),
+        '$unknownFields': {}
+      };
+    }
+    return {
+      ...(typeof this.getShouldIgnoreWarnings() !== 'undefined' && this.getShouldIgnoreWarnings() !== null ? {
+        'shouldIgnoreWarnings': this.getShouldIgnoreWarnings()
+      } : {}),
+      ...(typeof this.getShouldLiveMigrateVMs() !== 'undefined' && this.getShouldLiveMigrateVMs() !== null ? {
+        'shouldLiveMigrateVMs': this.getShouldLiveMigrateVMs()
+      } : {}),
+      ...(typeof this.getName() !== 'undefined' && this.getName() !== null ? {
+        'name': this.getName()
+      } : {}),
+      ...(typeof this.getFailoverDirections() !== 'undefined' && this.getFailoverDirections() !== null ? {
+        'failoverDirections': this.getFailoverDirections().map(item => item.toJson(false))
+      } : {}),
+      '$reserved': this.get$Reserved(),
+      '$objectType': this.get$ObjectType(),
+      ...(typeof this.get$UnknownFields() !== 'undefined' && this.get$UnknownFields() !== null ? this.get$UnknownFields() : {}),
+      '$unknownFields': {}
+    };
+  }
+  validate(scope, properties) {
+    let propList = [];
+    if (arguments.length === 0 || arguments.length === 1 && arguments[0] instanceof _ValidationScopes.default) {
+      //cases validate() and validate(scope)
+      propList = ["name", "failoverDirections"];
+    } 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) {
+    if (property === "shouldIgnoreWarnings") {
+      if (typeof this.shouldIgnoreWarnings === 'undefined' || this.shouldIgnoreWarnings === null) {
+        return new _ValidationError.default("shouldIgnoreWarnings", "undefined or null");
+      }
+    }
+    if (property === "shouldLiveMigrateVMs") {
+      if (typeof this.shouldLiveMigrateVMs === 'undefined' || this.shouldLiveMigrateVMs === null) {
+        return new _ValidationError.default("shouldLiveMigrateVMs", "undefined or null");
+      }
+    }
+    return new _ValidationError.default(property, "no such property exists");
+  }
+}
+
+/**
+ * Indicates whether to continue the recovery plan action despite validation warnings. For example, if the IP of some virtual machines (VMs) cannot be preserved after recovery, the Recovery Plan action can still be initiated by passing `shouldIgnoreWarnings` as `true`. This value allows the recovery operations to continue despite the validation warnings. Alternatively, the user can choose to resolve the validation warnings and trigger another failover action on recovery plan.
+ * @memberof PlannedFailoverSpec
+ * @default false
+ */
+exports.default = PlannedFailoverSpec;
+function _toJsonMapType(obj, forMutation) {
+  if (obj instanceof Map) {
+    return Object.fromEntries(Array.from(obj, ([k, v]) => [k, typeof v.toJson !== "undefined" ? v.toJson(forMutation) : v]));
+  } else if (typeof obj === 'object' && obj != null && obj.constructor === Object) {
+    return Object.fromEntries(Array.from(Object.entries(obj), entry => {
+      return [entry[0], typeof entry[1].toJson !== "undefined" ? entry[1].toJson(forMutation) : entry[1]];
+    }));
+  }
+  return obj;
+}
+/*
+* toJson method for a date type which serializes a Date object to proper Date or DateTime formatting
+* @param {Object} obj Object to serialize
+* @param {boolean} isDateOnly Boolean variable to identify Date or DateTime format for serialization
+* @returns {Object|string} Returns serialized date object or original input object
+*/
+function _handleDateType(obj, isDateOnly) {
+  if (obj instanceof Date && isDateOnly !== undefined) {
+    return isDateOnly ? obj.toISOString().slice(0, 10) : obj.toISOString();
+  }
+  return obj;
+}
+PlannedFailoverSpec.prototype.shouldIgnoreWarnings = false;
+
+/**
+ * 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.
+ * @memberof PlannedFailoverSpec
+ * @default false
+ */
+PlannedFailoverSpec.prototype.shouldLiveMigrateVMs = false;
+
+/**
+  * Name of the Recovery Plan Job.
+  * @memberof PlannedFailoverSpec
+  */
+_BaseRecoveryPlanActionSpec.default.prototype.name = undefined;
+/**
+  * 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.
+  * @memberof PlannedFailoverSpec
+  */
+_BaseRecoveryPlanActionSpec.default.prototype.failoverDirections = undefined;