com.quantum.dxi.rest.system

Class QualityMetrics

java.lang.Object

Base

com.quantum.dxi.rest.system.QualityMetrics

public class QualityMetrics
extends Base

The QualityMetrics resource provides installation and uptime metrics on the system, including planned and unplanned downtime. The QualityMetrics resource includes services for getting the metrics from the system.

The schema that defines the QualityMetrics resource is defined below.

 
    <xs:element name="QualityMetrics">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="InstallationTime" type="xs:long">
                    <xs:annotation><xs:documentation>The time (in milliseconds since the epoch) the system first boots to normal mode at the customer site.</xs:documentation></xs:annotation>
                </xs:element>
                <xs:element name="Uptime" type="xs:int">
                    <xs:annotation><xs:documentation>The duration (in minutes) the system is in normal mode.</xs:documentation></xs:annotation>
                </xs:element>
                <xs:element name="PlannedDowntime" type="xs:int">
                    <xs:annotation><xs:documentation>The duration (in minutes) between the system leaving normal mode for a clean shutdown until it enters normal mode after reboot.</xs:documentation></xs:annotation>
                </xs:element>
                <xs:element name="UnplannedDowntime" type="xs:int">
                    <xs:annotation><xs:documentation>The duration (in minutes) between the system leaving normal mode for any reason besides a clean shutdown until the system enters normal mode after reboot.</xs:documentation></xs:annotation>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="QualityMetricsScalarNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="QualitymetricsInstallationTime"/>
            <xs:enumeration value="QualitymetricsUptime"/>
            <xs:enumeration value="QualitymetricsPlannedDowntime"/>
            <xs:enumeration value="QualitymetricsUnplannedDowntime"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
QualityMetrics()

Method Summary

Modifier and Type	Method and Description
com.quantum.dxi.dao.types.QualityMetrics	getQualityMetrics_1_1(javax.servlet.http.HttpServletRequest request) GET /rest/QualityMetrics
com.quantum.dxi.dao.types.QualityMetrics	getQualityMetrics(javax.servlet.http.HttpServletRequest request, String actionString) Deprecated. As of 1.1, the ?action query parameter is unsupported; replaced by getQualityMetrics_1_1(HttpServletRequest)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QualityMetrics

public QualityMetrics()

Method Detail

getQualityMetrics_1_1

public com.quantum.dxi.dao.types.QualityMetrics getQualityMetrics_1_1(@Context
                                                                      javax.servlet.http.HttpServletRequest request)

GET /rest/QualityMetrics

Get the quality metrics data from the system.

Response Entity type: <xs:element name="QualityMetrics">

Since:

1.1

getQualityMetrics

public com.quantum.dxi.dao.types.QualityMetrics getQualityMetrics(@Context
                                                                  javax.servlet.http.HttpServletRequest request,
                                                                  String actionString)

Deprecated. As of 1.1, the ?action query parameter is unsupported; replaced by getQualityMetrics_1_1(HttpServletRequest)

GET /rest/QualityMetrics

Get the quality metrics data from the system.

The action query parameter is optional.

Supported actions are:

• ?action=getInstallationTime Only the installation time is returned in the response.
• ?action=getUpDownTime Only the uptime and downtime data are returned in the response.

Response Entity type: <xs:element name="QualityMetrics">