com.quantum.dxi.rest.nas

Class ShareTriggeredBaseQueueItems

java.lang.Object

Base

com.quantum.dxi.rest.nas.ShareTriggeredBaseQueueItems

public class ShareTriggeredBaseQueueItems
extends Base

The ShareTriggeredBaseQueueItems resource represents the NAS file-based replication queue on the system. The ShareTriggeredBaseQueueItems interface includes services for getting details about the NAS replication queue.

The schema that defines the ShareTriggeredBaseQueueItems resource is defined below.

 
    <xs:element name="ShareTriggeredBaseQueueItems">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Total number of triggered base items in the queue</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element ref="TriggeredBaseQueueItem" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <xs:element name="TriggeredBaseQueueItem">
       <xs:complexType>
           <xs:sequence>
               <xs:element name="ObjectName" type="xs:string"/>
               <xs:element name="TargetName" type="xs:string"/>
               <xs:element name="DirFileOrBarcode" type="xs:string"/>
               <xs:element name="State" type="xs:string"/>
               <xs:element name="Progress" type="xs:string"/>
               <xs:element name="TimeRemaining" type="xs:double"/>
           </xs:sequence>
       </xs:complexType>
    </xs:element>
    <xs:simpleType name="TriggeredBaseQueueItemColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="ObjectName"/>
            <xs:enumeration value="TargetName"/>
            <xs:enumeration value="DirFileOrBarcode"/>
            <xs:enumeration value="State"/>
            <xs:enumeration value="Progress"/>
            <xs:enumeration value="TimeRemaining"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
ShareTriggeredBaseQueueItems()

Method Summary

Modifier and Type	Method and Description
com.quantum.dxi.dao.types.ShareTriggeredBaseQueueItems	getShareTriggeredBaseQueueItems(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString, java.lang.String errorType) GET /rest/ShareTriggeredBaseQueueItems

Methods inherited from class java.lang.Object

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

Constructor Detail

ShareTriggeredBaseQueueItems

public ShareTriggeredBaseQueueItems()

Method Detail

getShareTriggeredBaseQueueItems

public com.quantum.dxi.dao.types.ShareTriggeredBaseQueueItems getShareTriggeredBaseQueueItems(@Context
                                                                                              javax.servlet.http.HttpServletRequest request,
                                                                                              int start,
                                                                                              int limit,
                                                                                              java.lang.String sortColumn,
                                                                                              java.lang.String sortDirection,
                                                                                              java.lang.String filterString,
                                                                                              java.lang.String errorType)

GET /rest/ShareTriggeredBaseQueueItems

Get the triggered-based replication queue for NAS shares on the system.

NOTE: Currently only the following query is supported:

GET /rest/ShareTriggeredBaseQueueItems?filter=ObjectName(EQ)<objectName>(AND)TargetName(EQ)<targetHostName>

The response entity may contain magic numbers for the TimeRemaining element. Any TimeRemaining value that is less that 0 should be interpreted as follows:

• -2 : unknown, this happens when the system reports a state of "In Progress" and a time remaining less than 1
• -1 : waiting, this happens when the system reports a state of "Queued", regardless of the time remaining

<xs:element name="ShareTriggeredBaseQueueItems"> supports the table query parameters. Column names for sorting and filtering are defined in <xs:element name="TriggeredBaseQueueItemColumnNameType">

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