com.quantum.dxi.rest.replication

Class RecoveryJobs

java.lang.Object

Base

com.quantum.dxi.rest.replication.RecoveryJobs

public class RecoveryJobs
extends Base

The RecoveryJobs resource represents recovery jobs on the system. The RecoveryJobs resource includes services for getting and deleting recovery jobs on the system.

The schema that defines the RecoveryJobs 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="RecoveryJobs">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0"/>
                <xs:element ref="RecoveryJob" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="RecoveryJob">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="OriginalName" type="xs:string"/>
                <xs:element name="NewName" type="xs:string"/>
                <xs:element name="SourceHostName" type="xs:string"/>
                <xs:element name="StartTimeString" type="xs:string">
                  <xs:annotation>
                      <xs:documentation>Local time.</xs:documentation>
                  </xs:annotation>
               </xs:element>
                <xs:element name="StartTime" type="xs:long" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>UTC value. A null StartTime indicates a failure to parse the StartTimeString due to unrecognized format. In this case sorting by StartTime column uses StartTimeString value.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="EndTimeString" type="xs:string">
                  <xs:annotation>
                      <xs:documentation>Local time.</xs:documentation>
                  </xs:annotation>
               </xs:element>
                <xs:element name="EndTime" type="xs:long" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>UTC value. A null EndTime indicates a failure to parse the EndTimeString due to unrecognized format. In this case sorting by EndTime column uses EndTimeString value.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Status" type="xs:string"/>
                <xs:element name="DetailedFailureMessage" type="xs:string"  minOccurs="0"/>
                <xs:element name="BundleId" type="xs:string"/>
                <xs:element name="RecoveryObjectType" type="SharitionType"/>
                <xs:element name="Id" type="xs:string">
                    <xs:annotation>
                        <xs:documentation>ReccoveryJob Id is a combination of SourceHostName@RecoveryObjectType@OriginalName@BundleId </xs:documentation>
                    </xs:annotation>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="RecoveryJobColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="OriginalName"/>
            <xs:enumeration value="NewName"/>
            <xs:enumeration value="SourceHostName"/>
            <xs:enumeration value="StartTime"/>
            <xs:enumeration value="EndTime"/>
            <xs:enumeration value="Status"/>
            <xs:enumeration value="DetailedFailureMessage"/>
            <xs:enumeration value="BundleId"/>
            <xs:enumeration value="RecoveryObjectType"/>
            <xs:enumeration value="Id"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
RecoveryJobs()

Method Summary

Modifier and Type	Method and Description
void	deleteAll(javax.servlet.http.HttpServletRequest request, java.lang.String objectType) DELETE /rest/RecoveryJobs
void	deleteRecoveryJob(javax.servlet.http.HttpServletRequest request, java.lang.String id) DELETE /rest/RecoveryJobs/{id}
RecoveryJob	getRecoveryJob(javax.servlet.http.HttpServletRequest request, java.lang.String id, java.lang.String errorType) GET /rest/RecoveryJobs/{id}
com.quantum.dxi.dao.types.RecoveryJobs	getRecoveryJobs(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString) GET /rest/RecoveryJobs
NumericScalarType	getRecoveryJobsCount(javax.servlet.http.HttpServletRequest request, java.lang.String filterString, java.lang.String errorType) GET /rest/RecoveryJobs/getRowCount

Methods inherited from class java.lang.Object

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

Constructor Detail

RecoveryJobs

public RecoveryJobs()

Method Detail

getRecoveryJobs

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

GET /rest/RecoveryJobs

Get the list of recovery jobs on the system.

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

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

getRecoveryJob

public RecoveryJob getRecoveryJob(@Context
                                  javax.servlet.http.HttpServletRequest request,
                                  java.lang.String id,
                                  java.lang.String errorType)

GET /rest/RecoveryJobs/{id}

Get the recovery job represented by id on the system. The id is a concatenation of the SourceHostName, RecoveryJobType, OriginalName, and BundleId, separated by '@', e.g. {SourceHostName}@{RecoveryJobType}@{OriginalName}@{BundleId}.

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

Since:

1.1

getRecoveryJobsCount

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

GET /rest/RecoveryJobs/getRowCount

Get the number of recovery jobs on the system.

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

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

Since:

1.1

deleteAll

public void deleteAll(@Context
                      javax.servlet.http.HttpServletRequest request,
                      java.lang.String objectType)

DELETE /rest/RecoveryJobs

Delete all completed recovery jobs on the system. In progress jobs are omitted and have to complete to be removed.

?objectType can be used to delete jobs of just the given type. Accepted values are: SHARE and PARTITION (case-agnostic). The parameter is available since 1.2.

deleteRecoveryJob

public void deleteRecoveryJob(@Context
                              javax.servlet.http.HttpServletRequest request,
                              java.lang.String id)

DELETE /rest/RecoveryJobs/{id}

Delete the recovery job represented by id on the system. The id is a concatenation of the SourceHostName, RecoveryJobType, OriginalName, and BundleId, separated by '@', e.g. {SourceHostName}@{RecoveryJobType}@{OriginalName}@{BundleId}.