com.dnanexus

Class DXProject

java.lang.Object

com.dnanexus.DXObject

com.dnanexus.DXContainer

com.dnanexus.DXProject

public class DXProject
extends DXContainer

A project (a container providing features for data sharing and collaboration).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DXProject.ArchiveRequestBuilder Builder for archive requests.
static class	DXProject.ArchiveResults Results of archive request.
static class	DXProject.Builder Builder class for creating a new DXProject object.
static class	DXProject.Describe Contains metadata for a project.
class	DXProject.UnarchiveRequestBuilder Builder for unarchive requests.
static class	DXProject.UnarchiveResults Results of unarchive request.

Nested classes/interfaces inherited from class com.dnanexus.DXContainer

DXContainer.FolderContents

Field Summary

Fields inherited from class com.dnanexus.DXObject

dxId, env, MAPPER

Method Summary

Modifier and Type	Method and Description
DXProject.ArchiveRequestBuilder	archive() Request specified files or folder to be archived.
DXProject.Describe	describe() Returns metadata about the project.
void	destroy() Destroys the project and all its contents.
void	destroy(boolean terminateJobs) Destroys the project and all its contents, optionally terminating all running jobs.
static DXProject	getInstance(String projectId) Returns a DXProject associated with an existing project.
static DXProject	getInstanceWithEnvironment(String projectId, DXEnvironment env) Returns a DXProject associated with an existing project using the specified environment.
static DXProject.Builder	newProject() Returns a Builder object for creating a new DXProject.
static DXProject.Builder	newProjectWithEnvironment(DXEnvironment env) Returns a Builder object for creating a new DXProject using the specified environment.
DXProject.UnarchiveRequestBuilder	unarchive() Request specified files or folder to be unarchived.

Methods inherited from class com.dnanexus.DXContainer

listFolder, move, moveFolders, moveObjects, newFolder, newFolder, removeFolder, removeFolder, removeObjects, renameFolder

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 DXProject getInstance(String projectId)

Returns a DXProject associated with an existing project.

Throws:

NullPointerException - if projectId is null

getInstanceWithEnvironment

public static DXProject getInstanceWithEnvironment(String projectId,
                                                   DXEnvironment env)

Returns a DXProject associated with an existing project using the specified environment.

Throws:

NullPointerException - if projectId or env is null

newProject

public static DXProject.Builder newProject()

Returns a Builder object for creating a new DXProject.

Example use:

 DXProject r = DXProject.newProject().setName("foo").build();
 

Returns:

a newly initialized Builder

newProjectWithEnvironment

public static DXProject.Builder newProjectWithEnvironment(DXEnvironment env)

Returns a Builder object for creating a new DXProject using the specified environment.

Returns:

a newly initialized Builder

describe

public DXProject.Describe describe()

Returns metadata about the project.

Returns:

a Describe object containing metadata

destroy

public void destroy()

Destroys the project and all its contents.

destroy

public void destroy(boolean terminateJobs)

Destroys the project and all its contents, optionally terminating all running jobs.

Parameters:

terminateJobs - if true, terminates any running jobs in the project

archive

public DXProject.ArchiveRequestBuilder archive()

Request specified files or folder to be archived.

Example use:

 // Archive using file id
 DXFile f1 = DXFile.getInstance("file-xxxx");
 DXFile f2 = DXFile.getInstance("file-yyyy");
 ArchiveResults r = project.archive().addFiles(f1, f2).execute();
 // Archive folder
 ArchiveResults r = project.archive().setFolder("/folder", true).execute();
 

Returns:

a newly initialized ArchiveRequestBuilder

unarchive

public DXProject.UnarchiveRequestBuilder unarchive()

Request specified files or folder to be unarchived.

Example use:

 // Unarchive using file id
 DXFile f1 = DXFile.getInstance("file-xxxx");
 DXFile f2 = DXFile.getInstance("file-yyyy");
 UnarchiveResults r = project.unarchive().addFiles(f1, f2).execute();
 // Unarchive folder
 UnarchiveResults r = project.unarchive().setFolder("/folder", true).execute();
 

Returns:

a newly initialized UnarchiveRequestBuilder