com.dnanexus

Class DXApplet

java.lang.Object

com.dnanexus.DXObject

com.dnanexus.DXDataObject

com.dnanexus.DXApplet

All Implemented Interfaces:

DXExecutable<DXJob>

public class DXApplet
extends DXDataObject
implements DXExecutable<DXJob>

An applet (an executable data object).

Although these bindings will allow you to create a simple applet from scratch, we encourage you to use the command-line tool dx build instead. See the API documentation for applets.

The describe() method returns a RunSpecification object that does not have the "code" field populated; that is, RunSpecification.getCode() will return null.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DXApplet.Builder Builder class for creating a new DXApplet object.
static class	DXApplet.Describe Contains metadata for an applet.

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

DXDataObject.DescribeOptions

Field Summary

Fields inherited from class com.dnanexus.DXDataObject

cachedDescribe

Fields inherited from class com.dnanexus.DXObject

dxId, env, MAPPER

Method Summary

Modifier and Type	Method and Description
DXApplet.Describe	describe() Returns metadata about the data object.
DXApplet.Describe	describe(DXDataObject.DescribeOptions options) Returns metadata about the data object, specifying which optional fields are to be returned and what project to obtain project-specific metadata from.
DXApplet.Describe	getCachedDescribe() Returns metadata about the data object, like DXDataObject.describe(), but without making an API call.
static DXApplet	getInstance(String appletId) Returns a DXApplet associated with an existing applet.
static DXApplet	getInstance(String appletId, DXContainer project) Returns a DXApplet associated with an existing applet in a particular project or container.
static 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 DXApplet	getInstanceWithEnvironment(String appletId, DXEnvironment env) Returns a DXApplet associated with an existing applet using the specified environment.
static DXApplet.Builder	newApplet() Returns a Builder object for creating a new DXApplet.
static DXApplet.Builder	newAppletWithEnvironment(DXEnvironment env) Returns a Builder object for creating a new DXApplet using the specified environment.
ExecutableRunner<DXJob>	newRun() Returns an object for creating a new run of this executable.

Methods inherited from class com.dnanexus.DXDataObject

addTags, addTypes, checkCachedDescribeAvailable, checkDXLinkFormat, close, closeAndWait, equals, getLinkAsJson, getProject, hashCode, listProjects, putAllProperties, putAllProperties, putProperty, removeProperty, removeTags, removeTypes, rename, setDetails, setVisibility

Methods inherited from class com.dnanexus.DXObject

apiCallOnObject, apiCallOnObject, getId, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.dnanexus.DXExecutable

getId

Method Detail

getInstance

public static DXApplet getInstance(String appletId)

Returns a DXApplet associated with an existing applet.

Throws:

NullPointerException - If appletId is null

getInstance

public static DXApplet getInstance(String appletId,
                                   DXContainer project)

Returns a DXApplet associated with an existing applet in a particular project or container.

Throws:

NullPointerException - If appletId or container is null

getInstanceWithEnvironment

public static DXApplet getInstanceWithEnvironment(String appletId,
                                                  DXContainer project,
                                                  DXEnvironment env)

Returns a DXApplet associated with an existing applet in a particular project using the specified environment.

Throws:

NullPointerException - If appletId or container is null

getInstanceWithEnvironment

public static DXApplet getInstanceWithEnvironment(String appletId,
                                                  DXEnvironment env)

Returns a DXApplet associated with an existing applet using the specified environment.

Throws:

NullPointerException - If appletId is null

newApplet

public static DXApplet.Builder newApplet()

Returns a Builder object for creating a new DXApplet.

Returns:

Builder object

newAppletWithEnvironment

public static DXApplet.Builder newAppletWithEnvironment(DXEnvironment env)

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

Parameters:

env - environment to be used for subsequent API calls

Returns:

Builder object

describe

public DXApplet.Describe describe()

Description copied from class: DXDataObject

Returns metadata about the data object.

The properties and details fields will not be returned, and any project-specific metadata fields will be selected from an arbitrary project in which the requesting user has access to this object. To change either of these aspects of this behavior, use DXDataObject.describe(DescribeOptions) instead.

Overrides:

describe in class DXDataObject

Returns:

a Describe containing the data object's metadata.

describe

public DXApplet.Describe describe(DXDataObject.DescribeOptions options)

Description copied from class: DXDataObject

Returns metadata about the data object, specifying which optional fields are to be returned and what project to obtain project-specific metadata from.

Overrides:

describe in class DXDataObject

Parameters:

options - DescribeOptions object specifying how the describe request is to be made.

Returns:

a Describe containing the data object's metadata.

getCachedDescribe

public DXApplet.Describe getCachedDescribe()

Description copied from class: DXDataObject

Returns metadata about the data object, like DXDataObject.describe(), but without making an API call.

This cached describe info is only available if this object appears in the result of a DXSearch.findDataObjects() call that specified DXSearch.FindDataObjectsRequestBuilder.includeDescribeOutput(), and the describe info that is returned reflects the state of the object at the time that the search was performed.

Overrides:

getCachedDescribe in class DXDataObject

Returns:

a Describe containing the data object's metadata

newRun

public ExecutableRunner<DXJob> newRun()

Description copied from interface: DXExecutable

Returns an object for creating a new run of this executable.

Specified by:

newRun in interface DXExecutable<DXJob>

Returns:

executable runner