The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

WFA::Workflow - A workflow object, representing a single WFA workflow

METHODS

my $workflow_name = $workflow->name()

Get the name of the workflow.

my $workflow_version = $workflow->version()

Get the version of the workflow in the form $major.$minor.$revision.

my $workflow_description = $workflow->description()

Get the description of the workflow.

my $workflow_uuid = $workflow->uuid()

Get the uuid of the workflow. This unique identifier is assigned server-side and is often used in the URLs of the REST api.

my %workflow_parameters = $workflow->parameters()

Get the parameters accepted by this workflow during execution. Example:

(
  Parameter1 => {
    type        => 'String',
    description => 'Some parameter',
    mandatory   => 'true',
  },
  Parameter2 => {
    type        => 'String',
    description => 'Some parameter',
    mandatory   => 'false',
  },
)

my $job = $workflow->execute(%parameters)

Execute the workflow with the given parameters. This returns a WFA::Job object which can be used to poll the job status.

%parameters

Parameters for the job. Example:

(
  Parameter1 => 'value1',
  Parameter2 => 'value2',
)