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

package/dist/lib/models/monitoring/v4/serviceability/Alert.d.ts

@@ -1,316 +1,377 @@
 /**
  * The Alert model module.
  * @module Ntnx/Alert
- * @version 4.0.1-beta-1
+ * @version 4.0.1
  * @class Alert
+ * @extends ExternalizableAbstractModel
  */
 export default class Alert extends ExternalizableAbstractModel {
     /**
-     * Returns Field specifies if the alert is acknowledged or not.
-     * @return {}
+     * Returns Indicates whether the alert is acknowledged or not.
+     * @return {boolean}
      */
-    getIsAcknowledged(): any;
+    getIsAcknowledged(): boolean;
     /**
-     * Sets Field specifies if the alert is acknowledged or not.
-     * @param {} isAcknowledged Field specifies if the alert is acknowledged or not.
+     * Sets Indicates whether the alert is acknowledged or not.
+     * @param {boolean} isAcknowledged Indicates whether the alert is acknowledged or not.
      */
-    setIsAcknowledged(isAcknowledged: any): void;
-    isAcknowledged: any;
+    setIsAcknowledged(isAcknowledged: boolean): void;
+    isAcknowledged: boolean;
     /**
      * Returns Name of the user who acknowledged this alert.
-     * @return {}
+     * @return {string}
      */
-    getAcknowledgedByUsername(): any;
+    getAcknowledgedByUsername(): string;
     /**
      * Sets Name of the user who acknowledged this alert.
-     * @param {} acknowledgedByUsername Name of the user who acknowledged this alert.
+     * @param {string} acknowledgedByUsername Name of the user who acknowledged this alert.
      */
-    setAcknowledgedByUsername(acknowledgedByUsername: any): void;
-    acknowledgedByUsername: any;
+    setAcknowledgedByUsername(acknowledgedByUsername: string): void;
+    acknowledgedByUsername: string;
     /**
      * Returns The time in ISO 8601 format when the alert was acknowledged.
-     * @return {}
+     * @return {Date}
      */
-    getAcknowledgedTime(): any;
+    getAcknowledgedTime(): Date;
     /**
      * Sets The time in ISO 8601 format when the alert was acknowledged.
-     * @param {} acknowledgedTime The time in ISO 8601 format when the alert was acknowledged.
+     * @param {Date} acknowledgedTime The time in ISO 8601 format when the alert was acknowledged.
      */
-    setAcknowledgedTime(acknowledgedTime: any): void;
-    acknowledgedTime: any;
+    setAcknowledgedTime(acknowledgedTime: Date): void;
+    acknowledgedTime: Date;
     /**
-     * Returns Field specifies if the alert is auto resolved or not.
-     * @return {}
+     * Returns Indicates whether the alert is auto-resolved or not.
+     * @return {boolean}
      */
-    getIsAutoResolved(): any;
+    getIsAutoResolved(): boolean;
     /**
-     * Sets Field specifies if the alert is auto resolved or not.
-     * @param {} isAutoResolved Field specifies if the alert is auto resolved or not.
+     * Sets Indicates whether the alert is auto-resolved or not.
+     * @param {boolean} isAutoResolved Indicates whether the alert is auto-resolved or not.
      */
-    setIsAutoResolved(isAutoResolved: any): void;
-    isAutoResolved: any;
+    setIsAutoResolved(isAutoResolved: boolean): void;
+    isAutoResolved: boolean;
     /**
-     * Returns Field specifies if the alert is resolved or not.
-     * @return {}
+     * Returns Indicates whether the alert is resolved or not.
+     * @return {boolean}
      */
-    getIsResolved(): any;
+    getIsResolved(): boolean;
     /**
-     * Sets Field specifies if the alert is resolved or not.
-     * @param {} isResolved Field specifies if the alert is resolved or not.
+     * Sets Indicates whether the alert is resolved or not.
+     * @param {boolean} isResolved Indicates whether the alert is resolved or not.
      */
-    setIsResolved(isResolved: any): void;
-    isResolved: any;
+    setIsResolved(isResolved: boolean): void;
+    isResolved: boolean;
     /**
      * Returns Name of the user who resolved this alert.
-     * @return {}
+     * @return {string}
      */
-    getResolvedByUsername(): any;
+    getResolvedByUsername(): string;
     /**
      * Sets Name of the user who resolved this alert.
-     * @param {} resolvedByUsername Name of the user who resolved this alert.
+     * @param {string} resolvedByUsername Name of the user who resolved this alert.
      */
-    setResolvedByUsername(resolvedByUsername: any): void;
-    resolvedByUsername: any;
+    setResolvedByUsername(resolvedByUsername: string): void;
+    resolvedByUsername: string;
     /**
      * Returns The time in ISO 8601 format when the alert was resolved.
-     * @return {}
+     * @return {Date}
      */
-    getResolvedTime(): any;
+    getResolvedTime(): Date;
     /**
      * Sets The time in ISO 8601 format when the alert was resolved.
-     * @param {} resolvedTime The time in ISO 8601 format when the alert was resolved.
+     * @param {Date} resolvedTime The time in ISO 8601 format when the alert was resolved.
      */
-    setResolvedTime(resolvedTime: any): void;
-    resolvedTime: any;
+    setResolvedTime(resolvedTime: Date): void;
+    resolvedTime: Date;
     /**
-     * @return {}
+     * @return {AlertEntityReference}
      */
-    getSourceEntity(): any;
+    getSourceEntity(): AlertEntityReference;
     /**
-     * @param {} sourceEntity
+     * @param {AlertEntityReference} sourceEntity
      */
-    setSourceEntity(sourceEntity: any): void;
-    sourceEntity: any;
+    setSourceEntity(sourceEntity: AlertEntityReference): void;
+    sourceEntity: AlertEntityReference;
     /**
-     * Returns List of all entities that are affected by the alert.
-     * @return {}
+     * Returns List of all the entities that are affected by the alert.
+     * @return {EntityReference[]}
      */
-    getAffectedEntities(): any;
+    getAffectedEntities(): EntityReference[];
     /**
-     * Sets List of all entities that are affected by the alert.
-     * @param {} affectedEntities List of all entities that are affected by the alert.
+     * Sets List of all the entities that are affected by the alert.
+     * @param {EntityReference[]} affectedEntities List of all the entities that are affected by the alert.
      */
-    setAffectedEntities(affectedEntities: any): void;
-    affectedEntities: any;
+    setAffectedEntities(affectedEntities: EntityReference[]): void;
+    affectedEntities: EntityReference[];
     /**
      * Returns Contains information on the severity change history for alerts. If an alert was de-duplicated without change in severity, then no trail will be present.
-     * @return {}
+     * @return {SeverityTrail[]}
      */
-    getSeverityTrails(): any;
+    getSeverityTrails(): SeverityTrail[];
     /**
      * Sets Contains information on the severity change history for alerts. If an alert was de-duplicated without change in severity, then no trail will be present.
-     * @param {} severityTrails Contains information on the severity change history for alerts. If an alert was de-duplicated without change in severity, then no trail will be present.
+     * @param {SeverityTrail[]} severityTrails Contains information on the severity change history for alerts. If an alert was de-duplicated without change in severity, then no trail will be present.
      */
-    setSeverityTrails(severityTrails: any): void;
-    severityTrails: any;
+    setSeverityTrails(severityTrails: SeverityTrail[]): void;
+    severityTrails: SeverityTrail[];
     /**
      * Returns Details of the metric for a metric-based event.
-     * @return {}
+     * @return {MetricDetail[]}
      */
-    getMetricDetails(): any;
+    getMetricDetails(): MetricDetail[];
     /**
      * Sets Details of the metric for a metric-based event.
-     * @param {} metricDetails Details of the metric for a metric-based event.
+     * @param {MetricDetail[]} metricDetails Details of the metric for a metric-based event.
      */
-    setMetricDetails(metricDetails: any): void;
-    metricDetails: any;
+    setMetricDetails(metricDetails: MetricDetail[]): void;
+    metricDetails: MetricDetail[];
     /**
      * Returns Title of the alert.
-     * @return {}
+     * @return {string}
      */
-    getTitle(): any;
+    getTitle(): string;
     /**
      * Sets Title of the alert.
-     * @param {} title Title of the alert.
+     * @param {string} title Title of the alert.
      */
-    setTitle(title: any): void;
-    title: any;
+    setTitle(title: string): void;
+    title: string;
     /**
      * Returns A preconfigured or dynamically generated unique value for each alert type. For example, A1128  for storage pool space exceeded alerts.
-     * @return {}
+     * @return {string}
      */
-    getAlertType(): any;
+    getAlertType(): string;
     /**
      * Sets A preconfigured or dynamically generated unique value for each alert type. For example, A1128  for storage pool space exceeded alerts.
-     * @param {} alertType A preconfigured or dynamically generated unique value for each alert type. For example, A1128  for storage pool space exceeded alerts.
+     * @param {string} alertType A preconfigured or dynamically generated unique value for each alert type. For example, A1128  for storage pool space exceeded alerts.
      */
-    setAlertType(alertType: any): void;
-    alertType: any;
+    setAlertType(alertType: string): void;
+    alertType: string;
     /**
-     * Returns Various categories into which this alert type can be classified. For example, Hardware, Storage, or License.
-     * @return {}
+     * Returns Various categories into which this alert type can be classified. For example, hardware, storage, or license.
+     * @return {string[]}
      */
-    getClassifications(): any;
+    getClassifications(): string[];
     /**
-     * Sets Various categories into which this alert type can be classified. For example, Hardware, Storage, or License.
-     * @param {} classifications Various categories into which this alert type can be classified. For example, Hardware, Storage, or License.
+     * Sets Various categories into which this alert type can be classified. For example, hardware, storage, or license.
+     * @param {string[]} classifications Various categories into which this alert type can be classified. For example, hardware, storage, or license.
      */
-    setClassifications(classifications: any): void;
-    classifications: any;
+    setClassifications(classifications: string[]): void;
+    classifications: string[];
     /**
      * Returns Cluster UUID associated with the source entity of the alert.
-     * @return {}
+     * @return {string}
      */
-    getClusterUUID(): any;
+    getClusterUUID(): string;
     /**
      * Sets Cluster UUID associated with the source entity of the alert.
-     * @param {} clusterUUID Cluster UUID associated with the source entity of the alert.
+     * @param {string} clusterUUID Cluster UUID associated with the source entity of the alert.
      */
-    setClusterUUID(clusterUUID: any): void;
-    clusterUUID: any;
+    setClusterUUID(clusterUUID: string): void;
+    clusterUUID: string;
     /**
      * Returns Time in ISO 8601 format when the alert was created.
-     * @return {}
+     * @return {Date}
      */
-    getCreationTime(): any;
+    getCreationTime(): Date;
     /**
      * Sets Time in ISO 8601 format when the alert was created.
-     * @param {} creationTime Time in ISO 8601 format when the alert was created.
+     * @param {Date} creationTime Time in ISO 8601 format when the alert was created.
      */
-    setCreationTime(creationTime: any): void;
-    creationTime: any;
+    setCreationTime(creationTime: Date): void;
+    creationTime: Date;
     /**
      * Returns The impact this alert or event will have on the system. For example, availability, performance, or capacity.
-     * @return {}
+     * @return {ImpactType[]}
      */
-    getImpactTypes(): any;
+    getImpactTypes(): ImpactType[];
     /**
      * Sets The impact this alert or event will have on the system. For example, availability, performance, or capacity.
-     * @param {} impactTypes The impact this alert or event will have on the system. For example, availability, performance, or capacity.
+     * @param {ImpactType[]} impactTypes The impact this alert or event will have on the system. For example, availability, performance, or capacity.
      */
-    setImpactTypes(impactTypes: any): void;
-    impactTypes: any;
+    setImpactTypes(impactTypes: ImpactType[]): void;
+    impactTypes: string[];
     /**
      * Returns Time in ISO 8601 format when the alert was last updated.
-     * @return {}
+     * @return {Date}
      */
-    getLastUpdatedTime(): any;
+    getLastUpdatedTime(): Date;
     /**
      * Sets Time in ISO 8601 format when the alert was last updated.
-     * @param {} lastUpdatedTime Time in ISO 8601 format when the alert was last updated.
+     * @param {Date} lastUpdatedTime Time in ISO 8601 format when the alert was last updated.
      */
-    setLastUpdatedTime(lastUpdatedTime: any): void;
-    lastUpdatedTime: any;
+    setLastUpdatedTime(lastUpdatedTime: Date): void;
+    lastUpdatedTime: Date;
     /**
      * Returns Additional message associated with the alert.
-     * @return {}
+     * @return {string}
      */
-    getMessage(): any;
+    getMessage(): string;
     /**
      * Sets Additional message associated with the alert.
-     * @param {} message Additional message associated with the alert.
+     * @param {string} message Additional message associated with the alert.
      */
-    setMessage(message: any): void;
-    message: any;
+    setMessage(message: string): void;
+    message: string;
     /**
      * Returns Cluster UUID associated with the cluster where the alert was first raised.
-     * @return {}
+     * @return {string}
      */
-    getOriginatingClusterUUID(): any;
+    getOriginatingClusterUUID(): string;
     /**
      * Sets Cluster UUID associated with the cluster where the alert was first raised.
-     * @param {} originatingClusterUUID Cluster UUID associated with the cluster where the alert was first raised.
+     * @param {string} originatingClusterUUID Cluster UUID associated with the cluster where the alert was first raised.
      */
-    setOriginatingClusterUUID(originatingClusterUUID: any): void;
-    originatingClusterUUID: any;
+    setOriginatingClusterUUID(originatingClusterUUID: string): void;
+    originatingClusterUUID: string;
     /**
-     * @return {}
+     * @return {Severity}
      */
-    getSeverity(): any;
+    getSeverity(): Severity;
     /**
-     * @param {} severity
+     * @param {Severity} severity
      */
-    setSeverity(severity: any): void;
-    severity: any;
+    setSeverity(severity: Severity): void;
+    severity: string;
     /**
-     * Returns Flag to indicate if the alert was generated from a user defined alert policy.
-     * @return {}
+     * Returns Flag to indicate if the alert was generated from a User-Defined Alert policy.
+     * @return {boolean}
      */
-    getIsUserDefined(): any;
+    getIsUserDefined(): boolean;
     /**
-     * Sets Flag to indicate if the alert was generated from a user defined alert policy.
-     * @param {} isUserDefined Flag to indicate if the alert was generated from a user defined alert policy.
+     * Sets Flag to indicate if the alert was generated from a User-Defined Alert policy.
+     * @param {boolean} isUserDefined Flag to indicate if the alert was generated from a User-Defined Alert policy.
      */
-    setIsUserDefined(isUserDefined: any): void;
-    isUserDefined: any;
+    setIsUserDefined(isUserDefined: boolean): void;
+    isUserDefined: boolean;
     /**
-     * Returns Additional parameters associated with the alert. These parameters can be used to indicate custom key-value pairs for a given alert instance. For example, Service down in Prism Central alert can have the service name as a parameter.
-     * @return {}
+     * Returns Additional parameters associated with the alert. These parameters can be used to indicate custom key-value pairs for a given alert instance. For example, a service down in Prism Central alert can have the service name as a parameter.
+     * @return {Parameter[]}
      */
-    getParameters(): any;
+    getParameters(): Parameter[];
     /**
-     * Sets Additional parameters associated with the alert. These parameters can be used to indicate custom key-value pairs for a given alert instance. For example, Service down in Prism Central alert can have the service name as a parameter.
-     * @param {} parameters Additional parameters associated with the alert. These parameters can be used to indicate custom key-value pairs for a given alert instance. For example, Service down in Prism Central alert can have the service name as a parameter.
+     * Sets Additional parameters associated with the alert. These parameters can be used to indicate custom key-value pairs for a given alert instance. For example, a service down in Prism Central alert can have the service name as a parameter.
+     * @param {Parameter[]} parameters Additional parameters associated with the alert. These parameters can be used to indicate custom key-value pairs for a given alert instance. For example, a service down in Prism Central alert can have the service name as a parameter.
      */
-    setParameters(parameters: any): void;
-    parameters: any;
+    setParameters(parameters: Parameter[]): void;
+    parameters: Parameter[];
     /**
-     * Returns The service that raised the alert. For internal Nutanix services, this value is set to \"Nutanix\".
-     * @return {}
+     * Returns The service that raised the alert.
+     * @return {string}
      */
-    getServiceName(): any;
+    getServiceName(): string;
     /**
-     * Sets The service that raised the alert. For internal Nutanix services, this value is set to \"Nutanix\".
-     * @param {} serviceName The service that raised the alert. For internal Nutanix services, this value is set to \"Nutanix\".
+     * Sets The service that raised the alert.
+     * @param {string} serviceName The service that raised the alert.
      */
-    setServiceName(serviceName: any): void;
-    serviceName: any;
+    setServiceName(serviceName: string): void;
+    serviceName: string;
     /**
      * Returns Possible causes, resolutions and additional details to troubleshoot this alert.
-     * @return {}
+     * @return {RootCauseAnalysis[]}
      */
-    getRootCauseAnalysis(): any;
+    getRootCauseAnalysis(): RootCauseAnalysis[];
     /**
      * Sets Possible causes, resolutions and additional details to troubleshoot this alert.
-     * @param {} rootCauseAnalysis Possible causes, resolutions and additional details to troubleshoot this alert.
+     * @param {RootCauseAnalysis[]} rootCauseAnalysis Possible causes, resolutions and additional details to troubleshoot this alert.
      */
-    setRootCauseAnalysis(rootCauseAnalysis: any): void;
-    rootCauseAnalysis: any;
+    setRootCauseAnalysis(rootCauseAnalysis: RootCauseAnalysis[]): void;
+    rootCauseAnalysis: RootCauseAnalysis[];
     toJson(forMutation: any): {
-        $reserved: {
-            $fv: string;
-        };
+        $reserved: any;
         $objectType: string;
-        $unknownFields: {};
-        tenantId?: any;
-        links?: any;
-        extId?: any;
-        rootCauseAnalysis?: any;
-        serviceName?: any;
-        parameters?: any;
-        isUserDefined?: any;
-        severity?: any;
-        originatingClusterUUID?: any;
-        message?: any;
+        $unknownFields: any;
+        tenantId?: string;
+        links?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            rel?: string;
+            href?: string;
+        }[];
+        extId?: string;
+        rootCauseAnalysis?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            detail?: string;
+            resolution?: string;
+            cause?: string;
+        }[];
+        serviceName?: string;
+        parameters?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            paramValue?: any;
+            paramName?: string;
+        }[];
+        isUserDefined?: boolean;
+        severity?: string;
+        originatingClusterUUID?: string;
+        message?: string;
         lastUpdatedTime?: any;
-        impactTypes?: any;
+        impactTypes?: string[];
         creationTime?: any;
-        clusterUUID?: any;
-        classifications?: any;
-        alertType?: any;
-        title?: any;
-        metricDetails?: any;
-        severityTrails?: any;
-        affectedEntities?: any;
-        sourceEntity?: any;
+        clusterUUID?: string;
+        classifications?: string[];
+        alertType?: string;
+        title?: string;
+        metricDetails?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            metricValue?: any;
+            thresholdValue?: any;
+            dataType?: string;
+            metricCategory?: string;
+            conditionType?: string;
+            comparisonOperator?: string;
+            triggerTime?: any;
+            triggerWaitTimeSeconds?: number;
+            unit?: string;
+            metricDisplayName?: string;
+            metricName?: string;
+        }[];
+        severityTrails?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            severityChangeTime?: any;
+            severity?: string;
+        }[];
+        affectedEntities?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            extId?: string;
+            name?: string;
+            type?: string;
+        }[];
+        sourceEntity?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            extId?: string;
+            name?: string;
+            type?: string;
+        };
         resolvedTime?: any;
-        resolvedByUsername?: any;
-        isResolved?: any;
-        isAutoResolved?: any;
+        resolvedByUsername?: string;
+        isResolved?: boolean;
+        isAutoResolved?: boolean;
         acknowledgedTime?: any;
-        acknowledgedByUsername?: any;
-        isAcknowledged?: any;
+        acknowledgedByUsername?: string;
+        isAcknowledged?: boolean;
     };
     #private;
 }
 import ExternalizableAbstractModel from "../../../common/v1/response/ExternalizableAbstractModel";
+import AlertEntityReference from "../common/AlertEntityReference";
+import EntityReference from "../common/EntityReference";
+import SeverityTrail from "./SeverityTrail";
+import MetricDetail from "../common/MetricDetail";
+import ImpactType from "../common/ImpactType";
+import Severity from "../common/Severity";
+import Parameter from "../common/Parameter";
+import RootCauseAnalysis from "./RootCauseAnalysis";