public class DXProject extends DXContainer
Modifier and Type | Class and Description |
---|---|
static class |
DXProject.Builder
Builder class for creating a new
DXProject object. |
static class |
DXProject.Describe
Contains metadata for a project.
|
DXContainer.FolderContents
Modifier and Type | Method and Description |
---|---|
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. |
listFolder, move, moveFolders, moveObjects, newFolder, newFolder, removeFolder, removeFolder, removeObjects, renameFolder
apiCallOnObject, apiCallOnObject, equals, getId, hashCode, toString
public static DXProject getInstance(String projectId)
DXProject
associated with an existing project.NullPointerException
- if projectId
is nullpublic static DXProject getInstanceWithEnvironment(String projectId, DXEnvironment env)
DXProject
associated with an existing project using the specified
environment.NullPointerException
- if projectId
or env
is nullpublic static DXProject.Builder newProject()
DXProject
.
Example use:
DXProject r = DXProject.newProject().setName("foo").build();
Builder
public static DXProject.Builder newProjectWithEnvironment(DXEnvironment env)
DXProject
using the specified
environment.Builder
public DXProject.Describe describe()
Describe
object containing metadatapublic void destroy()
public void destroy(boolean terminateJobs)
terminateJobs
- if true, terminates any running jobs in the projectCopyright © 2022. All Rights Reserved.