Skip to content

workflow.v1alpha1.workflowStep

"WorkflowStep is a reference to a template to execute in a series of step"

Index

Fields

fn withHooks

withHooks(hooks)

"Hooks holds the lifecycle hook which is invoked at lifecycle of step, irrespective of the success, failure, or error status of the primary step"

fn withHooksMixin

withHooksMixin(hooks)

"Hooks holds the lifecycle hook which is invoked at lifecycle of step, irrespective of the success, failure, or error status of the primary step"

Note: This function appends passed data to existing values

fn withName

withName(name)

"Name of the step"

fn withOnExit

withOnExit(onExit)

"OnExit is a template reference which is invoked at the end of the template, irrespective of the success, failure, or error of the primary template. DEPRECATED: Use Hooks[exit].Template instead."

fn withTemplate

withTemplate(template)

"Template is the name of the template to execute as the step"

fn withWhen

withWhen(when)

"When is an expression in which the step should conditionally execute"

fn withWithItems

withWithItems(withItems)

"WithItems expands a step into multiple parallel steps from the items in the list"

fn withWithItemsMixin

withWithItemsMixin(withItems)

"WithItems expands a step into multiple parallel steps from the items in the list"

Note: This function appends passed data to existing values

fn withWithParam

withWithParam(withParam)

"WithParam expands a step into multiple parallel steps from the value in the parameter, which is expected to be a JSON list."

obj arguments

"Arguments to a template"

fn arguments.withArtifacts

withArtifacts(artifacts)

"Artifacts is the list of artifacts to pass to the template or workflow"

fn arguments.withArtifactsMixin

withArtifactsMixin(artifacts)

"Artifacts is the list of artifacts to pass to the template or workflow"

Note: This function appends passed data to existing values

fn arguments.withParameters

withParameters(parameters)

"Parameters is the list of parameters to pass to the template or workflow"

fn arguments.withParametersMixin

withParametersMixin(parameters)

"Parameters is the list of parameters to pass to the template or workflow"

Note: This function appends passed data to existing values

obj continueOn

"ContinueOn defines if a workflow should continue even if a task or step fails/errors. It can be specified if the workflow should continue when the pod errors, fails or both."

fn continueOn.withError

withError(err)

fn continueOn.withFailed

withFailed(failed)

obj templateRef

"TemplateRef is a reference of template resource."

fn templateRef.withClusterScope

withClusterScope(clusterScope)

"ClusterScope indicates the referred template is cluster scoped (i.e. a ClusterWorkflowTemplate)."

fn templateRef.withName

withName(name)

"Name is the resource name of the template."

fn templateRef.withTemplate

withTemplate(template)

"Template is the name of referred template in the resource."

obj withSequence

"Sequence expands a workflow step into numeric range"

fn withSequence.withCount

withCount(count)

fn withSequence.withEnd

withEnd(end)

fn withSequence.withFormat

withFormat(format)

"Format is a printf format string to format the value in the sequence"

fn withSequence.withStart

withStart(start)