@nutanix-scratch/aiops-js-client 4.0.3-alpha.2 → 4.2.2-beta.1

package/dist/lib/models/aiops/v4/config/VmWorkload.js

@@ -0,0 +1,294 @@
+"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 }; }
+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 AIOps APIs
+ *
+ * OpenAPI spec version: 4.2.2-beta-1
+ *
+ * NOTE: This class is auto generated by the Open API Dev Platform.
+ *
+ * Open API Dev Platform Codegen version: 17.5.1.10573-RELEASE
+ *
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * The VmWorkload model module.
+ * @module Ntnx/VmWorkload
+ * @version 4.2.2-beta-1
+ * @class VmWorkload
+ * 
+ * @param { Number } vmCount Number of VMs in a VM workload.
+ * 
+ * @param { string } simulationExtId The UUID of the simulation that is created manually.
+ */
+var _VmWorkload_brand = /*#__PURE__*/new WeakSet();
+class VmWorkload {
+  /**
+   * Constructs a new <code>VmWorkload</code>.
+   * VM workload description.
+   * @alias module:Ntnx/VmWorkload
+   * 
+   * @param { Number } vmCount Number of VMs in a VM workload.
+   * 
+   * @param { string } simulationExtId The UUID of the simulation that is created manually.
+  */
+  constructor(vmCount, simulationExtId) {
+    /*
+    * 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, _VmWorkload_brand);
+    this.vmCount = vmCount;
+    this.simulationExtId = simulationExtId;
+    this.$objectType = "aiops.v4.config.VmWorkload";
+    /** @type {object<string, any>} */
+    this.$reserved = {
+      '$fv': "v4.r2.b1"
+    };
+    /** @type {object<string, any>} */
+    this.$unknownFields = {};
+  }
+
+  /**
+   * Constructs a <code>VmWorkload</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/VmWorkload} obj Optional instance to populate.
+   * @param callFromChild {Boolean} Flag to recognise calling instance
+   * @return {module:Ntnx/VmWorkload} The populated <code>VmWorkload</code> instance.
+   */
+  static constructFromObject(data, obj = null, callFromChild = false) {
+    let items, item, i, itemArr, discriminator;
+    if (data) {
+      obj = obj || new VmWorkload();
+      if (data.hasOwnProperty('vmCount') && data.vmCount !== null && data.vmCount !== undefined) {
+        obj.setVmCount(data['vmCount']);
+      }
+      if (data.hasOwnProperty('simulationExtId') && data.simulationExtId !== null && data.simulationExtId !== undefined) {
+        obj.setSimulationExtId(data['simulationExtId']);
+      }
+      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());
+  }
+
+  /**
+   * Returns Number of VMs in a VM workload.
+   * minimum: 1
+   * maximum: 20000
+   * @return {Number}
+   */
+  getVmCount() {
+    return this.vmCount;
+  }
+
+  /**
+   * Sets Number of VMs in a VM workload.
+   * @param {Number} vmCount Number of VMs in a VM workload.
+   */
+  setVmCount(vmCount) {
+    this.vmCount = vmCount;
+  }
+
+  /**
+   * Returns The UUID of the simulation that is created manually.
+   * @return {string}
+   */
+  getSimulationExtId() {
+    return this.simulationExtId;
+  }
+
+  /**
+   * Sets The UUID of the simulation that is created manually.
+   * @param {string} simulationExtId The UUID of the simulation that is created manually.
+   */
+  setSimulationExtId(simulationExtId) {
+    this.simulationExtId = simulationExtId;
+  }
+  get$Reserved() {
+    return this.$reserved;
+  }
+  get$ObjectType() {
+    return this.$objectType;
+  }
+  get$UnknownFields() {
+    return this.$unknownFields;
+  }
+  toJson(forMutation) {
+    if (forMutation === false) {
+      return {
+        ...(typeof this.getVmCount() !== 'undefined' && this.getVmCount() !== null ? {
+          'vmCount': this.getVmCount()
+        } : {}),
+        ...(typeof this.getSimulationExtId() !== 'undefined' && this.getSimulationExtId() !== null ? {
+          'simulationExtId': this.getSimulationExtId()
+        } : {}),
+        '$reserved': this.get$Reserved(),
+        '$objectType': this.get$ObjectType(),
+        ...(typeof this.get$UnknownFields() !== 'undefined' && this.get$UnknownFields() !== null ? this.get$UnknownFields() : {}),
+        '$unknownFields': {}
+      };
+    }
+    return {
+      ...(typeof this.getVmCount() !== 'undefined' && this.getVmCount() !== null ? {
+        'vmCount': this.getVmCount()
+      } : {}),
+      ...(typeof this.getSimulationExtId() !== 'undefined' && this.getSimulationExtId() !== null ? {
+        'simulationExtId': this.getSimulationExtId()
+      } : {}),
+      '$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 = ["vmCount", "simulationExtId"];
+    } 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 === "vmCount") {
+      if (typeof this.vmCount === 'undefined' || this.vmCount === null) {
+        return new _ValidationError.default("vmCount", "undefined or null");
+      }
+      if (!_ValidationUtils.default.validateMaximum(this.vmCount, 20000)) {
+        return new _ValidationError.default("vmCount", "does not satisfy required maximum constraint: 20000");
+      }
+      if (!_ValidationUtils.default.validateMinimum(this.vmCount, 1)) {
+        return new _ValidationError.default("vmCount", "does not satisfy required minimum constraint: 1");
+      }
+    }
+    if (property === "simulationExtId") {
+      if (typeof this.simulationExtId === 'undefined' || this.simulationExtId === null) {
+        return new _ValidationError.default("simulationExtId", "undefined or null");
+      }
+      if (!_ValidationUtils.default.validatePattern(this.simulationExtId, /^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)) {
+        return new _ValidationError.default("simulationExtId", "does not satisfy required pattern: /^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/");
+      }
+    }
+    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");
+  }
+}
+
+/**
+ * Number of VMs in a VM workload.
+ * @memberof VmWorkload
+ */
+exports.default = VmWorkload;
+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;
+}
+VmWorkload.prototype.vmCount = undefined;
+
+/**
+ * The UUID of the simulation that is created manually.
+ * @memberof VmWorkload
+ */
+VmWorkload.prototype.simulationExtId = undefined;
+VmWorkload.prototype.$reserved = undefined;
+VmWorkload.prototype.$objectType = undefined;
+VmWorkload.prototype.$unknownFields = undefined;
+
+// Implement OneOfaiops.v4.config.WorkloadworkloadProperties interface:

package/dist/lib/models/aiops/v4/config/Workload.d.ts

@@ -0,0 +1,105 @@
+/**
+ * The Workload model module.
+ * @module Ntnx/Workload
+ * @version 4.2.2-beta-1
+ * @class Workload
+ *
+ * @param { Date } scheduleDate Time since the workload is planned to run on a cluster.
+ *
+ * @param { boolean } isEnabled Flag to indicate whether the added workload in the planned capacity scenario is to be included in whatif analysis or to be ignored.
+ * @param { SqlWorkload | VmWorkload | VdiWorkload | SplunkWorkload | CitrixXenWorkload | MicrosoftXenWorkload | CapacityUpdateConfig | VmCategoryWorkload } workloadProperties Metadata about the workload in a capacity planning scenario. For example, if SQL is added as a workload, then the number of users and database transaction type will be metadata for it.
+ *
+ */
+export default class Workload {
+    /**
+     * Constructs a <code>Workload</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/Workload} obj Optional instance to populate.
+     * @param callFromChild {Boolean} Flag to recognise calling instance
+     * @return {module:Ntnx/Workload} The populated <code>Workload</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;
+    /**
+     * Constructs a new <code>Workload</code>.
+     * Workload in a scenario.
+     * @alias module:Ntnx/Workload
+     *
+     * @param { Date } scheduleDate Time since the workload is planned to run on a cluster.
+     *
+     * @param { boolean } isEnabled Flag to indicate whether the added workload in the planned capacity scenario is to be included in whatif analysis or to be ignored.
+     * @param { SqlWorkload | VmWorkload | VdiWorkload | SplunkWorkload | CitrixXenWorkload | MicrosoftXenWorkload | CapacityUpdateConfig | VmCategoryWorkload } workloadProperties Metadata about the workload in a capacity planning scenario. For example, if SQL is added as a workload, then the number of users and database transaction type will be metadata for it.
+     *
+    */
+    constructor(scheduleDate: Date, isEnabled: boolean, workloadProperties: SqlWorkload | VmWorkload | VdiWorkload | SplunkWorkload | CitrixXenWorkload | MicrosoftXenWorkload | CapacityUpdateConfig | VmCategoryWorkload);
+    scheduleDate: Date;
+    isEnabled: boolean;
+    workloadProperties: CapacityUpdateConfig | CitrixXenWorkload | MicrosoftXenWorkload | SplunkWorkload | SqlWorkload | VdiWorkload | VmCategoryWorkload | VmWorkload;
+    $objectType: string;
+    /** @type {object<string, any>} */
+    $reserved: object;
+    /** @type {object<string, any>} */
+    $unknownFields: object;
+    /**
+     * Returns Time since the workload is planned to run on a cluster.
+     * @return {Date}
+     */
+    getScheduleDate(): Date;
+    /**
+     * Sets Time since the workload is planned to run on a cluster.
+     * @param {Date} scheduleDate Time since the workload is planned to run on a cluster.
+     */
+    setScheduleDate(scheduleDate: Date): void;
+    /**
+     * Returns Flag to indicate whether the added workload in the planned capacity scenario is to be included in whatif analysis or to be ignored.
+     * @return {boolean}
+     */
+    getIsEnabled(): boolean;
+    /**
+     * Sets Flag to indicate whether the added workload in the planned capacity scenario is to be included in whatif analysis or to be ignored.
+     * @param {boolean} isEnabled Flag to indicate whether the added workload in the planned capacity scenario is to be included in whatif analysis or to be ignored.
+     */
+    setIsEnabled(isEnabled: boolean): void;
+    /**
+     * @return {ResourceCapacity}
+     */
+    getProjectedResourceRequirement(): ResourceCapacity;
+    /**
+     * @param {ResourceCapacity} projectedResourceRequirement
+     */
+    setProjectedResourceRequirement(projectedResourceRequirement: ResourceCapacity): void;
+    projectedResourceRequirement: ResourceCapacity;
+    /**
+     * Returns Metadata about the workload in a capacity planning scenario. For example, if SQL is added as a workload, then the number of users and database transaction type will be metadata for it.
+     * @return {SqlWorkload | VmWorkload | VdiWorkload | SplunkWorkload | CitrixXenWorkload | MicrosoftXenWorkload | CapacityUpdateConfig | VmCategoryWorkload}
+     */
+    getWorkloadProperties(): SqlWorkload | VmWorkload | VdiWorkload | SplunkWorkload | CitrixXenWorkload | MicrosoftXenWorkload | CapacityUpdateConfig | VmCategoryWorkload;
+    /**
+     * Sets Metadata about the workload in a capacity planning scenario. For example, if SQL is added as a workload, then the number of users and database transaction type will be metadata for it.
+     * @param {SqlWorkload | VmWorkload | VdiWorkload | SplunkWorkload | CitrixXenWorkload | MicrosoftXenWorkload | CapacityUpdateConfig | VmCategoryWorkload} workloadProperties Metadata about the workload in a capacity planning scenario. For example, if SQL is added as a workload, then the number of users and database transaction type will be metadata for it.
+     */
+    setWorkloadProperties(workloadProperties: SqlWorkload | VmWorkload | VdiWorkload | SplunkWorkload | CitrixXenWorkload | MicrosoftXenWorkload | CapacityUpdateConfig | VmCategoryWorkload): void;
+    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 CapacityUpdateConfig from "./CapacityUpdateConfig";
+import CitrixXenWorkload from "./CitrixXenWorkload";
+import MicrosoftXenWorkload from "./MicrosoftXenWorkload";
+import SplunkWorkload from "./SplunkWorkload";
+import SqlWorkload from "./SqlWorkload";
+import VdiWorkload from "./VdiWorkload";
+import VmCategoryWorkload from "./VmCategoryWorkload";
+import VmWorkload from "./VmWorkload";
+import ResourceCapacity from "./ResourceCapacity";
+import ValidationError from "../../../validation/ValidationError";