com.quantum.dxi.rest.vtl

Class Media

java.lang.Object

Base

com.quantum.dxi.rest.vtl.Media

public class Media
extends Base

The Medium resource represents a VTL medium on the system. The Media interface includes services for creating, getting, manipulating and deleting media.

The schema that defines the Medium and related resources is defined below.

 
    <xs:simpleType name="LocationType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="slot"/>
            <xs:enumeration value="ieslot"/>
            <xs:enumeration value="drive"/>
        </xs:restriction>
    </xs:simpleType>

    <xs:element name="NewMedia">
        <xs:complexType>
            <xs:all>
                <xs:element name="Partition" type="xs:string"/>
                <xs:element name="Type" type="xs:string"/>
                <xs:element name="Count">
                    <xs:simpleType>
                        <xs:restriction base="xs:int">
                            <xs:minExclusive value="0"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="StartingBarcode" type="xs:string"/>
                <xs:element name="Location">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="slot"/>
                            <xs:enumeration value="ieslot"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="CapacityGB" minOccurs="0">
                    <xs:simpleType>
                        <xs:restriction base="xs:int">
                            <xs:minInclusive value="5"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
            </xs:all>
        </xs:complexType>
    </xs:element>

    <xs:element name="MediaJobResult">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="Percent">
                    <xs:simpleType>
                        <xs:restriction base="xs:int">
                            <xs:minInclusive value="0"/>
                            <xs:maxInclusive value="100"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="SuccessCount">
                    <xs:simpleType>
                        <xs:restriction base="xs:int">
                            <xs:minInclusive value="0"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="SkippedCount">
                    <xs:simpleType>
                        <xs:restriction base="xs:int">
                            <xs:minInclusive value="0"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="SkippedBarcodes" type="xs:string"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="MediumMove">
        <xs:complexType>
            <xs:all>
                <xs:element name="Partition" type="xs:string"/>
                <xs:element name="SrcType" type="LocationType"/>
                <xs:element name="DestType" type="LocationType"/>
                <xs:element name="SrcIndex">
                    <xs:simpleType>
                        <xs:restriction base="xs:int">
                            <xs:minInclusive value="0"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="DestIndex">
                    <xs:simpleType>
                        <xs:restriction base="xs:int">
                            <xs:minInclusive value="0"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="ForceUnload" type="xs:boolean" minOccurs="0"/>
            </xs:all>
        </xs:complexType>
    </xs:element>

    <xs:element name="MediaUnload">
        <xs:complexType>
            <xs:all>
                <xs:element name="Partition" type="xs:string"/>
                <xs:element name="BarcodeFilter" type="xs:string" minOccurs="0"/>
                <xs:element name="Location" minOccurs="0">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="drive"/>
                            <xs:enumeration value="ieslot"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="Index" minOccurs="0">
                    <xs:simpleType>
                        <xs:restriction base="xs:int">
                            <xs:minInclusive value="0"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="ForceUnload" type="xs:boolean" minOccurs="0"/>
            </xs:all>
        </xs:complexType>
    </xs:element>

    <xs:element name="MediaSelector">
        <xs:complexType>
            <xs:all>
                <xs:element name="Partition" type="xs:string" minOccurs="0"/>
                <xs:element name="BarcodeFilter" type="xs:string" minOccurs="0"/>
                <xs:element name="StartNumber" minOccurs="0">
                    <xs:simpleType>
                        <xs:restriction base="xs:int">
                            <xs:minInclusive value="0"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="CountEntries" minOccurs="0">
                    <xs:simpleType>
                        <xs:restriction base="xs:int">
                            <xs:minExclusive value="0"/>
                            <xs:maxInclusive value="61000"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
            </xs:all>
        </xs:complexType>
    </xs:element>

    <xs:element name="Medium">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="Partition" type="xs:string"/>
                <xs:element name="Barcode" type="xs:string"/>
                <xs:element name="Type" type="xs:string"/>
                <xs:element name="Access" type="xs:string"/>
                <xs:element name="Pool" type="xs:string"/>
                <xs:element name="WriteProtected" type="xs:boolean"/>
                <xs:element name="Capacity" type="xs:long"/>
                <xs:element name="FreeSpace" type="xs:long"/>
                <xs:element name="UsedSpace" type="xs:long"/>
                <xs:element name="RawDataSize" type="xs:long"/>
                <xs:element name="UsedPercent">
                    <xs:simpleType>
                        <xs:restriction base="xs:double">
                            <xs:minInclusive value="0.00"/>
                            <xs:maxInclusive value="100.00"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="CompressRatio" type="xs:double"/>
                <xs:element name="ImportBehavior" type="xs:string"/>
                <xs:element name="ExportBehavior" type="xs:string"/>
                <xs:element name="PureVirtual" type="xs:boolean"/>
                <xs:element name="PrevLocation" type="xs:string" minOccurs="0"/>
                <xs:element name="PrevIndex" type="xs:int" minOccurs="0"/>
                <xs:element name="CurLocation" type="xs:string" minOccurs="0"/>
                <xs:element name="CurIndex" type="xs:int" minOccurs="0"/>
                <xs:element name="CurAddress" type="xs:int" minOccurs="0"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

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

    <xs:simpleType name="MediumColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Partition"/>
            <xs:enumeration value="Barcode"/>
            <xs:enumeration value="Type"/>
            <xs:enumeration value="Access"/>
            <xs:enumeration value="Pool"/>
            <xs:enumeration value="WriteProtected"/>
            <xs:enumeration value="Capacity"/>
            <xs:enumeration value="FreeSpace"/>
            <xs:enumeration value="UsedSpace"/>
            <xs:enumeration value="RawDataSize"/>
            <xs:enumeration value="UsedPercent"/>
            <xs:enumeration value="CompressRatio"/>
            <xs:enumeration value="ImportBehavior"/>
            <xs:enumeration value="ExportBehavior"/>
            <xs:enumeration value="PureVirtual"/>
            <xs:enumeration value="PrevLocation"/>
            <xs:enumeration value="PrevIndex"/>
            <xs:enumeration value="CurLocation"/>
            <xs:enumeration value="CurIndex"/>
            <xs:enumeration value="CurAddress"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
Media()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addMedia(javax.servlet.http.HttpServletRequest request, NewMedia newMedia, String errorType) POST /rest/Media
javax.ws.rs.core.Response	deleteMedia(javax.servlet.http.HttpServletRequest request, String barcodeFilter, String errorType) DELETE /rest/Media/{barcodeFilter}
javax.ws.rs.core.Response	exportMedia(javax.servlet.http.HttpServletRequest request, String partition, String barcodeFilter, String errorType) POST /rest/Media/export/{partition}/{barcodeFilter}
com.quantum.dxi.dao.types.Media	getMedia(javax.servlet.http.HttpServletRequest request, String barcodeFilter, int start, int limit, String sortColumn, String sortDirection, String errorType) GET /rest/Media/{barcodeFilter}
com.quantum.dxi.dao.types.Media	getMedia(javax.servlet.http.HttpServletRequest request, String partition, String barcodeFilter, int start, int limit, String sortColumn, String sortDirection, String errorType) GET /rest/Media/{partition}/{barcodeFilter}
NumericScalarType	getMediaCount(javax.servlet.http.HttpServletRequest request, String barcodeFilter, String errorType) GET /rest/Media/getRowCount/{barcodeFilter}
NumericScalarType	getMediaCount(javax.servlet.http.HttpServletRequest request, String partition, String barcodeFilter, String errorType) GET /rest/Media/getRowCount/{partition}/{barcodeFilter}
javax.ws.rs.core.Response	importMedia(javax.servlet.http.HttpServletRequest request, String partition, String barcodeFilter, String errorType) POST /rest/Media/import/{partition}/{barcodeFilter}
MediumMove	moveMedium(javax.servlet.http.HttpServletRequest request, MediumMove mediumMove, String errorType) PUT /rest/Media/move
javax.ws.rs.core.Response	recycleMedia(javax.servlet.http.HttpServletRequest request, String partition, String barcodeFilter, String errorType) POST /rest/Media/recycle/{partition}/{barcodeFilter}
javax.ws.rs.core.Response	unloadMedia(javax.servlet.http.HttpServletRequest request, MediaUnload mediaUnload, String errorType) POST /rest/Media/unload
javax.ws.rs.core.Response	writeProtectMedia(javax.servlet.http.HttpServletRequest request, String partition, String barcodeFilter, boolean disable, String errorType) POST /rest/Media/writeProtect/{partition}/{barcodeFilter}

Methods inherited from class java.lang.Object

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

Constructor Detail

Media

public Media()

Method Detail

addMedia

public javax.ws.rs.core.Response addMedia(@Context
                                          javax.servlet.http.HttpServletRequest request,
                                          NewMedia newMedia,
                                          String errorType)

POST /rest/Media

Start a background job to create new media on the device.

Request Entity type: <xs:element name="NewMedia">

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

Since:

1.1

getMediaCount

public NumericScalarType getMediaCount(@Context
                                       javax.servlet.http.HttpServletRequest request,
                                       String barcodeFilter,
                                       String errorType)

GET /rest/Media/getRowCount/{barcodeFilter}

Get the number of media on the device, matching {barcodeFilter} (example: AC0145,A*45,AC*,*145,AB5150-AC0145). {barcodeFilter} is REQUIRED. Specify * to get total media count.

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

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

Since:

1.1

getMediaCount

public NumericScalarType getMediaCount(@Context
                                       javax.servlet.http.HttpServletRequest request,
                                       String partition,
                                       String barcodeFilter,
                                       String errorType)

GET /rest/Media/getRowCount/{partition}/{barcodeFilter}

Get the number of media on the device in {partition}, matching {barcodeFilter} (example: AC0145,A*45,AC*,*145,AB5150-AC0145). {barcodeFilter} is REQUIRED. Specify * to get total media count in {partition}.

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

Since:

1.1

getMedia

public com.quantum.dxi.dao.types.Media getMedia(@Context
                                                javax.servlet.http.HttpServletRequest request,
                                                String barcodeFilter,
                                                int start,
                                                int limit,
                                                String sortColumn,
                                                String sortDirection,
                                                String errorType)

GET /rest/Media/{barcodeFilter}

Get Media, matching {barcodeFilter} (example: AC0145,A*45,AC*,*145,AB5150-AC0145). {barcodeFilter} is REQUIRED. Specify * to request all media. The API will return an error if the selection matches more than 61000 media. Please use {barcodeFilter}, {start} and {limit} parameters to refine the search and/or split results into pages. IMPORTANT: {start} and {limit} options are applied to media list in default sort order (asc barcode). Any sorting, specified by {sort} and {dir}, will be within this range only.

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

getMedia supports the table query parameters for paging and sorting. Column names for sorting are defined in <xs:element name="MediumColumnName">

Since:

1.1

getMedia

public com.quantum.dxi.dao.types.Media getMedia(@Context
                                                javax.servlet.http.HttpServletRequest request,
                                                String partition,
                                                String barcodeFilter,
                                                int start,
                                                int limit,
                                                String sortColumn,
                                                String sortDirection,
                                                String errorType)

GET /rest/Media/{partition}/{barcodeFilter}

Get Media in {partition}, matching {barcodeFilter} (example: AC0145,A*45,AC*,*145,AB5150-AC0145). {barcodeFilter} is REQUIRED. Specify * to request all media in {partition}. The API will return an error if the selection matches more than 61000 media. Please use {barcodeFilter}, {start} and {limit} parameters to refine the search and/or split results into pages. IMPORTANT: {start} and {limit} options are applied to media list in default sort order (asc barcode). Any sorting, specified by {sort} and {dir}, will be within this range only.

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

getMedia supports the table query parameters for paging and sorting. Column names for sorting are defined in <xs:element name="MediumColumnName">

Since:

1.1

exportMedia

public javax.ws.rs.core.Response exportMedia(@Context
                                             javax.servlet.http.HttpServletRequest request,
                                             String partition,
                                             String barcodeFilter,
                                             String errorType)

POST /rest/Media/export/{partition}/{barcodeFilter}

Start a background job to export media, matching {barcodeFilter}, from the specified {partition}. {barcodeFilter} is REQUIRED. Specify * to process all media in {partition}.

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

Since:

1.1

importMedia

public javax.ws.rs.core.Response importMedia(@Context
                                             javax.servlet.http.HttpServletRequest request,
                                             String partition,
                                             String barcodeFilter,
                                             String errorType)

POST /rest/Media/import/{partition}/{barcodeFilter}

Start a background job to import media, matching {barcodeFilter}, from *UNASSIGNED to the specified {partition}. {barcodeFilter} is REQUIRED. Specify * to process all media in the *UNASSIGNED partition.

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

Since:

1.1

recycleMedia

public javax.ws.rs.core.Response recycleMedia(@Context
                                              javax.servlet.http.HttpServletRequest request,
                                              String partition,
                                              String barcodeFilter,
                                              String errorType)

POST /rest/Media/recycle/{partition}/{barcodeFilter}

Start a background job to recycle media, matching {barcodeFilter}, in the specified {partition}. {barcodeFilter} is REQUIRED. Specify * to process all media in {partition}.

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

Since:

1.1

writeProtectMedia

public javax.ws.rs.core.Response writeProtectMedia(@Context
                                                   javax.servlet.http.HttpServletRequest request,
                                                   String partition,
                                                   String barcodeFilter,
                                                   boolean disable,
                                                   String errorType)

POST /rest/Media/writeProtect/{partition}/{barcodeFilter}

Start a background job to write protect media in the specified {partition}, matching {barcodeFilter}.
Note: {barcodeFilter} is REQUIRED. Specify * to process all media in {partition}.
To clear the write-protect attribute of the media, add ?disable=true to the request URL.

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

Since:

1.1

moveMedium

public MediumMove moveMedium(@Context
                             javax.servlet.http.HttpServletRequest request,
                             MediumMove mediumMove,
                             String errorType)

PUT /rest/Media/move

Move medium within partition.

Request Entity type: <xs:element name="MediumMove">

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

Since:

1.1

unloadMedia

public javax.ws.rs.core.Response unloadMedia(@Context
                                             javax.servlet.http.HttpServletRequest request,
                                             MediaUnload mediaUnload,
                                             String errorType)

POST /rest/Media/unload

Start a background job to unload media from drives or import/export slots.

Request Entity type: <xs:element name="MediaUnload">

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

Since:

1.1

deleteMedia

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

DELETE /rest/Media/{barcodeFilter}

Start a background job to delete media from *UNASSIGNED partition, matching {barcodeFilter}. {barcodeFilter} is REQUIRED. Specify * to delete all media from the *UNASSIGNED partition.

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

Since:

1.1