Package com.dnanexus

Class DXSearch

  • public final class DXSearch
extends Object
    Utility class containing methods for searching for platform objects by various criteria.

    • 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