com.quantum.dxi.rest.replication

Class ReplicationJob

java.lang.Object

Base

com.quantum.dxi.rest.replication.ReplicationJob

public class ReplicationJob
extends Base

The ReplicationJobs resource represents replication jobs on the system, including information about the type of job and the status of the job. The ReplicationJobs resource includes services for getting the list of replication jobs, and performing actions on replication jobs.

The schema that defines the ReplicationJobs resource is defined below.

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

    <xs:element name="ReplicationJob">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="JobType" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Replication, Synchronization</xs:documentation>
                    </xs:annotation>
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="REPLICATION"/>
                            <xs:enumeration value="SYNCHRONIZATION"/>
                            <xs:enumeration value="TRIGGER"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="ReplicationObjectType">
                    <xs:annotation>
                        <xs:documentation>Share, Partition, DirFile, Medium</xs:documentation>
                    </xs:annotation>
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="SHARE"/>
                            <xs:enumeration value="PARTITION"/>
                            <xs:enumeration value="DIR_FILE"/>
                            <xs:enumeration value="CARTRIDGE"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="ObjectName" type="xs:string"/>
                <xs:element name="TargetHostName" type="xs:string" minOccurs="0"/>
                <xs:element name="BarCodeOrPath" type="xs:string" minOccurs="0"/>
                <xs:element name="StatusOrMostSevereStatus" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Queued, InProgress, Success, Failure, Partial, Replicating, Recovering</xs:documentation>
                    </xs:annotation>
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="QUEUED"/>
                            <xs:enumeration value="IN_PROGRESS"/>
                            <xs:enumeration value="SUCCESS"/>
                            <xs:enumeration value="FAILURE"/>
                            <xs:enumeration value="PARTIAL"/>
                            <xs:enumeration value="REPLICATING"/>
                            <xs:enumeration value="RECOVERING"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="StatusText" type="xs:string" minOccurs="0"/>
                <xs:element name="StartTimeOrLastStartTime" type="xs:string" minOccurs="0"/>
                <xs:element name="EndTimeOrLastEndTime" type="xs:string" minOccurs="0"/>
                <xs:element name="OriginalDataSize" type="xs:long" minOccurs="0"/>
                <xs:element name="ActualDataSent" type="xs:long" minOccurs="0"/>
                <xs:element name="DataRate" type="xs:long" minOccurs="0"/>
                <xs:element name="EstimatedCompletionTime" type="xs:string" minOccurs="0"/>
                <xs:element name="Identifier" type="xs:string"/>
                <xs:element name="PercentComplete" type="xs:int" minOccurs="0"/>
                <xs:element name="DetailedFailureMessage" type="xs:string" minOccurs="0"/>
                <xs:element name="DeduplicationEnabled" type="xs:boolean"/>
                <xs:element name="ReplicationEnabled" type="xs:boolean"/>
                <xs:element name="SyncId" type="xs:string" minOccurs="0"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="ReplicationJobColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="JobType"/>
            <xs:enumeration value="ReplicationObjectType"/>
            <xs:enumeration value="ObjectName"/>
            <xs:enumeration value="TargetHostName"/>
            <xs:enumeration value="BarCodeOrPath"/>
            <xs:enumeration value="StatusOrMostSevereStatus"/>
            <xs:enumeration value="StatusText"/>
            <xs:enumeration value="StartTimeOrLastStartTime"/>
            <xs:enumeration value="EndTimeOrLastEndTime"/>
            <xs:enumeration value="OriginalDataSize"/>
            <xs:enumeration value="ActualDataSent"/>
            <xs:enumeration value="DataRate"/>
            <xs:enumeration value="EstimatedCompletionTime"/>
            <xs:enumeration value="Identifier"/>
            <xs:enumeration value="PercentComplete"/>
            <xs:enumeration value="DetailedFailureMessage"/>
            <xs:enumeration value="DeduplicationEnabled"/>
            <xs:enumeration value="ReplicationEnabled"/>
            <xs:enumeration value="SyncId"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
ReplicationJob()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	abort(javax.servlet.http.HttpServletRequest request, java.lang.String identifier, java.lang.String errorType) POST /rest/ReplicationJobs/{identifier}/abort
com.quantum.dxi.dao.types.ReplicationJob	getReplicationJob(javax.servlet.http.HttpServletRequest request, java.lang.String identifier, java.lang.String errorType) GET /rest/ReplicationJobs/{identifier}
ReplicationJobs	getReplicationJobs(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString, java.lang.String errorType) GET /rest/ReplicationJobs
ReplicationJobs	getReplicationTypeJobs(javax.servlet.http.HttpServletRequest request, java.lang.String errorType) GET /rest/ReplicationJobs/Replications
ReplicationJobs	getSynchronizationTypeJobs(javax.servlet.http.HttpServletRequest request, java.lang.String errorType) GET /rest/ReplicationJobs/Synchronizations
StringScalarType	postAction(javax.servlet.http.HttpServletRequest request, java.lang.String identifier, java.lang.String actionString, java.lang.String errorType) Deprecated. As of 1.1, replaced by abort(HttpServletRequest, String, String)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplicationJob

public ReplicationJob()

Method Detail

getReplicationJobs

public ReplicationJobs getReplicationJobs(@Context
                                          javax.servlet.http.HttpServletRequest request,
                                          int start,
                                          int limit,
                                          java.lang.String sortColumn,
                                          java.lang.String sortDirection,
                                          java.lang.String filterString,
                                          java.lang.String errorType)

GET /rest/ReplicationJobs

Get the list of replication jobs on the system.

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

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

getReplicationTypeJobs

public ReplicationJobs getReplicationTypeJobs(@Context
                                              javax.servlet.http.HttpServletRequest request,
                                              java.lang.String errorType)

GET /rest/ReplicationJobs/Replications

Get all replication jobs where the <xs:element name="JobType" type="xs:string"> is REPLICATION. Note! Completed synchronization jobs are also returned as replication jobs, because replication is part of the synchronization process.

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

getSynchronizationTypeJobs

public ReplicationJobs getSynchronizationTypeJobs(@Context
                                                  javax.servlet.http.HttpServletRequest request,
                                                  java.lang.String errorType)

GET /rest/ReplicationJobs/Synchronizations

Get all replication jobs where the <xs:element name="JobType" type="xs:string"> is SYNCHRONIZATION.

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

getReplicationJob

public com.quantum.dxi.dao.types.ReplicationJob getReplicationJob(@Context
                                                                  javax.servlet.http.HttpServletRequest request,
                                                                  java.lang.String identifier,
                                                                  java.lang.String errorType)

GET /rest/ReplicationJobs/{identifier}

Get the replication job identified by {identifier}

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

abort

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

POST /rest/ReplicationJobs/{identifier}/abort

Abort the replication job identified by {identifier}, that matches the <xs:element name="Identifier" type="xs:string"> property of a <xs:element name="ReplicationJob"> except for the bundleId portion of the {identifier} (after last '@') that is ignored.

Since:

1.1

postAction

public StringScalarType postAction(@Context
                                   javax.servlet.http.HttpServletRequest request,
                                   java.lang.String identifier,
                                   java.lang.String actionString,
                                   java.lang.String errorType)

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

POST /rest/ReplicationJobs/{identifier}

Perform the requested action on the replication job identified by {identifier}. The {identifier} will match against the <xs:element name="Identifier" type="xs:string"> of the schema to find the replication job.

The action query parameter is required.

Supported actions are:

• ?action=abort abort the replication job

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