com.quantum.dxi.rest.cloudshare

Class CloudShareImages

java.lang.Object

Base

com.quantum.dxi.rest.cloudshare.CloudShareImages

public class CloudShareImages
extends Base

The CloudShareImages resource represents Cloud Share images. The CloudShareImages service includes interfaces for getting and managing images.

The schema that defines the CloudImages is defined below.

 
  <xs:element name="CloudImages">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="TotalCount" type="xs:int" minOccurs="0" />
        <xs:element ref="CloudImage" minOccurs="0" maxOccurs="unbounded" />
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="CloudImage">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="Image" type="xs:string"/>
        <xs:element name="State" type="xs:string"/>
        <xs:element name="CreatedAt" type="xs:long">
          <xs:annotation>
            <xs:documentation>Image creation date (seconds since epoch).</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="ArchivedAt" type="xs:long">
          <xs:annotation>
            <xs:documentation>Image archive date (seconds since epoch).</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Size" type="xs:long"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:simpleType name="CloudImageColumnNameType">
      <xs:restriction base="xs:string">
        <xs:enumeration value="Image"/>
        <xs:enumeration value="State"/>
        <xs:enumeration value="CreatedAt"/>
        <xs:enumeration value="ArchivedAt"/>
        <xs:enumeration value="Size"/>
      </xs:restriction>
  </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
CloudShareImages()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	archiveLsuImage(javax.servlet.http.HttpServletRequest request, java.lang.String storageServer, java.lang.String name) POST /rest/CloudShareImages/lsu/{storageServer}/{name}/archive
javax.ws.rs.core.Response	archiveShareImage(javax.servlet.http.HttpServletRequest request, java.lang.String name) POST /rest/CloudShareImages/share/{name}/archive
javax.ws.rs.core.Response	deleteNasImages(javax.servlet.http.HttpServletRequest request, java.lang.String name) DELETE /rest/CloudShareImages/share/{name}/delete
javax.ws.rs.core.Response	deleteOstImages(javax.servlet.http.HttpServletRequest request, java.lang.String storageServer, java.lang.String name) DELETE /rest/CloudShareImages/lsu/{storageServer}/{name}/delete
CloudImages	getLsuImages(javax.servlet.http.HttpServletRequest request, java.lang.String storageServer, java.lang.String name, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString) GET /rest/CloudShareImages/lsu/{storageServer}/{name}
CloudImages	getShareImages(javax.servlet.http.HttpServletRequest request, java.lang.String name, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString) GET /rest/CloudShareImages/share/{name}
javax.ws.rs.core.Response	releaseLsuImages(javax.servlet.http.HttpServletRequest request, StringListScalarType images, java.lang.String storageServer, java.lang.String name) POST /rest/CloudShareImages/lsu/{storageServer}/{name}/release
javax.ws.rs.core.Response	releaseShareImages(javax.servlet.http.HttpServletRequest request, StringListScalarType images, java.lang.String name) POST /rest/CloudShareImages/share/{name}/release
javax.ws.rs.core.Response	restoreLsuImage(javax.servlet.http.HttpServletRequest request, StringListScalarType images, java.lang.String name) POST /rest/CloudShareImages/share/{name}/restore
javax.ws.rs.core.Response	restoreLsuImage(javax.servlet.http.HttpServletRequest request, StringListScalarType images, java.lang.String storageServer, java.lang.String name) POST /rest/CloudShareImages/lsu/{storageServer}/{name}/restore

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudShareImages

public CloudShareImages()

Method Detail

getShareImages

public CloudImages getShareImages(@Context
                                  javax.servlet.http.HttpServletRequest request,
                                  java.lang.String name,
                                  int start,
                                  int limit,
                                  java.lang.String sortColumn,
                                  java.lang.String sortDirection,
                                  java.lang.String filterString)

GET /rest/CloudShareImages/share/{name}

Get Cloud Share images for the specified share.

The method supports the table query parameters. Column names for sorting and filtering are defined in <xs:simpleType name="CloudImageColumnNameType">

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

Since:

1.2.6 Please be sure it is supported by the installed software.

getLsuImages

public CloudImages getLsuImages(@Context
                                javax.servlet.http.HttpServletRequest request,
                                java.lang.String storageServer,
                                java.lang.String name,
                                int start,
                                int limit,
                                java.lang.String sortColumn,
                                java.lang.String sortDirection,
                                java.lang.String filterString)

GET /rest/CloudShareImages/lsu/{storageServer}/{name}

Get Cloud Share images for the specified LSU.

The method supports the table query parameters. Column names for sorting and filtering are defined in <xs:simpleType name="CloudImageColumnNameType">

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

Since:

1.2.6 Please be sure it is supported by the installed software.

archiveShareImage

public javax.ws.rs.core.Response archiveShareImage(@Context
                                                   javax.servlet.http.HttpServletRequest request,
                                                   java.lang.String name)

POST /rest/CloudShareImages/share/{name}/archive

Archive all local backup images for a specific share.

Use GET /rest/CloudShareJobs/ to monitor job status.

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

Since:

1.2.6 Please be sure it is supported by the installed software.

archiveLsuImage

public javax.ws.rs.core.Response archiveLsuImage(@Context
                                                 javax.servlet.http.HttpServletRequest request,
                                                 java.lang.String storageServer,
                                                 java.lang.String name)

POST /rest/CloudShareImages/lsu/{storageServer}/{name}/archive

Archive all local backup images for a specific lsu.

Use GET /rest/CloudShareJobs/ to monitor job status.

Since:

1.2.6 Please be sure it is supported by the installed software.

restoreLsuImage

public javax.ws.rs.core.Response restoreLsuImage(@Context
                                                 javax.servlet.http.HttpServletRequest request,
                                                 StringListScalarType images,
                                                 java.lang.String name)

POST /rest/CloudShareImages/share/{name}/restore

Restore a specific image from cloud archive to local storage.

Use GET /rest/CloudShareJobs/ to monitor job status.

The body contains pathnames of the images to be restored. Image pathnames can be obtained with GET.

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

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

Since:

1.2.6 Please be sure it is supported by the installed software.

restoreLsuImage

public javax.ws.rs.core.Response restoreLsuImage(@Context
                                                 javax.servlet.http.HttpServletRequest request,
                                                 StringListScalarType images,
                                                 java.lang.String storageServer,
                                                 java.lang.String name)

POST /rest/CloudShareImages/lsu/{storageServer}/{name}/restore

Restore a specific image from cloud archive to local storage.

Use GET /rest/CloudShareJobs/ to monitor job status.

The body contains a pathname of the image to be restored. Image pathnames can be obtained with GET.

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

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

Since:

1.2.6 Please be sure it is supported by the installed software.

releaseShareImages

public javax.ws.rs.core.Response releaseShareImages(@Context
                                                    javax.servlet.http.HttpServletRequest request,
                                                    StringListScalarType images,
                                                    java.lang.String name)

POST /rest/CloudShareImages/share/{name}/release

Release references of archived images to local data. This data will then be freed locally by Space Reclamation.

Use GET /rest/CloudShareJobs/ to monitor job status.

The body contains pathnames of the images to be released. Image pathnames can be obtained with GET.

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

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

Since:

1.2.6 Please be sure it is supported by the installed software.

releaseLsuImages

public javax.ws.rs.core.Response releaseLsuImages(@Context
                                                  javax.servlet.http.HttpServletRequest request,
                                                  StringListScalarType images,
                                                  java.lang.String storageServer,
                                                  java.lang.String name)

POST /rest/CloudShareImages/lsu/{storageServer}/{name}/release

Release references to local data of archived images. This data will then be freed locally by Space Reclamation.

Use GET /rest/CloudShareJobs/ to monitor job status.

The body contains pathnames of the images to be released. Image pathnames can be obtained with GET.

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

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

Since:

1.2.6 Please be sure it is supported by the installed software.

deleteNasImages

public javax.ws.rs.core.Response deleteNasImages(@Context
                                                 javax.servlet.http.HttpServletRequest request,
                                                 java.lang.String name)

DELETE /rest/CloudShareImages/share/{name}/delete

Delete images in the cloud which do not have corresponding images in the local share.

Use GET /rest/CloudShareJobs/ to monitor job status.

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

Since:

1.2.6 Please be sure it is supported by the installed software.

deleteOstImages

public javax.ws.rs.core.Response deleteOstImages(@Context
                                                 javax.servlet.http.HttpServletRequest request,
                                                 java.lang.String storageServer,
                                                 java.lang.String name)

DELETE /rest/CloudShareImages/lsu/{storageServer}/{name}/delete

Delete images in the cloud which do not have corresponding images in the local share.

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

Since:

1.2.6 Please be sure it is supported by the installed software.