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

public class | source

ImageExecution

Extends:

BaseProvision → ImageExecution

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(): *
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	withScheduleImmediateExecution(isImmediateExecution: boolean): ImageExecution Sets the isImmediateExecution attribute for schedule
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	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 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 withEnvFrom(imageExecutionEnvFrom: array): ImageExecution source

Sets the env from for imageExecution

Params:

Name	Type	Attribute	Description
imageExecutionEnvFrom	array

Return:

ImageExecution

public withEnvVars(imageExecutionEnvVars: object): ImageExecution source

Sets the env vars for imageExecution

Params:

Name	Type	Attribute	Description
imageExecutionEnvVars	object

Return:

ImageExecution

public withIdentifier(identifier: string): ImageExecution source

Sets the identifier attribute

Params:

Name	Type	Attribute	Description
identifier	string

Return:

ImageExecution

public withMaxTimeToWaitCallback(asyncResponseMaxTimeToWaitCallback: string): ImageExecution source

Sets the async response with selected timeout

Params:

Name	Type	Attribute	Description
asyncResponseMaxTimeToWaitCallback	string

Return:

ImageExecution

public withName(imageExecutionName: string): ImageExecution source

Sets the name for imageExecution

Params:

Name	Type	Attribute	Description
imageExecutionName	string

Return:

ImageExecution

public withOrganization(organization: string): Channels source

Set the organization attribute

Params:

Name	Type	Attribute	Description
organization	string

Return:

Channels

public withScheduleCronExpression(cronExpression: string): ImageExecution source

Sets the crontab expression for schedule

Params:

Name	Type	Attribute	Description
cronExpression	string

Return:

ImageExecution

public withScheduleImmediateExecution(isImmediateExecution: boolean): ImageExecution source

Sets the isImmediateExecution attribute for schedule

Params:

Name	Type	Attribute	Description
isImmediateExecution	boolean

Return:

ImageExecution

public withTag(imageExecutionTag: string): ImageExecution source

Sets the tag for imageExecution

Params:

Name	Type	Attribute	Description
imageExecutionTag	string

Return:

ImageExecution

public withTimeout(timeout: string): ImageExecution source

Sets the execution timeout for imageExecution

Params:

Name	Type	Attribute	Description
timeout	string

Return:

ImageExecution