Package com.dnanexus

Class DXExecution.Describe

  • Direct Known Subclasses:
    DXAnalysis.Describe, DXJob.Describe
    Enclosing class:
    DXExecution
    public abstract static class DXExecution.Describe
extends Object
    Contains metadata about an execution. All accessors reflect the state of the execution at the time that this object was created.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected DXEnvironment env  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      DXAnalysis getAnalysis()
      Returns the analysis that this execution was run as a stage of, or null if this execution was not run as a stage in an analysis.
      String getBillTo()
      Returns the user or organization that this execution was billed to.
      Date getCreationDate()
      Returns the date at which the execution was created.
      <T> T getDetails​(Class<T> detailsClass)
      Returns the details (user-suppled metadata) of the execution, deserialized to the specified class.
      String getExecutableName()
      Returns the name of the executable that was run to create this execution.
      String getFolder()
      Returns the output folder of the execution.
      String getId()
      Returns the ID of the execution.
      <T> T getInput​(Class<T> inputClass)
      Returns the execution's input as it will be given to the job (to the extent possible), deserialized to the specified class.
      String getLaunchedBy()
      Returns the user that launched this execution.
      Date getModifiedDate()
      Returns the date at which the execution was last modified.
      String getName()
      Returns the name of the execution.
      <T> T getOriginalInput​(Class<T> inputClass)
      Returns the input of the execution, with default values filled in for optional inputs that were not provided, deserialized to the specified class.
      <T> T getOutput​(Class<T> outputClass)
      Returns the output of the execution, deserialized to the specified class, or null if no output hash is available.
      DXAnalysis getParentAnalysis()
      Returns the execution's parent analysis, or null if the execution was not created by a analysis.
      DXJob getParentJob()
      Returns the execution's parent job, or null if the execution was not created by a job.
      DXProject getProject()
      Returns the project in which this execution was run.
      Map<String,​String> getProperties()
      Returns the properties associated with the execution.
      DXExecution getRootExecution()
      Returns the execution at the root of the execution tree (the job or analysis that was created by a user's external API call rather than by a job or run as a stage in an analysis).
      <T> T getRunInput​(Class<T> inputClass)
      Returns the raw input of the execution, deserialized to the specified class.
      String getStage()
      Returns the stage that this execution is associated with, if it was run as a stage in an analysis; null otherwise.
      List<String> getTags()
      Returns the tags associated with the execution.
      double getTotalPrice()
      Returns the total price of the job.
      DXContainer getWorkspace()
      Returns the temporary workspace associated with the execution.
      boolean isWorkspaceDestructionDelayed()
      Returns true if the execution's temporary workspace will be kept around for 3 days after the execution finishes.

    • Method Detail

      • getAnalysis

        public DXAnalysis getAnalysis()
        Returns the analysis that this execution was run as a stage of, or null if this execution was not run as a stage in an analysis.
        Returns:
        immediate parent analysis, or null

      • getBillTo

        public String getBillTo()
        Returns the user or organization that this execution was billed to.
        Returns:
        user or organization ID

      • getCreationDate

        public Date getCreationDate()
        Returns the date at which the execution was created.
        Returns:
        the execution's creation date

      • getDetails

        public <T> T getDetails​(Class<T> detailsClass)
        Returns the details (user-suppled metadata) of the execution, deserialized to the specified class.
        Parameters:
        detailsClass - class to deserialize to
        Returns:
        the execution's details

      • getExecutableName

        public String getExecutableName()
        Returns the name of the executable that was run to create this execution.
        Returns:
        name of applet, app, or workflow

      • getFolder

        public String getFolder()
        Returns the output folder of the execution.
        Returns:
        full path (beginning with "/") of the folder in which the outputs of the execution will be placed

      • getId

        public String getId()
        Returns the ID of the execution.
        Returns:
        the execution ID

      • getInput

        public <T> T getInput​(Class<T> inputClass)
        Returns the execution's input as it will be given to the job (to the extent possible), deserialized to the specified class. This is the same as the output of getOriginalInput(Class), except that as job-based object references are resolved they are replaced with the resulting object IDs; this does not apply to analyses, for which the result of this method is always the same as that of getOriginalInput(Class). Once a job has transitioned to state "runnable", this is exactly the input that the job will receive.

        Note that for jobs, this input may contain job-based object references (until the time that the job enters the "runnable" state), which may require special deserialization code in your target class.

        Parameters:
        inputClass - class to deserialize to
        Returns:
        execution's input

      • getLaunchedBy

        public String getLaunchedBy()
        Returns the user that launched this execution.
        Returns:
        user ID

      • getModifiedDate

        public Date getModifiedDate()
        Returns the date at which the execution was last modified.
        Returns:
        the execution's modification date

      • getName

        public String getName()
        Returns the name of the execution.
        Returns:
        the execution name

      • getOriginalInput

        public <T> T getOriginalInput​(Class<T> inputClass)
        Returns the input of the execution, with default values filled in for optional inputs that were not provided, deserialized to the specified class. For analyses, all input field names will also have been canonicalized to the form "stage-XXXX.fieldName".

        Note that this input may contain job-based object references, which may require special deserialization code in your target class.

        Parameters:
        inputClass - class to deserialize to
        Returns:
        execution's input with default values filled in

      • getOutput

        public <T> T getOutput​(Class<T> outputClass)
        Returns the output of the execution, deserialized to the specified class, or null if no output hash is available. Note that this field is not guaranteed to be complete until the execution has finished.
        Parameters:
        outputClass - class to deserialize to
        Returns:
        output object or null

      • getParentAnalysis

        public DXAnalysis getParentAnalysis()
        Returns the execution's parent analysis, or null if the execution was not created by a analysis.
        Returns:
        parent analysis or null

      • getParentJob

        public DXJob getParentJob()
        Returns the execution's parent job, or null if the execution was not created by a job.
        Returns:
        parent job or null

      • getProject

        public DXProject getProject()
        Returns the project in which this execution was run.
        Returns:
        project

      • getProperties

        public Map<String,​String> getProperties()
        Returns the properties associated with the execution.
        Returns:
        Map of property keys and values

      • getRootExecution

        public DXExecution getRootExecution()
        Returns the execution at the root of the execution tree (the job or analysis that was created by a user's external API call rather than by a job or run as a stage in an analysis).
        Returns:
        root execution

      • getRunInput

        public <T> T getRunInput​(Class<T> inputClass)
        Returns the raw input of the execution, deserialized to the specified class. This is the input as supplied to the executable "run" call.

        Note that this input may contain job-based object references, which may require special deserialization code in your target class.

        Parameters:
        inputClass - class to deserialize to
        Returns:
        execution's input as supplied to the "run" call

      • getStage

        public String getStage()
        Returns the stage that this execution is associated with, if it was run as a stage in an analysis; null otherwise.
        Returns:
        stage ID

      • getTags

        public List<String> getTags()
        Returns the tags associated with the execution.
        Returns:
        List of tags

      • getTotalPrice

        public double getTotalPrice()
        Returns the total price of the job.
        Returns:
        price in dollars
        Throws:
        IllegalStateException - if the requesting user does not have permission to view the pricing model of the billed entity (billTo), or the price of the execution has not been finalized

      • getWorkspace

        public DXContainer getWorkspace()
        Returns the temporary workspace associated with the execution.
        Returns:
        temporary workspace

      • isWorkspaceDestructionDelayed

        public boolean isWorkspaceDestructionDelayed()
        Returns true if the execution's temporary workspace will be kept around for 3 days after the execution finishes.
        Returns:
        true if the workspace destruction will be delayed
        Throws:
        IllegalStateException - if the execution is a job and is neither an origin job nor master job