import Pipeline from 'opengate-js/src/schedule/Pipeline.js'

public class | source

Pipeline

Extends:

BaseProvision → Pipeline

This is a base object that contains all you can do about Bundles.

Constructor Summary

Public Constructor
public	constructor(Reference: InternalOpenGateAPI) Constructor

Method Summary

Public Methods
public	addImageExecution(imageExecution: ImageExecution): Pipeline Adds an Image Execution to the pipeline
public	addRestResquest(restRequest: RestRequest): Pipeline Adds a rest request to the pipeline
public	toJson(): *
public	update()
public	withIdentifier(identifier: string): Pipeline Sets the identifier attribute
public	withOrganization(organization: string): Channels Set the organization attribute
public	withScheduleCronExpression(cronExpression: string): Pipeline Sets the crontab expression for schedule
public	withScheduleImmediateExecution(isImmediateExecution: boolean): Pipeline Sets the isImmediateExecution attribute for schedule

Inherited Summary

From class BaseProvision
public	create(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function create a entity of provision
public	delete(body: *): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function deletes a entity of provision
public	update(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function updates a entity of provision

Public Constructors

public constructor(Reference: InternalOpenGateAPI) source

Constructor

Override:

BaseProvision#constructor

Params:

Name	Type	Attribute	Description
Reference	InternalOpenGateAPI		to the API object.

Public Methods

public addImageExecution(imageExecution: ImageExecution): Pipeline source

Adds an Image Execution to the pipeline

Params:

Name	Type	Attribute	Description
imageExecution	ImageExecution

Return:

Pipeline

public addRestResquest(restRequest: RestRequest): Pipeline source

Adds a rest request to the pipeline

Params:

Name	Type	Attribute	Description
restRequest	RestRequest

Return:

Pipeline

public toJson(): * source

Return:

public update() source

This invoke a request to OpenGate North API and the callback is managed by promises This function updates a entity of provision

Override:

BaseProvision#update

public withIdentifier(identifier: string): Pipeline source

Sets the identifier attribute

Params:

Name	Type	Attribute	Description
identifier	string

Return:

Pipeline

public withOrganization(organization: string): Channels source

Set the organization attribute

Params:

Name	Type	Attribute	Description
organization	string

Return:

Channels

public withScheduleCronExpression(cronExpression: string): Pipeline source

Sets the crontab expression for schedule

Params:

Name	Type	Attribute	Description
cronExpression	string

Return:

Pipeline

public withScheduleImmediateExecution(isImmediateExecution: boolean): Pipeline source

Sets the isImmediateExecution attribute for schedule

Params:

Name	Type	Attribute	Description
isImmediateExecution	boolean

Return:

Pipeline