com.quantum.dxi.rest.system

Class SoftwarePatchUpgradeStats

java.lang.Object

Base

com.quantum.dxi.rest.system.SoftwarePatchUpgradeStats

public class SoftwarePatchUpgradeStats
extends Base

The SoftwarePatchUpgradeStats resource represents statistics related to downloading and installing upgrades on the system. The SoftwarePatchUpgradeStats resource includes services for getting the statistics from the system.

The schema that defines the SystemAuditLogConfig resource is defined below.

 
    <xs:element name="SoftwarePatchUpgradeStats">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:long" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Total number of Software Patch Upgrade entries</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element ref="SoftwarePatchUpgradeStat" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="SoftwarePatchUpgradeStat">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="Id" type="xs:string"/>
                <xs:element name="DownloadBytes" type="xs:long"/>
                <xs:element name="NumOfDownloadFiles" type="xs:int"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="SoftwarePatchUpgradeStatColumnName">
        <xs:annotation>
            <xs:documentation>An enum containing the valid column names for a SoftwarePatchUpgradeStat</xs:documentation>
        </xs:annotation>
        <xs:simpleType>
            <xs:restriction base="xs:string">
                <xs:enumeration value="SoftwarepatchupgradestatId"/>
                <xs:enumeration value="SoftwarepatchupgradestatDownloadBytes"/>
                <xs:enumeration value="SoftwarepatchupgradestatNumOfDownloadFiles"/>
            </xs:restriction>
        </xs:simpleType>
    </xs:element>
 
 

Constructor Summary

Constructors

Constructor and Description
SoftwarePatchUpgradeStats()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	downloadStats(javax.servlet.http.HttpServletRequest request, String upgradeId, String errorType) POST /rest/SoftwarePatchUpgradeStats/{upgradeId}/downloadStats
NumericScalarType	getAction(javax.servlet.http.HttpServletRequest request, String actionString, String upgradeId, String errorType) Deprecated. As of 1.1, replaced by downloadStats(HttpServletRequest, String, String)

Methods inherited from class java.lang.Object

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

Constructor Detail

SoftwarePatchUpgradeStats

public SoftwarePatchUpgradeStats()

Method Detail

downloadStats

public javax.ws.rs.core.Response downloadStats(@Context
                                               javax.servlet.http.HttpServletRequest request,
                                               String upgradeId,
                                               String errorType)

POST /rest/SoftwarePatchUpgradeStats/{upgradeId}/downloadStats

Start a background job to determine patch upgrade size prior to download. The API cannot provide any useful information in case upgrade download is already in progress or complete.

Response Entity Type: <xs:element name="NumericScalarType"> representing the background job id

Since:

1.1

getAction

public NumericScalarType getAction(@Context
                                   javax.servlet.http.HttpServletRequest request,
                                   String actionString,
                                   String upgradeId,
                                   String errorType)

Deprecated. As of 1.1, replaced by downloadStats(HttpServletRequest, String, String)

POST /rest/SoftwarePatchUpgradeStats/{upgradeId}

Perform an action related to the software patch upgrade statistics for an upgrade identified by {upgradeId}.

The action query parameter is required.

Supported actions are:

• ?action=downloadStats start a background job to gather and download the statistics

Response Entity Type: <xs:element name="NumericScalarType"> representing the background job id