Package com.dnanexus

Class DXJob

java.lang.Object

com.dnanexus.DXObject

com.dnanexus.DXExecution

com.dnanexus.DXJob

public final class DXJob
extends DXExecution

A job object (a specific instantiation of an app or applet).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DXJob.Describe	Contains metadata about a job.
static class	DXJob.StateTransition	A event where a job transitioned from one state to another.

Field Summary

Fields inherited from class com.dnanexus.DXExecution

cachedDescribe

Fields inherited from class com.dnanexus.DXObject

dxId, env, MAPPER

Method Summary

Modifier and Type	Method	Description
DXJob.Describe	describe()	Obtains metadata about the execution.
DXJob.Describe	getCachedDescribe()	Returns metadata about the data object, like DXExecution.describe(), but without making an API call.
static DXJob	getInstance(String jobId)	Returns a DXJob representing the specified job.
static DXJob	getInstanceWithEnvironment(String jobId, DXEnvironment env)	Returns a DXJob representing the specified job using the specified environment.
<T> T	getOutput(Class<T> outputClass)	Returns the output of the execution, deserialized to the specified class.
void	terminate()	Terminates the execution.
DXJob	waitUntilDone()	Waits until the job has successfully completed and is in the DONE state.

Methods inherited from class com.dnanexus.DXExecution

checkCachedDescribeAvailable

Methods inherited from class com.dnanexus.DXObject

apiCallOnObject, apiCallOnObject, equals, getId, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static DXJob getInstance(String jobId)

Returns a DXJob representing the specified job.

Parameters:

jobId - Job ID, of the form "job-xxxx"

Returns:

a DXJob

Throws:

NullPointerException - If jobId is null

getInstanceWithEnvironment

public static DXJob getInstanceWithEnvironment(String jobId,
                                               DXEnvironment env)

Returns a DXJob representing the specified job using the specified environment.

Parameters:

jobId - Job ID, of the form "job-xxxx"

env - environment to use for making subsequent API calls

Returns:

a DXJob

Throws:

NullPointerException - If jobId or env is null

describe

public DXJob.Describe describe()

Description copied from class: DXExecution

Obtains metadata about the execution.

Specified by:

describe in class DXExecution

Returns:

a Describe containing execution metadata

getCachedDescribe

public DXJob.Describe getCachedDescribe()

Description copied from class: DXExecution

Returns metadata about the data object, like DXExecution.describe(), but without making an API call.

This cached describe info is only available if this object appears in the result of a DXSearch.findExecutions() call that specified DXSearch.FindExecutionsRequestBuilder.includeDescribeOutput(). The describe info that is returned reflects the state of the object at the time that the search was performed.

Specified by:

getCachedDescribe in class DXExecution

Returns:

a Describe containing the execution's metadata

getOutput

public <T> T getOutput(Class<T> outputClass)
                throws IllegalStateException

Description copied from class: DXExecution

Returns the output of the execution, deserialized to the specified class.

Specified by:

getOutput in class DXExecution

Parameters:

outputClass - class to deserialize to

Returns:

execution output

Throws:

IllegalStateException - if the execution is not in the DONE state.

terminate

public void terminate()

Description copied from class: DXExecution

Terminates the execution.

Specified by:

terminate in class DXExecution

waitUntilDone

public DXJob waitUntilDone()
                    throws IllegalStateException

Waits until the job has successfully completed and is in the DONE state.

Specified by:

waitUntilDone in class DXExecution

Returns:

the same DXJob object

Throws:

IllegalStateException - if the job reaches the FAILED or TERMINATED state