@nutanix-scratch/monitoring-js-client 4.0.1-beta.1 → 4.1.1

package/dist/es/models/monitoring/v4/common/MetricDetail.d.ts

@@ -1,7 +1,7 @@
 /**
  * The MetricDetail model module.
  * @module Ntnx/MetricDetail
- * @version 4.0.1-beta-1
+ * @version 4.1.1
  * @class MetricDetail
  */
 export default class MetricDetail {
@@ -13,152 +13,161 @@ export default class MetricDetail {
      * @param callFromChild {Boolean} Flag to recognise calling instance
      * @return {module:Ntnx/MetricDetail} The populated <code>MetricDetail</code> instance.
      */
-    static constructFromObject(data: any, obj: any, callFromChild?: boolean): any;
+    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;
-    $reserved: {
-        $fv: string;
-    };
-    $unknownFields: {};
+    /** @type {object<string, any>} */
+    $reserved: object;
+    /** @type {object<string, any>} */
+    $unknownFields: object;
     /**
-     * Returns The metric key. Allowed values of metrics list can be found at https://portal.nutanix.com/page/documents/details?targetId=Prism-Central-Guide-vpc_2022_9:mul-alerts-user-created-metrics-r.html
-     * @return {}
+     * Returns The metric key. Allowed values of the metrics list can be found at https://portal.nutanix.com/page/documents/details?targetId=Prism-Central-Guide-vpc_2022_9:mul-alerts-user-created-metrics-r.html.
+     * @return {string}
      */
-    getMetricName(): any;
+    getMetricName(): string;
     /**
-     * Sets The metric key. Allowed values of metrics list can be found at https://portal.nutanix.com/page/documents/details?targetId=Prism-Central-Guide-vpc_2022_9:mul-alerts-user-created-metrics-r.html
-     * @param {} metricName The metric key. Allowed values of metrics list can be found at https://portal.nutanix.com/page/documents/details?targetId=Prism-Central-Guide-vpc_2022_9:mul-alerts-user-created-metrics-r.html
+     * Sets The metric key. Allowed values of the metrics list can be found at https://portal.nutanix.com/page/documents/details?targetId=Prism-Central-Guide-vpc_2022_9:mul-alerts-user-created-metrics-r.html.
+     * @param {string} metricName The metric key. Allowed values of the metrics list can be found at https://portal.nutanix.com/page/documents/details?targetId=Prism-Central-Guide-vpc_2022_9:mul-alerts-user-created-metrics-r.html.
      */
-    setMetricName(metricName: any): void;
-    metricName: any;
+    setMetricName(metricName: string): void;
+    metricName: string;
     /**
-     * Returns English readable name of the metric.
-     * @return {}
+     * Returns Readable name of the metric in English.
+     * @return {string}
      */
-    getMetricDisplayName(): any;
+    getMetricDisplayName(): string;
     /**
-     * Sets English readable name of the metric.
-     * @param {} metricDisplayName English readable name of the metric.
+     * Sets Readable name of the metric in English.
+     * @param {string} metricDisplayName Readable name of the metric in English.
      */
-    setMetricDisplayName(metricDisplayName: any): void;
-    metricDisplayName: any;
+    setMetricDisplayName(metricDisplayName: string): void;
+    metricDisplayName: string;
     /**
-     * Returns Unit of the metric. For example, percentage, ms, or usecs.
-     * @return {}
+     * Returns Unit of the metric. For example, percentage, ms or usecs.
+     * @return {string}
      */
-    getUnit(): any;
+    getUnit(): string;
     /**
-     * Sets Unit of the metric. For example, percentage, ms, or usecs.
-     * @param {} unit Unit of the metric. For example, percentage, ms, or usecs.
+     * Sets Unit of the metric. For example, percentage, ms or usecs.
+     * @param {string} unit Unit of the metric. For example, percentage, ms or usecs.
      */
-    setUnit(unit: any): void;
-    unit: any;
+    setUnit(unit: string): void;
+    unit: string;
     /**
      * Returns How long the metric breached the given condition before raising an event.
-     * @return {}
+     * @return {Number}
      */
-    getTriggerWaitTime(): any;
+    getTriggerWaitTimeSeconds(): number;
     /**
      * Sets How long the metric breached the given condition before raising an event.
-     * @param {} triggerWaitTime How long the metric breached the given condition before raising an event.
+     * @param {Number} triggerWaitTimeSeconds How long the metric breached the given condition before raising an event.
      */
-    setTriggerWaitTime(triggerWaitTime: any): void;
-    triggerWaitTime: any;
+    setTriggerWaitTimeSeconds(triggerWaitTimeSeconds: number): void;
+    triggerWaitTimeSeconds: number;
     /**
      * Returns The time in ISO 8601 format when the event was triggered.
-     * @return {}
+     * @return {Date}
      */
-    getTriggerTime(): any;
+    getTriggerTime(): Date;
     /**
      * Sets The time in ISO 8601 format when the event was triggered.
-     * @param {} triggerTime The time in ISO 8601 format when the event was triggered.
+     * @param {Date} triggerTime The time in ISO 8601 format when the event was triggered.
      */
-    setTriggerTime(triggerTime: any): void;
-    triggerTime: any;
+    setTriggerTime(triggerTime: Date): void;
+    triggerTime: Date;
     /**
-     * @return {}
+     * @return {ComparisonOperator}
      */
-    getComparisonOperator(): any;
+    getComparisonOperator(): ComparisonOperator;
     /**
-     * @param {} comparisonOperator
+     * @param {ComparisonOperator} comparisonOperator
      */
-    setComparisonOperator(comparisonOperator: any): void;
-    comparisonOperator: any;
+    setComparisonOperator(comparisonOperator: ComparisonOperator): void;
+    comparisonOperator: string;
     /**
-     * @return {}
+     * @return {ConditionType}
      */
-    getConditionType(): any;
+    getConditionType(): ConditionType;
     /**
-     * @param {} conditionType
+     * @param {ConditionType} conditionType
      */
-    setConditionType(conditionType: any): void;
-    conditionType: any;
+    setConditionType(conditionType: ConditionType): void;
+    conditionType: string;
     /**
-     * Returns Broad category under which this metric falls. For example, Disk, CPU, or Memory.
-     * @return {}
+     * Returns Broad category under which this metric falls. For example, disk, CPU, or memory.
+     * @return {string}
      */
-    getMetricCategory(): any;
+    getMetricCategory(): string;
     /**
-     * Sets Broad category under which this metric falls. For example, Disk, CPU, or Memory.
-     * @param {} metricCategory Broad category under which this metric falls. For example, Disk, CPU, or Memory.
+     * Sets Broad category under which this metric falls. For example, disk, CPU, or memory.
+     * @param {string} metricCategory Broad category under which this metric falls. For example, disk, CPU, or memory.
      */
-    setMetricCategory(metricCategory: any): void;
-    metricCategory: any;
+    setMetricCategory(metricCategory: string): void;
+    metricCategory: string;
     /**
-     * @return {}
+     * @return {DataType}
      */
-    getDataType(): any;
+    getDataType(): DataType;
     /**
-     * @param {} dataType
+     * @param {DataType} dataType
      */
-    setDataType(dataType: any): void;
-    dataType: any;
+    setDataType(dataType: DataType): void;
+    dataType: string;
     /**
      * Returns The threshold value that was used for the condition evaluation.
-     * @return {}
+     * @return {StringValue | BoolValue | DoubleValue | IntValue}
      */
-    getThresholdValue(): any;
+    getThresholdValue(): StringValue | BoolValue | DoubleValue | IntValue;
     /**
      * Sets The threshold value that was used for the condition evaluation.
-     * @param {} thresholdValue The threshold value that was used for the condition evaluation.
+     * @param {StringValue | BoolValue | DoubleValue | IntValue} thresholdValue The threshold value that was used for the condition evaluation.
      */
-    setThresholdValue(thresholdValue: any): void;
-    thresholdValue: any;
+    setThresholdValue(thresholdValue: StringValue | BoolValue | DoubleValue | IntValue): void;
+    thresholdValue: BoolValue | DoubleValue | IntValue | StringValue;
     /**
-     * Returns Raw value of the metric when the condition threshold was exceeded.
-     * @return {}
+     * Returns The raw value of the metric when the condition threshold was exceeded.
+     * @return {StringValue | BoolValue | DoubleValue | IntValue}
      */
-    getMetricValue(): any;
+    getMetricValue(): StringValue | BoolValue | DoubleValue | IntValue;
     /**
-     * Sets Raw value of the metric when the condition threshold was exceeded.
-     * @param {} metricValue Raw value of the metric when the condition threshold was exceeded.
+     * Sets The raw value of the metric when the condition threshold was exceeded.
+     * @param {StringValue | BoolValue | DoubleValue | IntValue} metricValue The raw value of the metric when the condition threshold was exceeded.
      */
-    setMetricValue(metricValue: any): void;
-    metricValue: any;
-    get$Reserved(): {
-        $fv: string;
-    };
+    setMetricValue(metricValue: StringValue | BoolValue | DoubleValue | IntValue): void;
+    metricValue: BoolValue | DoubleValue | IntValue | StringValue;
+    get$Reserved(): any;
     get$ObjectType(): string;
-    get$UnknownFields(): {};
+    get$UnknownFields(): any;
     toJson(forMutation: any): {
-        $reserved: {
-            $fv: string;
-        };
+        $reserved: any;
         $objectType: string;
-        $unknownFields: {};
+        $unknownFields: any;
         metricValue?: any;
         thresholdValue?: any;
-        dataType?: any;
-        metricCategory?: any;
-        conditionType?: any;
-        comparisonOperator?: any;
+        dataType?: string;
+        metricCategory?: string;
+        conditionType?: string;
+        comparisonOperator?: string;
         triggerTime?: any;
-        triggerWaitTime?: any;
-        unit?: any;
-        metricDisplayName?: any;
-        metricName?: any;
+        triggerWaitTimeSeconds?: number;
+        unit?: string;
+        metricDisplayName?: string;
+        metricName?: string;
     };
     validate(scope: any, properties: any, ...args: any[]): Promise<any>;
     validateProperty(scope: any, property: any): ValidationError;
     #private;
 }
+import ComparisonOperator from "./ComparisonOperator";
+import ConditionType from "./ConditionType";
+import DataType from "./DataType";
+import StringValue from "./StringValue";
+import BoolValue from "./BoolValue";
+import DoubleValue from "./DoubleValue";
+import IntValue from "./IntValue";
 import ValidationError from "../../../validation/ValidationError";