com.quantum.dxi.rest.securesnapshots

Class SecureSnapshots

java.lang.Object

Base

com.quantum.dxi.rest.securesnapshots.SecureSnapshots

public class SecureSnapshots
extends Base

The SecureSnapshots resource represents secure snapshots on the system. The SecureSnapshots service includes interfaces for getting, adding, updating, and recovering secure snapshots.

The schema that defines the SecureSnapshots resource is defined below.

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

    <xs:element name="SecureSnapshot">
      <xs:complexType>
        <xs:sequence>
          <xs:element name="Id" type="xs:unsignedInt" minOccurs="0"/>
          <xs:element name="ObjectType" type="xs:string" minOccurs="0">
            <xs:annotation>
                  <xs:documentation>share, partition or lsu</xs:documentation>
              </xs:annotation>
          </xs:element>
          <xs:element name="StorageServer" type="xs:string" minOccurs="0">
            <xs:annotation>
                  <xs:documentation>Only applicable if "ObjectType" is "lsu".</xs:documentation>
              </xs:annotation>
          </xs:element>
          <xs:element name="ObjectName" type="xs:string" minOccurs="0">
            <xs:annotation>
                  <xs:documentation>Object the snapshot was created from.</xs:documentation>
              </xs:annotation>
          </xs:element>
          <xs:element name="SnapshotRetention" type="xs:int" minOccurs="0">
            <xs:annotation>
                  <xs:documentation>Snapshot retention period in days.</xs:documentation>
              </xs:annotation>
          </xs:element>
          <xs:element name="ExpiresAt" type="xs:long" minOccurs="0">
            <xs:annotation>
                  <xs:documentation>Snapshot retention expiration date (seconds since epoch, read-only).</xs:documentation>
              </xs:annotation>
          </xs:element>
          <xs:element name="CreatedAt" type="xs:long" minOccurs="0">
            <xs:annotation>
                  <xs:documentation>Snapshot creation date (seconds since epoch).</xs:documentation>
              </xs:annotation>
          </xs:element>
          <xs:element name="Trigger" type="xs:string" minOccurs="0">
            <xs:annotation>
                  <xs:documentation>Indicates whether the snapshot was created manually or via scheduler.</xs:documentation>
              </xs:annotation>
          </xs:element>
        </xs:sequence>
      </xs:complexType>
    </xs:element>

    <xs:simpleType name="SecureSnapshotColumnNameType">
        <xs:restriction base="xs:string">
          <xs:enumeration value="Id"/>
          <xs:enumeration value="ObjectType"/>
          <xs:enumeration value="StorageServer"/>
          <xs:enumeration value="ObjectName"/>
          <xs:enumeration value="SnapshotRetention"/>
          <xs:enumeration value="ExpiresAt"/>
          <xs:enumeration value="CreatedAt"/>
          <xs:enumeration value="Trigger"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
SecureSnapshots()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addSnapshots(javax.servlet.http.HttpServletRequest request, SecureSnapshot matchingProps) POST /rest/SecureSnapshots
com.quantum.dxi.dao.types.SecureSnapshots	getLsuSnapshots(javax.servlet.http.HttpServletRequest request, java.lang.String storageServer, java.lang.String name, java.lang.Long startTime, java.lang.Long endTime, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString) GET /rest/SecureSnapshots/lsu/{storageServer}/{name}
com.quantum.dxi.dao.types.SecureSnapshots	getLsusSnapshots(javax.servlet.http.HttpServletRequest request, java.lang.Long startTime, java.lang.Long endTime, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString) GET /rest/SecureSnapshots/lsu
com.quantum.dxi.dao.types.SecureSnapshots	getPartitionSnapshots(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.Long startTime, java.lang.Long endTime, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString) GET /rest/SecureSnapshots/partition/{name}
com.quantum.dxi.dao.types.SecureSnapshots	getPartitionsSnapshots(javax.servlet.http.HttpServletRequest request, java.lang.Long startTime, java.lang.Long endTime, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString) GET /rest/SecureSnapshots/partition
com.quantum.dxi.dao.types.SecureSnapshots	getShareSnapshots(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.Long startTime, java.lang.Long endTime, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString) GET /rest/SecureSnapshots/share/{name}
com.quantum.dxi.dao.types.SecureSnapshots	getSharesSnapshots(javax.servlet.http.HttpServletRequest request, java.lang.Long startTime, java.lang.Long endTime, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString) GET /rest/SecureSnapshots/share
SecureSnapshot	getSnapshot(javax.servlet.http.HttpServletRequest request, java.lang.Long id) GET /rest/SecureSnapshots/{id}
com.quantum.dxi.dao.types.SecureSnapshots	getSnapshots(javax.servlet.http.HttpServletRequest request, java.lang.Long startTime, java.lang.Long endTime, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString) GET /rest/SecureSnapshots
javax.ws.rs.core.Response	recoverSnapshot(javax.servlet.http.HttpServletRequest request, java.lang.Long id, java.lang.String recObjectName) POST /rest/SecureSnapshots/{id}/recover
javax.ws.rs.core.Response	updateSnapshot(javax.servlet.http.HttpServletRequest request, java.lang.Long id, SecureSnapshot props) PUT /rest/SecureSnapshots/{id}
javax.ws.rs.core.Response	updateSnapshots(javax.servlet.http.HttpServletRequest request, SecureSnapshot props) PUT /rest/SecureSnapshots

Methods inherited from class java.lang.Object

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

Constructor Detail

SecureSnapshots

public SecureSnapshots()

Method Detail

getSnapshots

public com.quantum.dxi.dao.types.SecureSnapshots getSnapshots(@Context
                                                              javax.servlet.http.HttpServletRequest request,
                                                              java.lang.Long startTime,
                                                              java.lang.Long endTime,
                                                              int start,
                                                              int limit,
                                                              java.lang.String sortColumn,
                                                              java.lang.String sortDirection,
                                                              java.lang.String filterString)

GET /rest/SecureSnapshots

Get the list of secure snapshots on the system.

To get snapshots created within a certain time range, please use startTime and endTime query parameters (seconds since epoch).

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

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

Since:

1.2.1

getSharesSnapshots

public com.quantum.dxi.dao.types.SecureSnapshots getSharesSnapshots(@Context
                                                                    javax.servlet.http.HttpServletRequest request,
                                                                    java.lang.Long startTime,
                                                                    java.lang.Long endTime,
                                                                    int start,
                                                                    int limit,
                                                                    java.lang.String sortColumn,
                                                                    java.lang.String sortDirection,
                                                                    java.lang.String filterString)

GET /rest/SecureSnapshots/share

Get the list of secure snapshots, where object type is share.

To get snapshots created within a certain time range, please use startTime and endTime query parameters (seconds since epoch).

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

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

Since:

1.2.1

getShareSnapshots

public com.quantum.dxi.dao.types.SecureSnapshots getShareSnapshots(@Context
                                                                   javax.servlet.http.HttpServletRequest request,
                                                                   java.lang.String name,
                                                                   java.lang.Long startTime,
                                                                   java.lang.Long endTime,
                                                                   int start,
                                                                   int limit,
                                                                   java.lang.String sortColumn,
                                                                   java.lang.String sortDirection,
                                                                   java.lang.String filterString)

GET /rest/SecureSnapshots/share/{name}

Get the list of secure snapshots for a specific share.

To get snapshots created within a certain time range, please use startTime and endTime query parameters (seconds since epoch).

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

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

Since:

1.2.1

getPartitionsSnapshots

public com.quantum.dxi.dao.types.SecureSnapshots getPartitionsSnapshots(@Context
                                                                        javax.servlet.http.HttpServletRequest request,
                                                                        java.lang.Long startTime,
                                                                        java.lang.Long endTime,
                                                                        int start,
                                                                        int limit,
                                                                        java.lang.String sortColumn,
                                                                        java.lang.String sortDirection,
                                                                        java.lang.String filterString)

GET /rest/SecureSnapshots/partition

Get the list of secure snapshots, where object type is partition.

To get snapshots created within a certain time range, please use startTime and endTime query parameters (seconds since epoch).

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

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

Since:

1.2.1

getPartitionSnapshots

public com.quantum.dxi.dao.types.SecureSnapshots getPartitionSnapshots(@Context
                                                                       javax.servlet.http.HttpServletRequest request,
                                                                       java.lang.String name,
                                                                       java.lang.Long startTime,
                                                                       java.lang.Long endTime,
                                                                       int start,
                                                                       int limit,
                                                                       java.lang.String sortColumn,
                                                                       java.lang.String sortDirection,
                                                                       java.lang.String filterString)

GET /rest/SecureSnapshots/partition/{name}

Get the list of secure snapshots for a specific partition.

To get snapshots created within a certain time range, please use startTime and endTime query parameters (seconds since epoch).

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

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

Since:

1.2.1

getLsusSnapshots

public com.quantum.dxi.dao.types.SecureSnapshots getLsusSnapshots(@Context
                                                                  javax.servlet.http.HttpServletRequest request,
                                                                  java.lang.Long startTime,
                                                                  java.lang.Long endTime,
                                                                  int start,
                                                                  int limit,
                                                                  java.lang.String sortColumn,
                                                                  java.lang.String sortDirection,
                                                                  java.lang.String filterString)

GET /rest/SecureSnapshots/lsu

Get the list of secure snapshots, where object type is lsu.

To get snapshots created within a certain time range, please use startTime and endTime query parameters (seconds since epoch).

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

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

Since:

1.2.1

getLsuSnapshots

public com.quantum.dxi.dao.types.SecureSnapshots getLsuSnapshots(@Context
                                                                 javax.servlet.http.HttpServletRequest request,
                                                                 java.lang.String storageServer,
                                                                 java.lang.String name,
                                                                 java.lang.Long startTime,
                                                                 java.lang.Long endTime,
                                                                 int start,
                                                                 int limit,
                                                                 java.lang.String sortColumn,
                                                                 java.lang.String sortDirection,
                                                                 java.lang.String filterString)

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

Get the list of secure snapshots for a specific lsu.

To get snapshots created within a certain time range, please use startTime and endTime query parameters (seconds since epoch).

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

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

Since:

1.2.1

getSnapshot

public SecureSnapshot getSnapshot(@Context
                                  javax.servlet.http.HttpServletRequest request,
                                  java.lang.Long id)

GET /rest/SecureSnapshots/{id}

Get a specific secure snapshot.

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

Since:

1.2.1

addSnapshots

public javax.ws.rs.core.Response addSnapshots(@Context
                                              javax.servlet.http.HttpServletRequest request,
                                              SecureSnapshot matchingProps)

POST /rest/SecureSnapshots

Create snapshot(s) for all or selected objects (shares, partitions or LSUs) that have Secure Snapshots enabled.

Request Entity type: <xs:element name="SecureSnapshot">
The object defines properties used to search for objects that need snapshots created for them.
Relevant fields are: ObjectType, StorageServer (only applicable if ObjectType is "lsu") and ObjectName.

Since:

1.2.1

updateSnapshots

public javax.ws.rs.core.Response updateSnapshots(@Context
                                                 javax.servlet.http.HttpServletRequest request,
                                                 SecureSnapshot props)

PUT /rest/SecureSnapshots

Extend retention period of all matching secure snapshot(s).

Request Entity type: <xs:element name="SecureSnapshot">
The object defines properties of matching snapshots as well as the new retention period.
Search fields are: ObjectType, StorageServer (only applicable if ObjectType is "lsu") and ObjectName.
SnapshotRetention - new retention period in days; may only be larger than the current value.

Since:

1.2.1

updateSnapshot

public javax.ws.rs.core.Response updateSnapshot(@Context
                                                javax.servlet.http.HttpServletRequest request,
                                                java.lang.Long id,
                                                SecureSnapshot props)

PUT /rest/SecureSnapshots/{id}

Extend retention period of the given secure snapshot.

The only relevant fields are Id - must match {id}, and SnapshotRetention - new retention period in days; may only be larger than the current value.

Since:

1.2.1

recoverSnapshot

public javax.ws.rs.core.Response recoverSnapshot(@Context
                                                 javax.servlet.http.HttpServletRequest request,
                                                 java.lang.Long id,
                                                 java.lang.String recObjectName)

POST /rest/SecureSnapshots/{id}/recover

Recover the original object (share, partition or LSU) from the specified secure snapshot.

recObjectName Name of the object to recover to.
For snapshots of shares and partitions, a new object with the given name is created; defaults to snapshot's ObjectName.
For snapshots of LSUs, it is possible to specify a new or existing storage server in which to create the LSU; defaults to snapshot's StorageServer.

Since:

1.2.1