See: Description
| Interface | Description |
|---|---|
| DXExecutable<T extends DXExecution> |
An executable (applet, app, or workflow).
|
| DXSearch.FindResultPage<T> |
Represents a single page of results for a find route.
|
| DXSearch.ObjectProducer<T extends DXObject> |
Interface that provides streaming or buffered access to a sequence of
DXObjects. |
| Class | Description |
|---|---|
| DXAnalysis |
An analysis object (a specific instantiation of a workflow).
|
| DXAnalysis.Describe |
Contains metadata about an analysis.
|
| DXAPI |
Utility class containing low-level wrappers for invoking DNAnexus API methods.
|
| DXApplet |
An applet (an executable data object).
|
| DXApplet.Builder |
Builder class for creating a new
DXApplet object. |
| DXApplet.Describe |
Contains metadata for an applet.
|
| DXContainer |
A container (a logical collection for storage and organization of data).
|
| DXContainer.FolderContents |
Represents the contents of a folder.
|
| DXDataObject |
Base class for all data object classes in the DNAnexus Platform.
|
| DXDataObject.Builder<T extends DXDataObject.Builder<T,U>,U extends DXDataObject> |
Abstract builder class for creating a new data object of class
U. |
| DXDataObject.Describe |
Contains metadata for a data object (fields common to all data objects).
|
| DXDataObject.DescribeOptions |
Configuration options for a describe call on a data object (e.g.
DXDataObject.describe(DescribeOptions)) to control what optional fields get returned
and what project to obtain project-specific metadata from. |
| DXEnvironment |
Immutable class storing configuration for selecting, authenticating to, and communicating with a
DNAnexus API server.
|
| DXEnvironment.Builder |
Builder class for creating DXEnvironment objects.
|
| DXEnvironment.ProxyDesc | |
| DXExecution |
An execution (job or analysis).
|
| DXExecution.Describe |
Contains metadata about an execution.
|
| DXExecution.DescribeResponseHash |
Deserialized output from the /analysis-xxxx/describe or /job-xxxx/describe route (fields
common to all executions only).
|
| DXFile |
A file (an opaque sequence of bytes).
|
| DXFile.Builder |
Builder class for creating a new
DXFile object. |
| DXFile.Describe |
Contains metadata for a file.
|
| DXHTTPRequest |
Class for making a raw DNAnexus API call via HTTP.
|
| DXJob |
A job object (a specific instantiation of an app or applet).
|
| DXJob.Describe |
Contains metadata about a job.
|
| DXJob.StateTransition |
A event where a job transitioned from one state to another.
|
| DXJSON |
Utility class for working with JSON objects.
|
| DXJSON.ArrayBuilder |
Builder class that generates a JSON array.
|
| DXJSON.ObjectBuilder |
Builder class that generates a JSON object (hash).
|
| DXObject |
Base class for all objects in the DNAnexus Platform.
|
| DXProject |
A project (a container providing features for data sharing and collaboration).
|
| DXProject.ArchiveResults |
Results of archive request.
|
| DXProject.Builder |
Builder class for creating a new
DXProject object. |
| DXProject.Describe |
Contains metadata for a project.
|
| DXProject.UnarchiveResults |
Results of unarchive request.
|
| DXRecord |
A record (the minimal data object class).
|
| DXRecord.Builder |
Builder class for creating a new
DXRecord object. |
| DXRecord.Describe |
Contains metadata for a record.
|
| DXSearch |
Utility class containing methods for searching for platform objects by various criteria.
|
| DXSearch.FindDataObjectsRequestBuilder<T extends DXDataObject> |
Builder class for formulating
findDataObjects queries and executing them. |
| DXSearch.FindDataObjectsResult<T extends DXDataObject> |
The set of data objects that matched a
findDataObjects query. |
| DXSearch.FindExecutionsRequestBuilder<T extends DXExecution> |
Builder class for formulating
findExecutions queries and executing them. |
| DXSearch.FindExecutionsResult<T extends DXExecution> |
The set of executions that matched a
findExecutions query. |
| DXSearch.PropertiesQuery |
A query for objects (data objects, executions, or projects) with specified properties.
|
| DXSearch.TagsQuery |
A query for objects (data objects, executions, or projects) with specified tags.
|
| DXSearch.TypeQuery |
A query for data objects with specified types.
|
| DXUtil |
Utility class for handling job input and output.
|
| DXWorkflow |
A workflow.
|
| DXWorkflow.Builder |
Builder class for creating a new
DXWorkflow object. |
| DXWorkflow.Describe |
Contains metadata for a workflow.
|
| DXWorkflow.Modification<T> |
Represents the result of a workflow-modifying operation, along with the
workflow's edit version after that operation.
|
| DXWorkflow.Stage |
A workflow stage.
|
| ExecutableRunner<T extends DXExecution> |
Collects parameters for a new run of an executable.
|
| InputParameter |
An input parameter for an executable.
|
| InputParameter.Builder |
Builder class for creating new input parameters.
|
| OutputParameter |
An output parameter for an executable.
|
| OutputParameter.Builder |
Builder class for creating new output parameters.
|
| RunSpecification |
A run specification for an applet.
|
| RunSpecification.Builder |
Builder class for creating RunSpecifications.
|
| Enum | Description |
|---|---|
| AccessLevel |
A permission level that a user can be given in a particular project or container.
|
| AnalysisState |
The state of an analysis in the system.
|
| ArchivalState |
Archival states of file object.
|
| DataObjectState |
The state of a data object.
|
| DXHTTPRequest.RetryStrategy |
Indicates whether a particular API request can be retried.
|
| DXSearch.Ordering |
Specifies in a query whether to return visible items, hidden items, or both.
|
| DXSearch.VisibilityQuery |
Specifies in a query whether to return visible items, hidden items, or both.
|
| IOClass |
The type of an input or output field of an executable.
|
| JobState |
The state of a job in the system.
|
| UnarchivingRate |
Copyright © 2023. All Rights Reserved.