Pipeline
Extends:
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(): {"identifier": *, "schedule": *, "pipeline": *} |
|
| public |
update() |
|
| public |
withIdentifier(identifier: string): Pipeline Sets the identifier attribute |
|
| public |
withOrganization(organization: string): Pipeline Set the organization attribute |
|
| public |
withScheduleCronExpression(cronExpression: string): Pipeline Sets the crontab expression for schedule |
|
| public |
withScheduleExecuteNow(executeNow: boolean): Pipeline Sets the executeNow attribute |
|
| public |
withScheduleFrom(from: string): Pipeline Sets the from attribute |
|
| public |
withScheduleMinutesInterval(interval: number): Pipeline Sets the interval for schedule in minutes |
|
| public |
withScheduleTo(to: string): Pipeline Sets the to attribute |
|
Inherited Summary
| From class BaseProvision | ||
| public |
This invoke a request to OpenGate North API and the callback is managed by promises This function create a entity of provision |
|
| public |
This invoke a request to OpenGate North API and the callback is managed by promises This function deletes a entity of provision |
|
| public |
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#constructorParams:
| 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 |
public addRestResquest(restRequest: RestRequest): Pipeline source
Adds a rest request to the pipeline
Params:
| Name | Type | Attribute | Description |
| restRequest | RestRequest |
public toJson(): {"identifier": *, "schedule": *, "pipeline": *} source
Return:
| {"identifier": *, "schedule": *, "pipeline": *} |
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#updatepublic withIdentifier(identifier: string): Pipeline source
Sets the identifier attribute
Params:
| Name | Type | Attribute | Description |
| identifier | string |
public withOrganization(organization: string): Pipeline source
Set the organization attribute
Params:
| Name | Type | Attribute | Description |
| organization | string |
public withScheduleCronExpression(cronExpression: string): Pipeline source
Sets the crontab expression for schedule
Params:
| Name | Type | Attribute | Description |
| cronExpression | string |
public withScheduleExecuteNow(executeNow: boolean): Pipeline source
Sets the executeNow attribute
Params:
| Name | Type | Attribute | Description |
| executeNow | boolean |
public withScheduleFrom(from: string): Pipeline source
Sets the from attribute
Params:
| Name | Type | Attribute | Description |
| from | string |