Package | Description |
---|---|
com.dnanexus |
Provides low- and high-level bindings to the DNAnexus Platform.
|
Modifier and Type | Class and Description |
---|---|
class |
DXProject
A project (a container providing features for data sharing and collaboration).
|
Modifier and Type | Field and Description |
---|---|
protected DXContainer |
DXDataObject.Builder.project |
Modifier and Type | Method and Description |
---|---|
static DXContainer |
DXContainer.getInstance(String projectOrContainerId)
Returns a
DXProject or DXContainer associated with an existing project or
container. |
static DXContainer |
DXContainer.getInstanceWithEnvironment(String projectOrContainerId,
DXEnvironment env)
Returns a
DXProject or DXContainer associated with an existing project or
container, using the specified environment. |
DXContainer |
DXDataObject.getProject()
Returns the object's project or container, if it was explicitly supplied.
|
DXContainer |
DXDataObject.Describe.getProject()
Returns the project or container from which user-provided metadata was retrieved.
|
DXContainer |
DXJob.Describe.getProjectCache()
Returns the project cache container for the job if it is running an app, or null
otherwise.
|
DXContainer |
DXJob.Describe.getResources()
Returns the resources container for the job if it is running an app, or null otherwise.
|
DXContainer |
DXEnvironment.getWorkspace()
Returns the temporary workspace of the currently running job, or the current project if this
method is called outside the Execution Environment.
|
DXContainer |
DXExecution.Describe.getWorkspace()
Returns the temporary workspace associated with the execution.
|
Modifier and Type | Method and Description |
---|---|
Map<DXContainer,AccessLevel> |
DXDataObject.listProjects()
Returns the set of projects that contain this object, and which the requesting user has
permissions to access.
|
Modifier and Type | Method and Description |
---|---|
static DXRecord |
DXRecord.getInstance(String recordId,
DXContainer project)
Returns a
DXRecord associated with an existing record in a particular project or
container. |
static DXApplet |
DXApplet.getInstance(String appletId,
DXContainer project)
Returns a
DXApplet associated with an existing applet in a particular project or
container. |
static DXWorkflow |
DXWorkflow.getInstance(String workflowId,
DXContainer project)
Returns a
DXWorkflow associated with an existing workflow in a particular project or
container. |
static DXFile |
DXFile.getInstance(String fileId,
DXContainer project)
Returns a
DXFile associated with an existing file in a particular project or
container. |
static DXDataObject |
DXDataObject.getInstance(String objectId,
DXContainer project)
Returns a
DXDataObject corresponding to an existing object with the specified ID in
the specified project or container. |
static DXRecord |
DXRecord.getInstanceWithEnvironment(String recordId,
DXContainer project,
DXEnvironment env)
Returns a
DXRecord associated with an existing record in a particular project using
the specified environment. |
static DXApplet |
DXApplet.getInstanceWithEnvironment(String appletId,
DXContainer project,
DXEnvironment env)
Returns a
DXApplet associated with an existing applet in a particular project using
the specified environment. |
static DXWorkflow |
DXWorkflow.getInstanceWithEnvironment(String workflowId,
DXContainer project,
DXEnvironment env)
Returns a
DXWorkflow associated with an existing workflow in a particular project
using the specified environment. |
static DXFile |
DXFile.getInstanceWithEnvironment(String fileId,
DXContainer project,
DXEnvironment env)
Returns a
DXFile associated with an existing file in a particular project using the
specified environment. |
static DXDataObject |
DXDataObject.getInstanceWithEnvironment(String objectId,
DXContainer project,
DXEnvironment env)
Returns a
DXDataObject corresponding to an existing object with the specified ID in
the specified project or container, using the specified environment. |
DXSearch.FindDataObjectsRequestBuilder<T> |
DXSearch.FindDataObjectsRequestBuilder.inFolder(DXContainer project,
String folder)
Only returns objects in the specified folder of the specified project (not in
subfolders).
|
DXSearch.FindDataObjectsRequestBuilder<T> |
DXSearch.FindDataObjectsRequestBuilder.inFolderOrSubfolders(DXContainer project,
String folder)
Only returns objects in the specified folder of the specified project or in its
subfolders.
|
DXSearch.FindDataObjectsRequestBuilder<T> |
DXSearch.FindDataObjectsRequestBuilder.inProject(DXContainer project)
Only returns objects in the specified project.
|
DXSearch.FindExecutionsRequestBuilder<T> |
DXSearch.FindExecutionsRequestBuilder.inProject(DXContainer project)
Only returns executions in the specified project.
|
DXDataObject.DescribeOptions |
DXDataObject.DescribeOptions.inProject(DXContainer project)
Returns a
DescribeOptions that behaves like the current one, except that
project-specific metadata will be retrieved from the specified project or container. |
T |
DXDataObject.Builder.setProject(DXContainer project)
Sets the project or container where the new data object will be created.
|
DXEnvironment.Builder |
DXEnvironment.Builder.setWorkspace(DXContainer workspace)
Sets the workspace to the specified container.
|
Constructor and Description |
---|
DXDataObject(String dxId,
String className,
DXContainer project,
DXEnvironment env,
com.fasterxml.jackson.databind.JsonNode cachedDescribe)
Initializes the
DXDataObject to point to the object with the specified ID in the
specified project. |
Copyright © 2023. All Rights Reserved.