com.quantum.dxi.rest.system

Class BackgroundJobs

java.lang.Object

Base

com.quantum.dxi.rest.system.BackgroundJobs

public class BackgroundJobs
extends Base

The BackgroundJobs resource represents operations that run in the background on the system. Background jobs are typically started when an update is requested via a web service call, and the web service returns a job id rather than blocking for the potentially long-running operation. The client may then poll the status of the job using the BackgroundJobs resource.

The schema that defines the BackgroundJobs resource is defined below.

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

    <xs:element name="BackgroundJob">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="Id" type="xs:int"/>
                <xs:element name="Done" type="xs:boolean"/>
                <xs:element name="HasStatusText" type="xs:boolean">
                    <xs:annotation>
                        <xs:documentation>If true, next is present</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="StatusText" type="xs:string" minOccurs="0"/>
                <xs:element name="HasPercentComplete" type="xs:boolean">
                    <xs:annotation>
                        <xs:documentation>If true, next is present</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="PercentComplete" type="xs:int" minOccurs="0"/>
                <xs:element name="HasSteps" type="xs:boolean">
                    <xs:annotation>
                        <xs:documentation>If true, 3 next are present</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="StepCount" type="xs:int" minOccurs="0"/>
                <xs:element name="CurrentStep" type="xs:int" minOccurs="0"/>
                <xs:element name="StepPercentComplete" type="xs:int" minOccurs="0"/>
                <xs:element name="LastRunTime" type="xs:long" minOccurs="0"/>
                <xs:element name="Description" type="xs:string" minOccurs="0"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="BackgroundJobColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Id"/>
            <xs:enumeration value="Done"/>
            <xs:enumeration value="HasStatusText"/>
            <xs:enumeration value="StatusText"/>
            <xs:enumeration value="HasPercentComplete"/>
            <xs:enumeration value="PercentComplete"/>
            <xs:enumeration value="HasSteps"/>
            <xs:enumeration value="StepCount"/>
            <xs:enumeration value="CurrentStep"/>
            <xs:enumeration value="StepPercentComplete"/>
            <xs:enumeration value="LastRunTime"/>
            <xs:enumeration value="Description"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
BackgroundJobs()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getJob(javax.servlet.http.HttpServletRequest request, java.lang.String jobId, java.lang.String action) GET /rest/BackgroundJobs/{jobId}
com.quantum.dxi.dao.types.BackgroundJobs	getJobs(javax.servlet.http.HttpServletRequest request) GET /rest/BackgroundJobs
javax.ws.rs.core.Response	getResult(javax.servlet.http.HttpServletRequest request, java.lang.String jobId) GET /rest/BackgroundJobs/{jobId}/getResult

Methods inherited from class java.lang.Object

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

Constructor Detail

BackgroundJobs

public BackgroundJobs()

Method Detail

getJobs

public com.quantum.dxi.dao.types.BackgroundJobs getJobs(@Context
                                                        javax.servlet.http.HttpServletRequest request)

GET /rest/BackgroundJobs

Get the status of background jobs on the system.

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

getResult

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

GET /rest/BackgroundJobs/{jobId}/getResult

Get the result of a completed background job on the system identified by {jobId}. This call blocks until the background job is complete, and is subject to network timeout for long running jobs.

Best practice: use GET /rest/BackgroundJobs/{jobId} to periodically poll the status of the background job, and check the <Done> element of the response. Once <Done> is true, call GET /rest/BackgroundJobs/{jobId}/getResults to get the completed job result.

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

Since:

1.1

getJob

public java.lang.Object getJob(@Context
                               javax.servlet.http.HttpServletRequest request,
                               java.lang.String jobId,
                               @Deprecated
                               java.lang.String action)

GET /rest/BackgroundJobs/{jobId}

Get the background job on the system identified by {jobId}

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

Deprecated as of 1.1:
The "action" query parameter is deprecated.
?action=getResult replaced by getResult(HttpServletRequest, String)

The ?action=getResult query parameter returns the status of a completed job.