ImageExecution
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 |
toJson(): {"identifier": *, "schedule": *, "imageExecution": *, "maxTimeToWaitCallback": *} |
|
| public |
update() |
|
| public |
withEnvFrom(imageExecutionEnvFrom: array): ImageExecution Sets the env from for imageExecution |
|
| public |
withEnvVars(imageExecutionEnvVars: object): ImageExecution Sets the env vars for imageExecution |
|
| public |
withIdentifier(identifier: string): ImageExecution Sets the identifier attribute |
|
| public |
withMaxTimeToWaitCallback(asyncResponseMaxTimeToWaitCallback: string): ImageExecution Sets the async response with selected timeout |
|
| public |
withName(imageExecutionName: string): ImageExecution Sets the name for imageExecution |
|
| public |
withOrganization(organization: string): Channels Set the organization attribute |
|
| public |
withScheduleCronExpression(cronExpression: string): ImageExecution Sets the crontab expression for schedule |
|
| public |
withScheduleExecuteNow(executeNow: boolean): ImageExecution Sets the executeNow attribute |
|
| public |
withScheduleFrom(from: string): ImageExecution Sets the from attribute |
|
| public |
withScheduleMinutesInterval(interval: number): ImageExecution Sets the interval for schedule in minutes |
|
| public |
Sets the to attribute |
|
| public |
withTag(imageExecutionTag: string): ImageExecution Sets the tag for imageExecution |
|
| public |
withTimeout(timeout: string): ImageExecution Sets the execution timeout for imageExecution |
|
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 toJson(): {"identifier": *, "schedule": *, "imageExecution": *, "maxTimeToWaitCallback": *} source
Return:
| {"identifier": *, "schedule": *, "imageExecution": *, "maxTimeToWaitCallback": *} |
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 withEnvFrom(imageExecutionEnvFrom: array): ImageExecution source
Sets the env from for imageExecution
Params:
| Name | Type | Attribute | Description |
| imageExecutionEnvFrom | array |
public withEnvVars(imageExecutionEnvVars: object): ImageExecution source
Sets the env vars for imageExecution
Params:
| Name | Type | Attribute | Description |
| imageExecutionEnvVars | object |
public withIdentifier(identifier: string): ImageExecution source
Sets the identifier attribute
Params:
| Name | Type | Attribute | Description |
| identifier | string |
public withMaxTimeToWaitCallback(asyncResponseMaxTimeToWaitCallback: string): ImageExecution source
Sets the async response with selected timeout
Params:
| Name | Type | Attribute | Description |
| asyncResponseMaxTimeToWaitCallback | string |
public withName(imageExecutionName: string): ImageExecution source
Sets the name for imageExecution
Params:
| Name | Type | Attribute | Description |
| imageExecutionName | string |
public withOrganization(organization: string): Channels source
Set the organization attribute
Params:
| Name | Type | Attribute | Description |
| organization | string |
public withScheduleCronExpression(cronExpression: string): ImageExecution source
Sets the crontab expression for schedule
Params:
| Name | Type | Attribute | Description |
| cronExpression | string |
public withScheduleExecuteNow(executeNow: boolean): ImageExecution source
Sets the executeNow attribute
Params:
| Name | Type | Attribute | Description |
| executeNow | boolean |
public withScheduleFrom(from: string): ImageExecution source
Sets the from attribute
Params:
| Name | Type | Attribute | Description |
| from | string |
public withScheduleMinutesInterval(interval: number): ImageExecution source
Sets the interval for schedule in minutes
Params:
| Name | Type | Attribute | Description |
| interval | number | in minutes |
public withScheduleTo(to: string): ImageExecution source
Sets the to attribute
Params:
| Name | Type | Attribute | Description |
| to | string |
public withTag(imageExecutionTag: string): ImageExecution source
Sets the tag for imageExecution
Params:
| Name | Type | Attribute | Description |
| imageExecutionTag | string |
public withTimeout(timeout: string): ImageExecution source
Sets the execution timeout for imageExecution
Params:
| Name | Type | Attribute | Description |
| timeout | string |