com.dnanexus

Class DXSearch

java.lang.Object

com.dnanexus.DXSearch

public final class DXSearch
extends Object

Utility class containing methods for searching for platform objects by various criteria.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DXSearch.FindDataObjectsRequestBuilder<T extends DXDataObject> Builder class for formulating findDataObjects queries and executing them.
static class	DXSearch.FindDataObjectsResult<T extends DXDataObject> The set of data objects that matched a findDataObjects query.
static class	DXSearch.FindExecutionsRequestBuilder<T extends DXExecution> Builder class for formulating findExecutions queries and executing them.
static class	DXSearch.FindExecutionsResult<T extends DXExecution> The set of executions that matched a findExecutions query.
static interface	DXSearch.FindResultPage<T> Represents a single page of results for a find route.
static interface	DXSearch.ObjectProducer<T extends DXObject> Interface that provides streaming or buffered access to a sequence of DXObjects.
static class	DXSearch.Ordering Specifies in a query whether to return visible items, hidden items, or both.
static class	DXSearch.PropertiesQuery A query for objects (data objects, executions, or projects) with specified properties.
static class	DXSearch.TagsQuery A query for objects (data objects, executions, or projects) with specified tags.
static class	DXSearch.TypeQuery A query for data objects with specified types.
static class	DXSearch.VisibilityQuery Specifies in a query whether to return visible items, hidden items, or both.

Method Summary

Modifier and Type	Method and Description
static DXSearch.FindDataObjectsRequestBuilder<DXDataObject>	findDataObjects() Returns a builder object for finding data objects that match certain criteria.
static DXSearch.FindDataObjectsRequestBuilder<DXDataObject>	findDataObjectsWithEnvironment(DXEnvironment env) Returns a builder object for finding data objects that match certain criteria, using the specified environment.
static DXSearch.FindExecutionsRequestBuilder<DXExecution>	findExecutions() Returns a builder object for finding executions (jobs or analyses) that match certain criteria.
static DXSearch.FindExecutionsRequestBuilder<DXExecution>	findExecutionsWithEnvironment(DXEnvironment env) Returns a builder object for finding executions that match certain criteria, using the specified environment.
static DXSearch.FindExecutionsRequestBuilder<DXJob>	findJobs() Deprecated. Use findExecutions() in conjunction with DXSearch.FindExecutionsRequestBuilder.withClassJob() instead.
static DXSearch.FindExecutionsRequestBuilder<DXJob>	findJobsWithEnvironment(DXEnvironment env) Deprecated. Use findExecutionsWithEnvironment(DXEnvironment) in conjunction with DXSearch.FindExecutionsRequestBuilder.withClassJob() instead.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

findDataObjects

public static DXSearch.FindDataObjectsRequestBuilder<DXDataObject> findDataObjects()

Returns a builder object for finding data objects that match certain criteria.

Example use:

 FindDataObjectsResponse<DXDataObject> fdor = DXSearch.findDataObjects().inProject("project-000000000000000000000000")
         .inFolder("/my/subfolder").execute();

 for (DXDataObject o : fdor.asList()) {
     System.out.println(o.getId());
 }
 

Returns:

a newly initialized builder object

findDataObjectsWithEnvironment

public static DXSearch.FindDataObjectsRequestBuilder<DXDataObject> findDataObjectsWithEnvironment(DXEnvironment env)

Returns a builder object for finding data objects that match certain criteria, using the specified environment.

Example use:

 FindDataObjectsResponse<DXDataObject> fdor = DXSearch.findDataObjects(env).inProject("project-000000000000000000000000")
         .inFolder("/my/subfolder").execute();

 for (DXDataObject o : fdor.asList()) {
     System.out.println(o.getId());
 }
 

Parameters:

env - environment specifying API server parameters for issuing the query; the environment will be propagated into objects that are subsequently returned

Returns:

a newly initialized builder object

findExecutions

public static DXSearch.FindExecutionsRequestBuilder<DXExecution> findExecutions()

Returns a builder object for finding executions (jobs or analyses) that match certain criteria.

Returns:

a newly initialized builder object

findExecutionsWithEnvironment

public static DXSearch.FindExecutionsRequestBuilder<DXExecution> findExecutionsWithEnvironment(DXEnvironment env)

Returns a builder object for finding executions that match certain criteria, using the specified environment.

Parameters:

env - environment specifying API server parameters for issuing the query; the environment will be propagated into objects that are subsequently returned

Returns:

a newly initialized builder object

findJobs

@Deprecated
public static DXSearch.FindExecutionsRequestBuilder<DXJob> findJobs()

Deprecated. Use findExecutions() in conjunction with DXSearch.FindExecutionsRequestBuilder.withClassJob() instead.

Returns a builder object for finding jobs that match certain criteria.

This is equivalent to findExecutions().withClassJob().

Returns:

a newly initialized builder object

findJobsWithEnvironment

@Deprecated
public static DXSearch.FindExecutionsRequestBuilder<DXJob> findJobsWithEnvironment(DXEnvironment env)

Deprecated. Use findExecutionsWithEnvironment(DXEnvironment) in conjunction with DXSearch.FindExecutionsRequestBuilder.withClassJob() instead.

Returns a builder object for finding jobs that match certain criteria, using the specified environment.

This is equivalent to findExecutionsWithEnvironment(env).withClassJob().

Parameters:

env - environment specifying API server parameters for issuing the query; the environment will be propagated into objects that are subsequently returned

Returns:

a newly initialized builder object