com.quantum.dxi.rest.replication

Class FailbackJobs

java.lang.Object

Base

com.quantum.dxi.rest.replication.FailbackJobs

public class FailbackJobs
extends Base

The FailbackJobs resource represents failback jobs on the system. The FailbackJobs resource includes services for getting and deleting failback jobs on the system, and aborting running failback jobs.

The schema that defines the FailbackJobs 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="FailbackJob">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="ObjectName" type="xs:string"/>
                <xs:element name="SourceHostName" type="xs:string">
                    <xs:annotation>
                        <xs:documentation>Hostname of the system the Snapshot originally came from.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="TargetHostName" 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="FailbackObjectType" type="SharitionType"/>
                <xs:element name="Id" type="xs:string">
                    <xs:annotation>
                        <xs:documentation>FailbackJob Id is a combination of TargetHostName@FailbackObjectType@ObjectName@BundleId</xs:documentation>
                    </xs:annotation>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

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

    <xs:simpleType name="FailbackJobColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="ObjectName"/>
            <xs:enumeration value="TargetHostName"/>
            <xs:enumeration value="StartTime"/>
            <xs:enumeration value="EndTime"/>
            <xs:enumeration value="Status"/>
            <xs:enumeration value="DetailedFailureMessage"/>
            <xs:enumeration value="BundleId"/>
            <xs:enumeration value="FailbackObjectType"/>
            <xs:enumeration value="Id"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
FailbackJobs()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	abort(javax.servlet.http.HttpServletRequest request, java.lang.String id) POST /rest/FailbackJobs/{id}/abort
void	deleteAll(javax.servlet.http.HttpServletRequest request, java.lang.String objectType) DELETE /rest/FailbackJobs
void	deleteFailbackJob(javax.servlet.http.HttpServletRequest request, java.lang.String id) DELETE /rest/FailbackJobs/{id}
FailbackJob	getFailbackJob(javax.servlet.http.HttpServletRequest request, java.lang.String id, java.lang.String errorType) GET /rest/FailbackJobs/{id}
NumericScalarType	getFailbackJobsCount(javax.servlet.http.HttpServletRequest request, java.lang.String filterString, java.lang.String errorType) GET /rest/FailbackJobs/getRowCount
com.quantum.dxi.dao.types.FailbackJobs	getSources(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString) GET /rest/FailbackJobs
void	postAction(javax.servlet.http.HttpServletRequest request, java.lang.String id, java.lang.String actionString) Deprecated. As of 1.1, replaced by abort(HttpServletRequest, String)

Methods inherited from class java.lang.Object

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

Constructor Detail

FailbackJobs

public FailbackJobs()

Method Detail

getSources

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

GET /rest/FailbackJobs

Get the list of failback jobs on the system.

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

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

getFailbackJob

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

GET /rest/FailbackJobs/{id}

Get the failback job represented by id on the system. The id is a concatenation of the TargetHostName, FailbackObjectType, ObjectName, and BundleId, separated by '@', e.g. {TargetHostName}@{FailbackObjectType}@{ObjectName}@{BundleId}.

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

Since:

1.1

getFailbackJobsCount

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

GET /rest/FailbackJobs/getRowCount

Get the number of failback jobs on the system.

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

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

Since:

1.1

abort

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

POST /rest/FailbackJobs/{id}/abort

Abort the replication failback job identified by id. Only incomplete (queued or in progress) jobs can be aborted.

The id is a concatenation of the TargetHostName, FailbackObjectType, ObjectName, and BundleId, separated by '@', e.g. {TargetHostName}@{FailbackObjectType}@{ObjectName}@{BundleId}.

Since:

1.1

postAction

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

Deprecated. As of 1.1, replaced by abort(HttpServletRequest, String)

POST /rest/FailbackJobs/{id}

Perform the requested action on a replication failback job identified by {id} on the system. The id is a concatenation of the TargetHostName, FailbackObjectType, ObjectName, and BundleId, separated by '@', e.g. {TargetHostName}@{FailbackObjectType}@{ObjectName}@{BundleId}.

The action query parameter is required.

Supported actions are:

• ?action=abort abort the replication failback job

deleteAll

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

DELETE /rest/FailbackJobs

Delete all completed failback jobs on the system. Queued and in progress jobs are omitted. To be removed they either have to finish or be aborted.

?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.

Since:

1.1

deleteFailbackJob

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

DELETE /rest/FailbackJobs/{id}

Delete the replication failback job represented by id on the system. The id is a concatenation of the TargetHostName, FailbackObjectType, ObjectName, and BundleId, separated by '@', e.g. {TargetHostName}@{FailbackObjectType}@{ObjectName}@{BundleId}.