Class StageController

Hierarchy

StageController

Implements

Controller

Constructors

constructor

new StageController(context: PipelineContext, name: string, jobs: JobController[]): StageController
Parameters
- context: PipelineContext
- name: string
- jobs: JobController[]
Returns StageController
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:52

Properties

`Private` `Readonly` _changedCallback

_changedCallback: ((event: string, job: JobController) => void)

Type declaration

- (event: string, job: JobController): void
- Parameters
  - event: string
  - job: JobController
  Returns void

`Private` `Readonly` _context

_context: PipelineContext

`Private` _jobDestructors

_jobDestructors: ObserverDestructor[]

`Private` `Readonly` _jobs

_jobs: JobController[]

`Private` `Readonly` _name

_name: string

`Private` `Readonly` _observer

_observer: Observer<StageControllerEvent>

`Private` _state

_state: ControllerState

`Static` Event

Event: typeof StageControllerEvent = StageControllerEvent

Methods

`Private` _onChanged

_onChanged(event: string, eventJob: JobController): void
Parameters
- event: string
- eventJob: JobController
Returns void
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:446

destroy

destroy(): void
Returns void
Implementation of Controller.destroy
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:83

getContext

getContext(): PipelineContext
Returns PipelineContext
Implementation of Controller.getContext
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:71

getErrorString

getErrorString(): string
Returns string
Implementation of Controller.getErrorString
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:437

getName

getName(): string
Returns string
Implementation of Controller.getName
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:79

getOutputString

getOutputString(): string
Returns string
Implementation of Controller.getOutputString
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:441

getState

getState(): ControllerState
Returns ControllerState
Implementation of Controller.getState
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:75

getStateDTO

getStateDTO(): StageControllerStateDTO
Returns StageControllerStateDTO
Implementation of Controller.getStateDTO
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:98

isCancelled

isCancelled(): boolean
Returns boolean
Implementation of Controller.isCancelled
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:114

isFailed

isFailed(): boolean
Returns boolean
Implementation of Controller.isFailed
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:131

isFinished

isFinished(): boolean
Returns boolean
Implementation of Controller.isFinished
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:148

isPaused

isPaused(): boolean
Returns boolean
Implementation of Controller.isPaused
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:165

isRunning

isRunning(): boolean
Returns boolean
Implementation of Controller.isRunning
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:182

isStarted

isStarted(): boolean
Returns boolean
Implementation of Controller.isStarted
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:199

isSuccessful

isSuccessful(): boolean
Returns boolean
Implementation of Controller.isSuccessful
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:216

on

on(name: StageControllerEvent, callback: ObserverCallback<StageControllerEvent, any[]>): ObserverDestructor
Parameters
- name: StageControllerEvent
- callback: ObserverCallback<StageControllerEvent, any[]>
Returns ObserverDestructor
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:87

onCancelled

onCancelled(callback: ObserverCallback<string, [StageController]>): ObserverDestructor
Parameters
- callback: ObserverCallback<string, [StageController]>
Returns ObserverDestructor
Implementation of Controller.onCancelled
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:233

onChanged

onChanged(callback: ObserverCallback<string, [StageController]>): ObserverDestructor
Parameters
- callback: ObserverCallback<string, [StageController]>
Returns ObserverDestructor
Implementation of Controller.onChanged
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:237

onFailed

onFailed(callback: ObserverCallback<string, [StageController]>): ObserverDestructor
Parameters
- callback: ObserverCallback<string, [StageController]>
Returns ObserverDestructor
Implementation of Controller.onFailed
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:241

onFinished

onFinished(callback: ObserverCallback<string, [StageController]>): ObserverDestructor
Parameters
- callback: ObserverCallback<string, [StageController]>
Returns ObserverDestructor
Implementation of Controller.onFinished
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:245

onPaused

onPaused(callback: ObserverCallback<string, [StageController]>): ObserverDestructor
Parameters
- callback: ObserverCallback<string, [StageController]>
Returns ObserverDestructor
Implementation of Controller.onPaused
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:249

onResumed

onResumed(callback: ObserverCallback<string, [StageController]>): ObserverDestructor
Parameters
- callback: ObserverCallback<string, [StageController]>
Returns ObserverDestructor
Implementation of Controller.onResumed
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:253

onStarted

onStarted(callback: ObserverCallback<string, [StageController]>): ObserverDestructor
Parameters
- callback: ObserverCallback<string, [StageController]>
Returns ObserverDestructor
Implementation of Controller.onStarted
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:257

pause

pause(): Controller
Returns Controller
Implementation of Controller.pause
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:305

resume

resume(): Controller
Returns Controller
Implementation of Controller.resume
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:347

start

start(): Controller
Returns Controller
Implementation of Controller.start
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:261

stop

stop(): Controller
Returns Controller
Implementation of Controller.stop
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:389

toJSON

toJSON(): JsonAny
Returns JsonAny
Implementation of Controller.toJSON
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:107

toString

toString(): string
Returns string
Implementation of Controller.toString
- Defined in fi/hg/pipeline/controllers/stage/StageController.ts:94

Generated using TypeDoc