Package | Description |
---|---|
com.dnanexus |
Provides low- and high-level bindings to the DNAnexus Platform.
|
Modifier and Type | Interface and Description |
---|---|
interface |
DXExecutable<T extends DXExecution>
An executable (applet, app, or workflow).
|
static class |
DXSearch.FindExecutionsRequestBuilder<T extends DXExecution>
Builder class for formulating
findExecutions queries and executing them. |
static class |
DXSearch.FindExecutionsResult<T extends DXExecution>
The set of executions that matched a
findExecutions query. |
class |
ExecutableRunner<T extends DXExecution>
Collects parameters for a new run of an executable.
|
Modifier and Type | Class and Description |
---|---|
class |
DXAnalysis
An analysis object (a specific instantiation of a workflow).
|
class |
DXJob
A job object (a specific instantiation of an app or applet).
|
Modifier and Type | Method and Description |
---|---|
static DXExecution |
DXExecution.getInstance(String executionId)
Returns a
DXExecution corresponding to an existing execution with the specified ID. |
static DXExecution |
DXExecution.getInstanceWithEnvironment(String executionId,
DXEnvironment env)
Returns a
DXExecution corresponding to an existing execution with the specified ID,
using the specified environment. |
DXExecution |
DXExecution.Describe.getRootExecution()
Returns the execution at the root of the execution tree (the job or analysis that was
created by a user's external API call rather than by a job or run as a stage in an
analysis).
|
abstract DXExecution |
DXExecution.waitUntilDone()
Waits until the execution has successfully completed and is in the DONE state.
|
Modifier and Type | Method and Description |
---|---|
static DXSearch.FindExecutionsRequestBuilder<DXExecution> |
DXSearch.findExecutions()
Returns a builder object for finding executions (jobs or analyses) that match certain
criteria.
|
static DXSearch.FindExecutionsRequestBuilder<DXExecution> |
DXSearch.findExecutionsWithEnvironment(DXEnvironment env)
Returns a builder object for finding executions that match certain criteria, using the
specified environment.
|
Modifier and Type | Method and Description |
---|---|
ExecutableRunner<T> |
ExecutableRunner.dependsOn(DXExecution execution)
Makes the resulting execution depend on the specified execution, so that the former will not
begin until the latter has successfully completed.
|
DXSearch.FindExecutionsRequestBuilder<T> |
DXSearch.FindExecutionsRequestBuilder.withRootExecution(DXExecution rootExecution)
Only return executions with the specified root execution.
|
Modifier and Type | Method and Description |
---|---|
DXSearch.FindExecutionsRequestBuilder<T> |
DXSearch.FindExecutionsRequestBuilder.withIdsIn(Collection<? extends DXExecution> executions)
Only returns executions whose IDs match one of the specified executions.
|
Copyright © 2023. All Rights Reserved.