com.quantum.dxi.rest.replication

Class UnpackQueueItems

java.lang.Object

Base

com.quantum.dxi.rest.replication.UnpackQueueItems

public class UnpackQueueItems
extends Base

The UnpackQueueItems resource represents the replication state of NAS directory/file-based or VTL cartridge-based replications for which this system is a replication target. The UnpackQueueItems resource includes services for getting the state of these replications.

The schema that defines the UnpackQueueItems resource is defined below.

 
    <xs:simpleType name="SharitionType">
        <xs:annotation>
            <xs:documentation>Share or Partition</xs:documentation>
        </xs:annotation>
        <xs:restriction base="xs:string">
            <xs:enumeration value="SHARE"/>
            <xs:enumeration value="PARTITION"/>
        </xs:restriction>
    </xs:simpleType>

    <xs:element name="UnpackQueueItems">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0"/>
                <xs:element ref="UnpackQueueItem" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="UnpackQueueItem">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="BarcodeOrPath" type="xs:string"/>
                <xs:element name="UnpackState">
                    <xs:annotation>
                        <xs:documentation>Possible values: Invalid, Queued, InProgress, Failure, Success</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="SyncId" type="xs:string"/>
                <xs:element name="UnpackQueueItemObjectType" type="SharitionType"/>
                <xs:element name="ObjectName" type="xs:string"/>
                <xs:element name="AudId" type="xs:string"/>
             </xs:sequence>
         </xs:complexType>
    </xs:element>

    <xs:simpleType name="UnpackQueueItemColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="BarcodeOrPath"/>
            <xs:enumeration value="UnpackState"/>
            <xs:enumeration value="SyncId"/>
            <xs:enumeration value="UnpackQueueItemObjectType"/>
            <xs:enumeration value="ObjectName"/>
            <xs:enumeration value="AudId"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
UnpackQueueItems()

Method Summary

Modifier and Type	Method and Description
com.quantum.dxi.dao.types.UnpackQueueItems	getReplicationUnpackQueueItems(javax.servlet.http.HttpServletRequest request, int start, int limit, String sortColumn, String sortDirection, String filterString) GET /rest/UnpackQueueItems
UnpackQueueItem	getUnpackQueueItem(javax.servlet.http.HttpServletRequest request, String syncId, String errorType) Deprecated. as of 1.2. The API returns a single unpack queue item whereas multiple ones may exist for the given syncId.
com.quantum.dxi.dao.types.UnpackQueueItems	getUnpackQueueItems(javax.servlet.http.HttpServletRequest request, String objectType, String objectName, String errorType) GET /rest/UnpackQueueItems/{objectType}/{objectName}
NumericScalarType	getUnpackQueueItemsCount(javax.servlet.http.HttpServletRequest request, String filterString, String errorType) GET /rest/UnpackQueueItems/getRowCount

Methods inherited from class java.lang.Object

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

Constructor Detail

UnpackQueueItems

public UnpackQueueItems()

Method Detail

getReplicationUnpackQueueItems

public com.quantum.dxi.dao.types.UnpackQueueItems getReplicationUnpackQueueItems(@Context
                                                                                 javax.servlet.http.HttpServletRequest request,
                                                                                 int start,
                                                                                 int limit,
                                                                                 String sortColumn,
                                                                                 String sortDirection,
                                                                                 String filterString)

GET /rest/UnpackQueueItems

Get the replication state for directory/file and cartridge based replications received by this system.

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

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

getUnpackQueueItems

public com.quantum.dxi.dao.types.UnpackQueueItems getUnpackQueueItems(@Context
                                                                      javax.servlet.http.HttpServletRequest request,
                                                                      String objectType,
                                                                      String objectName,
                                                                      String errorType)

GET /rest/UnpackQueueItems/{objectType}/{objectName}

Get the replication state for directory/file and cartridge based replications for the given share or partition, identified by a combination of objectType and objectName.
objectType accepted values: SHARE, PARTITION.

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

Since:

1.2

getUnpackQueueItem

public UnpackQueueItem getUnpackQueueItem(@Context
                                          javax.servlet.http.HttpServletRequest request,
                                          String syncId,
                                          String errorType)

Deprecated. as of 1.2. The API returns a single unpack queue item whereas multiple ones may exist for the given syncId.

GET /rest/UnpackQueueItems/{syncId}

Get the first item from unpack queue for the given syncId.

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

Since:

1.1

See Also:

getUnpackQueueItems(HttpServletRequest, String, String, String)

getUnpackQueueItemsCount

public NumericScalarType getUnpackQueueItemsCount(@Context
                                                  javax.servlet.http.HttpServletRequest request,
                                                  String filterString,
                                                  String errorType)

GET /rest/UnpackQueueItems/getRowCount

Get the number of UnpackQueueItems on the system.

getRowCount supports the table query parameters for filtering by column name. Column names are defined in <xs:simpleType name="UnpackQueueItemColumnNameType">

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

Since:

1.1