Property Detail

• java.lang.String commandLine

  Command line as enter by the user to launch the workflow execution

• java.lang.String commitId

  Git commit ID of the executed repository

• java.util.Date complete

  Timestamp at workflow execution complete

• java.lang.Object container

  Docker image used to run workflow tasks. It report the docker image defined in the pipeline configuration. When more than an image is used it returns a java.util.Map object containing (process name, image name) pair entries.

• nextflow.util.Duration duration

  Time elapsed to complete workflow execution

• java.lang.String errorMessage

  Error message of the task that caused the workflow execution to fail

• java.lang.String errorReport

  Detailed error of the task that caused the workflow execution to fail

• java.lang.Integer exitStatus

  The exit status of the task that caused the workflow execution to fail

• java.nio.file.Path launchDir

  Directory where workflow execution has been launched

• java.util.Map nextflow

  Nextflow runtime info, it includes the following entries:

• version: runtime version number
• build: runtime build number
• timestamp: runtime compile timestamp

• java.lang.String profile

  The used configuration profile

• java.nio.file.Path projectDir

  Directory where workflow project is store on the computer

• java.lang.String repository

  Project repository Git remote URL

• boolean resume

  Returns ``true`` whenever the current instance is resumed from a previous execution

• java.lang.String revision

  Git branch/tag of the executed repository

• java.lang.String runName

  Run name

• java.nio.file.Path scriptFile

  The main script file path

• java.lang.String scriptId

  The script unique hash key

• java.lang.String scriptName

  The main script name

• java.util.UUID sessionId

  The current sessionId

• java.util.Date start

  Timestamp at workflow execution start

• boolean success

  Reports if the execution completed successfully

• java.nio.file.Path workDir

  Workflow working directory

Constructor Detail

• WorkflowMetadata(ScriptRunner owner)

  Initialise the available workflow properties

  Parameters:

  owner - An instance of ScriptRunner

Method Detail

• void invokeOnError(java.lang.Object trace)

• void onComplete(groovy.lang.Closure action)

  Implements the following idiom in the pipeline script:

       workflow.onComplete {
           // do something
       }
   

  Parameters:

  action - The action handler

• void onError(groovy.lang.Closure action)

  Implements the following idiom in the pipeline script:

       workflow.onError {
           // do something
       }
   

  Parameters:

  action

• void setOnComplete(groovy.lang.Closure action)

  Implements the following idiom in the pipeline script:

       workflow.onComplete = {
           // do something
       }
   

  Parameters:

  action - The action handler

• void setOnError(groovy.lang.Closure action)

  Implements the following idiom in the pipeline script:

       workflow.onError = {
           // do something
       }
   

  Parameters:

  action - The action handler

• java.lang.String toString()

  Returns:

  Render the workflow properties