Class WorkflowJobAbstract Abstract

Assign Parameters and Filters to a Job within a Workflow. Utility class for assigning parameters to a job. Should only be instantiated for specific use cases.

see: Workflow.addJob for general use.

Hierarchy

WorkflowJobAbstract
- WorkflowJob
- WorkflowJobApproval

Implements

Generable

Index

Constructors

constructor

Properties

parameters

Accessors

Methods

Constructors

constructor

new WorkflowJobAbstract(parameters?: WorkflowJobParameters): WorkflowJobAbstract

- Defined in src/lib/Components/Workflow/exports/WorkflowJobAbstract.ts:21
Parameters
- Optional parameters: WorkflowJobParameters
Returns WorkflowJobAbstract

Properties

Optional parameters

parameters?: WorkflowJobParameters = {}

Accessors

generableType

get generableType(): GenerableType

Implementation of Generable.generableType
- Defined in src/lib/Components/Workflow/exports/WorkflowJobAbstract.ts:50
Returns GenerableType

Abstract name

get name(): string

- Defined in src/lib/Components/Workflow/exports/WorkflowJobAbstract.ts:61
Returns string

Methods

Abstract generate

generate(flatten?: boolean): WorkflowJobShape

Implementation of Generable.generate
- Defined in src/lib/Components/Workflow/exports/WorkflowJobAbstract.ts:62
Parameters
- Optional flatten: boolean
Returns WorkflowJobShape

generateContents

generateContents(flatten?: boolean): WorkflowJobContentsShape

Implementation of Generable.generateContents
- Defined in src/lib/Components/Workflow/exports/WorkflowJobAbstract.ts:26
Parameters
- Optional flatten: boolean
Returns WorkflowJobContentsShape

Private generateSteps

generateSteps(steps?: StepsParameter, flatten?: boolean): undefined | AnyCommandShape[]

- Defined in src/lib/Components/Workflow/exports/WorkflowJobAbstract.ts:54
Parameters
- Optional steps: StepsParameter
- Optional flatten: boolean
Returns undefined | AnyCommandShape[]

Generated using TypeDoc