com.dnanexus

Class DXRecord

java.lang.Object

com.dnanexus.DXObject

com.dnanexus.DXDataObject

com.dnanexus.DXRecord

public class DXRecord
extends DXDataObject

A record (the minimal data object class).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DXRecord.Builder Builder class for creating a new DXRecord object.
static class	DXRecord.Describe Contains metadata for a record.

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
DXRecord	close() Closes the data object.
DXRecord	closeAndWait() Closes the data object and waits until the close operation is complete.
DXRecord.Describe	describe() Returns metadata about the data object.
DXRecord.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.
DXRecord.Describe	getCachedDescribe() Returns metadata about the data object, like DXDataObject.describe(), but without making an API call.
static DXRecord	getInstance(String recordId) Returns a DXRecord associated with an existing record.
static DXRecord	getInstance(String recordId, DXContainer project) Returns a DXRecord associated with an existing record in a particular project or container.
static 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 DXRecord	getInstanceWithEnvironment(String recordId, DXEnvironment env) Returns a DXRecord associated with an existing record using the specified environment.
static DXRecord.Builder	newRecord() Returns a Builder object for creating a new DXRecord.
static DXRecord.Builder	newRecordWithEnvironment(DXEnvironment env) Returns a Builder object for creating a new DXRecord using the specified environment.

Methods inherited from class com.dnanexus.DXDataObject

addTags, addTypes, checkCachedDescribeAvailable, checkDXLinkFormat, 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

Method Detail

getInstance

public static DXRecord getInstance(String recordId)

Returns a DXRecord associated with an existing record.

Throws:

NullPointerException - If recordId is null

getInstance

public static DXRecord getInstance(String recordId,
                                   DXContainer project)

Returns a DXRecord associated with an existing record in a particular project or container.

Throws:

NullPointerException - If recordId or container is null

getInstanceWithEnvironment

public static DXRecord getInstanceWithEnvironment(String recordId,
                                                  DXContainer project,
                                                  DXEnvironment env)

Returns a DXRecord associated with an existing record in a particular project using the specified environment.

getInstanceWithEnvironment

public static DXRecord getInstanceWithEnvironment(String recordId,
                                                  DXEnvironment env)

Returns a DXRecord associated with an existing record using the specified environment.

Throws:

NullPointerException - If recordId is null

newRecord

public static DXRecord.Builder newRecord()

Returns a Builder object for creating a new DXRecord.

Example use:

 DXRecord r = DXRecord.newRecord().inProject("proj-0000").setName("foo").build();
 

Returns:

a newly initialized builder object

newRecordWithEnvironment

public static DXRecord.Builder newRecordWithEnvironment(DXEnvironment env)

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

Example use:

 DXRecord r = DXRecord.newRecordWithEnvironment(DXEnvironment.create()).inProject("proj-0000").setName("foo").build();
 

Parameters:

env - environment to use to make API calls

Returns:

a newly initialized builder object

close

public DXRecord close()

Description copied from class: DXDataObject

Closes the data object.

Returns the same object so you can chain calls.

Overrides:

close in class DXDataObject

Returns:

the same DXDataObject

closeAndWait

public DXRecord closeAndWait()

Description copied from class: DXDataObject

Closes the data object and waits until the close operation is complete.

Returns the same object so you can chain calls.

Overrides:

closeAndWait in class DXDataObject

Returns:

the same DXDataObject

describe

public DXRecord.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 DXRecord.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 DXRecord.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