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

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

@@ -0,0 +1,316 @@
+/**
+ * The Alert model module.
+ * @module Ntnx/Alert
+ * @version 4.0.1-beta-1
+ * @class Alert
+ */
+export default class Alert extends ExternalizableAbstractModel {
+    /**
+     * Returns Field specifies if the alert is acknowledged or not.
+     * @return {}
+     */
+    getIsAcknowledged(): any;
+    /**
+     * Sets Field specifies if the alert is acknowledged or not.
+     * @param {} isAcknowledged Field specifies if the alert is acknowledged or not.
+     */
+    setIsAcknowledged(isAcknowledged: any): void;
+    isAcknowledged: any;
+    /**
+     * Returns Name of the user who acknowledged this alert.
+     * @return {}
+     */
+    getAcknowledgedByUsername(): any;
+    /**
+     * Sets Name of the user who acknowledged this alert.
+     * @param {} acknowledgedByUsername Name of the user who acknowledged this alert.
+     */
+    setAcknowledgedByUsername(acknowledgedByUsername: any): void;
+    acknowledgedByUsername: any;
+    /**
+     * Returns The time in ISO 8601 format when the alert was acknowledged.
+     * @return {}
+     */
+    getAcknowledgedTime(): any;
+    /**
+     * 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.
+     */
+    setAcknowledgedTime(acknowledgedTime: any): void;
+    acknowledgedTime: any;
+    /**
+     * Returns Field specifies if the alert is auto resolved or not.
+     * @return {}
+     */
+    getIsAutoResolved(): any;
+    /**
+     * Sets Field specifies if the alert is auto resolved or not.
+     * @param {} isAutoResolved Field specifies if the alert is auto resolved or not.
+     */
+    setIsAutoResolved(isAutoResolved: any): void;
+    isAutoResolved: any;
+    /**
+     * Returns Field specifies if the alert is resolved or not.
+     * @return {}
+     */
+    getIsResolved(): any;
+    /**
+     * Sets Field specifies if the alert is resolved or not.
+     * @param {} isResolved Field specifies if the alert is resolved or not.
+     */
+    setIsResolved(isResolved: any): void;
+    isResolved: any;
+    /**
+     * Returns Name of the user who resolved this alert.
+     * @return {}
+     */
+    getResolvedByUsername(): any;
+    /**
+     * Sets Name of the user who resolved this alert.
+     * @param {} resolvedByUsername Name of the user who resolved this alert.
+     */
+    setResolvedByUsername(resolvedByUsername: any): void;
+    resolvedByUsername: any;
+    /**
+     * Returns The time in ISO 8601 format when the alert was resolved.
+     * @return {}
+     */
+    getResolvedTime(): any;
+    /**
+     * 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.
+     */
+    setResolvedTime(resolvedTime: any): void;
+    resolvedTime: any;
+    /**
+     * @return {}
+     */
+    getSourceEntity(): any;
+    /**
+     * @param {} sourceEntity
+     */
+    setSourceEntity(sourceEntity: any): void;
+    sourceEntity: any;
+    /**
+     * Returns List of all entities that are affected by the alert.
+     * @return {}
+     */
+    getAffectedEntities(): any;
+    /**
+     * Sets List of all entities that are affected by the alert.
+     * @param {} affectedEntities List of all entities that are affected by the alert.
+     */
+    setAffectedEntities(affectedEntities: any): void;
+    affectedEntities: any;
+    /**
+     * 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 {}
+     */
+    getSeverityTrails(): any;
+    /**
+     * 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.
+     */
+    setSeverityTrails(severityTrails: any): void;
+    severityTrails: any;
+    /**
+     * Returns Details of the metric for a metric-based event.
+     * @return {}
+     */
+    getMetricDetails(): any;
+    /**
+     * Sets Details of the metric for a metric-based event.
+     * @param {} metricDetails Details of the metric for a metric-based event.
+     */
+    setMetricDetails(metricDetails: any): void;
+    metricDetails: any;
+    /**
+     * Returns Title of the alert.
+     * @return {}
+     */
+    getTitle(): any;
+    /**
+     * Sets Title of the alert.
+     * @param {} title Title of the alert.
+     */
+    setTitle(title: any): void;
+    title: any;
+    /**
+     * Returns A preconfigured or dynamically generated unique value for each alert type. For example, A1128  for storage pool space exceeded alerts.
+     * @return {}
+     */
+    getAlertType(): any;
+    /**
+     * 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.
+     */
+    setAlertType(alertType: any): void;
+    alertType: any;
+    /**
+     * Returns Various categories into which this alert type can be classified. For example, Hardware, Storage, or License.
+     * @return {}
+     */
+    getClassifications(): any;
+    /**
+     * 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.
+     */
+    setClassifications(classifications: any): void;
+    classifications: any;
+    /**
+     * Returns Cluster UUID associated with the source entity of the alert.
+     * @return {}
+     */
+    getClusterUUID(): any;
+    /**
+     * Sets Cluster UUID associated with the source entity of the alert.
+     * @param {} clusterUUID Cluster UUID associated with the source entity of the alert.
+     */
+    setClusterUUID(clusterUUID: any): void;
+    clusterUUID: any;
+    /**
+     * Returns Time in ISO 8601 format when the alert was created.
+     * @return {}
+     */
+    getCreationTime(): any;
+    /**
+     * Sets Time in ISO 8601 format when the alert was created.
+     * @param {} creationTime Time in ISO 8601 format when the alert was created.
+     */
+    setCreationTime(creationTime: any): void;
+    creationTime: any;
+    /**
+     * Returns The impact this alert or event will have on the system. For example, availability, performance, or capacity.
+     * @return {}
+     */
+    getImpactTypes(): any;
+    /**
+     * 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.
+     */
+    setImpactTypes(impactTypes: any): void;
+    impactTypes: any;
+    /**
+     * Returns Time in ISO 8601 format when the alert was last updated.
+     * @return {}
+     */
+    getLastUpdatedTime(): any;
+    /**
+     * 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.
+     */
+    setLastUpdatedTime(lastUpdatedTime: any): void;
+    lastUpdatedTime: any;
+    /**
+     * Returns Additional message associated with the alert.
+     * @return {}
+     */
+    getMessage(): any;
+    /**
+     * Sets Additional message associated with the alert.
+     * @param {} message Additional message associated with the alert.
+     */
+    setMessage(message: any): void;
+    message: any;
+    /**
+     * Returns Cluster UUID associated with the cluster where the alert was first raised.
+     * @return {}
+     */
+    getOriginatingClusterUUID(): any;
+    /**
+     * 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.
+     */
+    setOriginatingClusterUUID(originatingClusterUUID: any): void;
+    originatingClusterUUID: any;
+    /**
+     * @return {}
+     */
+    getSeverity(): any;
+    /**
+     * @param {} severity
+     */
+    setSeverity(severity: any): void;
+    severity: any;
+    /**
+     * Returns Flag to indicate if the alert was generated from a user defined alert policy.
+     * @return {}
+     */
+    getIsUserDefined(): any;
+    /**
+     * 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.
+     */
+    setIsUserDefined(isUserDefined: any): void;
+    isUserDefined: any;
+    /**
+     * 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 {}
+     */
+    getParameters(): any;
+    /**
+     * 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.
+     */
+    setParameters(parameters: any): void;
+    parameters: any;
+    /**
+     * Returns The service that raised the alert. For internal Nutanix services, this value is set to \"Nutanix\".
+     * @return {}
+     */
+    getServiceName(): any;
+    /**
+     * 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\".
+     */
+    setServiceName(serviceName: any): void;
+    serviceName: any;
+    /**
+     * Returns Possible causes, resolutions and additional details to troubleshoot this alert.
+     * @return {}
+     */
+    getRootCauseAnalysis(): any;
+    /**
+     * Sets Possible causes, resolutions and additional details to troubleshoot this alert.
+     * @param {} rootCauseAnalysis Possible causes, resolutions and additional details to troubleshoot this alert.
+     */
+    setRootCauseAnalysis(rootCauseAnalysis: any): void;
+    rootCauseAnalysis: any;
+    toJson(forMutation: any): {
+        $reserved: {
+            $fv: string;
+        };
+        $objectType: string;
+        $unknownFields: {};
+        tenantId?: any;
+        links?: any;
+        extId?: any;
+        rootCauseAnalysis?: any;
+        serviceName?: any;
+        parameters?: any;
+        isUserDefined?: any;
+        severity?: any;
+        originatingClusterUUID?: any;
+        message?: any;
+        lastUpdatedTime?: any;
+        impactTypes?: any;
+        creationTime?: any;
+        clusterUUID?: any;
+        classifications?: any;
+        alertType?: any;
+        title?: any;
+        metricDetails?: any;
+        severityTrails?: any;
+        affectedEntities?: any;
+        sourceEntity?: any;
+        resolvedTime?: any;
+        resolvedByUsername?: any;
+        isResolved?: any;
+        isAutoResolved?: any;
+        acknowledgedTime?: any;
+        acknowledgedByUsername?: any;
+        isAcknowledged?: any;
+    };
+    #private;
+}
+import ExternalizableAbstractModel from "../../../common/v1/response/ExternalizableAbstractModel";