Package org.galaxyproject.gxformat2.v19_09

Interface GalaxyWorkflow

All Superinterfaces:
Documented, HasUUID, Identified, Labeled, Process, Savable
All Known Implementing Classes:
GalaxyWorkflowImpl
public interface GalaxyWorkflow extends Process, HasUUID, Savable
Auto-generated interface for https://galaxyproject.org/gxformat2/v19_09#GalaxyWorkflow
This interface is implemented by GalaxyWorkflowImpl
A Galaxy workflow description. This record corresponds to the description of a workflow that should be executable on a Galaxy server that includes the contained tool definitions.

The workflows API or the user interface of Galaxy instances that are of version 19.09 or newer should be able to import a document defining this record.

## A note about `label` field.

This is the name of the workflow in the Galaxy user interface. This is the mechanism that users will primarily identify the workflow using. Legacy support - this may also be called 'name' and Galaxy will consume the workflow document fine and treat this attribute correctly - however in order to validate against this workflow definition schema the attribute should be called `label`.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getClass_()
    Getter for property https://galaxyproject.org/gxformat2/v19_09#GalaxyWorkflow/class
    Object
    getDoc()
    Getter for property https://w3id.org/cwl/salad#Documented/doc
    A documentation string for this object, or an array of strings which should be concatenated.
    Optional<String>
    getId()
    Getter for property https://w3id.org/cwl/cwl#Identified/id
    The unique identifier for this object.
    List<Object>
    getInputs()
    Getter for property https://w3id.org/cwl/cwl#inputs
    Defines the input parameters of the process.
    Optional<String>
    getLabel()
    Getter for property https://w3id.org/cwl/cwl#Labeled/label
    A short, human-readable label of this object.
    List<Object>
    getOutputs()
    Getter for property https://w3id.org/cwl/cwl#outputs
    Defines the parameters representing the output of the process.
    Optional<Report>
    getReport()
    Getter for property https://galaxyproject.org/gxformat2/v19_09#GalaxyWorkflow/report
    Workflow invocation report template.
    List<Object>
    getSteps()
    Getter for property https://galaxyproject.org/gxformat2/v19_09#GalaxyWorkflow/steps
    The individual steps that make up the workflow.
    Optional<String>
    getUuid()
    Getter for property https://galaxyproject.org/gxformat2/gxformat2common#HasUUID/uuid
    UUID uniquely representing this element.

  • Method Details

    • getId

      Optional<String> getId()
      Getter for property https://w3id.org/cwl/cwl#Identified/id
      The unique identifier for this object. *

    • getLabel

      Optional<String> getLabel()
      Getter for property https://w3id.org/cwl/cwl#Labeled/label
      A short, human-readable label of this object. *
      Specified by:
      getLabel in interface Labeled
      Specified by:
      getLabel in interface Process

    • getDoc

      Object getDoc()
      Getter for property https://w3id.org/cwl/salad#Documented/doc
      A documentation string for this object, or an array of strings which should be concatenated. *
      Specified by:
      getDoc in interface Documented
      Specified by:
      getDoc in interface Process

    • getInputs

      List<Object> getInputs()
      Getter for property https://w3id.org/cwl/cwl#inputs
      Defines the input parameters of the process. The process is ready to run when all required input parameters are associated with concrete values. Input parameters include a schema for each parameter which is used to validate the input object. It may also be used to build a user interface for constructing the input object.

      When accepting an input object, all input parameters must have a value. If an input parameter is missing from the input object, it must be assigned a value of `null` (or the value of `default` for that parameter, if provided) for the purposes of validation and evaluation of expressions. *

      Specified by:
      getInputs in interface Process

    • getOutputs

      List<Object> getOutputs()
      Getter for property https://w3id.org/cwl/cwl#outputs
      Defines the parameters representing the output of the process. May be used to generate and/or validate the output object. *
      Specified by:
      getOutputs in interface Process

    • getUuid

      Optional<String> getUuid()
      Getter for property https://galaxyproject.org/gxformat2/gxformat2common#HasUUID/uuid
      UUID uniquely representing this element. *
      Specified by:
      getUuid in interface HasUUID

    • getClass_

      String getClass_()
      Getter for property https://galaxyproject.org/gxformat2/v19_09#GalaxyWorkflow/class

    • getSteps

      List<Object> getSteps()
      Getter for property https://galaxyproject.org/gxformat2/v19_09#GalaxyWorkflow/steps
      The individual steps that make up the workflow. Each step is executed when all of its input data links are fulfilled. *

    • getReport

      Optional<Report> getReport()
      Getter for property https://galaxyproject.org/gxformat2/v19_09#GalaxyWorkflow/report
      Workflow invocation report template. *