Package com.dnanexus

Class DXAnalysis.Describe

java.lang.Object

com.dnanexus.DXExecution.Describe

com.dnanexus.DXAnalysis.Describe

Enclosing class:

DXAnalysis

public static final class DXAnalysis.Describe
extends DXExecution.Describe

Contains metadata about an analysis. All accessors reflect the state of the analysis at the time that this object was created.

Field Summary

Fields inherited from class com.dnanexus.DXExecution.Describe

env

Method Summary

Modifier and Type	Method	Description
<T> T	getOutput(Class<T> outputClass)	Returns the output of the analysis, deserialized to the specified class, or null if no output hash is available.
AnalysisState	getState()	Returns the state of the analysis.

Methods inherited from class com.dnanexus.DXExecution.Describe

getAnalysis, getBillTo, getCreationDate, getDetails, getExecutableName, getFolder, getId, getInput, getLaunchedBy, getModifiedDate, getName, getOriginalInput, getParentAnalysis, getParentJob, getProject, getProperties, getRootExecution, getRunInput, getStage, getTags, getTotalPrice, getWorkspace, isWorkspaceDestructionDelayed

Methods inherited from class java.lang.Object

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

Method Detail

getOutput

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

Returns the output of the analysis, deserialized to the specified class, or null if no output hash is available. Note that this field is not guaranteed to be complete until the analysis has finished.

A partial output hash is available as soon as the first stage finishes. As each stage finishes, its corresponding outputs will become visible.

Overrides:

getOutput in class DXExecution.Describe

Parameters:

outputClass - class to deserialize to

Returns:

output object or null

getState

public AnalysisState getState()

Returns the state of the analysis.

Returns:

analysis state