Subsections of schedule

History Finder

This class allows making GET requests to the planner resource of the OpenGate North API.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

findByOrganization(organization)

Download a complete list of scheduler history for the organization. This execute a GET http method

Retorna

Tip

Tipo: Promise

findByOrganizationAndSchedulerId(organization, schedulerId)

Download a complete list of scheduler history for the organization and type selected. This execute a GET http method

Retorna

Tip

Tipo: Promise

findByOrganizationAndType(organization, type)

Download a complete list of scheduler history for the organization and type selected. This execute a GET http method

Retorna

Tip

Tipo: Promise

withLimit(limit)

Marks results limit

Retorna

Tip

Tipo: this

withSchedulerId(schedulerId)

Set parameter schedulerIds

Retorna

Tip

Tipo: this

withSchedulerType(schedulerType)

Set parameter schedulerIds

Retorna

Tip

Tipo: this

Image Execution

This is a base object that represents an image execution step within a scheduled pipeline.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

withEnvFrom(imageExecutionEnvFrom)

Sets the env from for imageExecution

Parámetros

Nombre Tipo Opcional Descripción
imageExecutionEnvFrom array ❌

Retorna

Tip

Tipo: ImageExecution

withEnvVars(imageExecutionEnvVars)

Sets the env vars for imageExecution

Parámetros

Nombre Tipo Opcional Descripción
imageExecutionEnvVars object ❌

Retorna

Tip

Tipo: ImageExecution

withIdentifier(identifier)

Sets the identifier attribute

Parámetros

Nombre Tipo Opcional Descripción
identifier string ❌

Retorna

Tip

Tipo: ImageExecution

withMaxTimeToWaitCallback(asyncResponseMaxTimeToWaitCallback)

Sets the async response with selected timeout

Parámetros

Nombre Tipo Opcional Descripción
asyncResponseMaxTimeToWaitCallback string ❌

Retorna

Tip

Tipo: ImageExecution

withName(imageExecutionName)

Sets the name for imageExecution

Parámetros

Nombre Tipo Opcional Descripción
imageExecutionName string ❌

Retorna

Tip

Tipo: ImageExecution

withOrganization(organization)

Set the organization attribute

Parámetros

Nombre Tipo Opcional Descripción
organization string ❌

Retorna

Tip

Tipo: ImageExecution

withScheduleCronExpression(cronExpression, timezone)

Sets the crontab expression for schedule

Parámetros

Nombre Tipo Opcional Descripción
cronExpression string ❌
timezone string ❌

Retorna

Tip

Tipo: ImageExecution

withScheduleExecuteNow(executeNow)

Sets the executeNow attribute

Parámetros

Nombre Tipo Opcional Descripción
executeNow boolean ❌

Retorna

Tip

Tipo: ImageExecution

withScheduleFrom(from)

Sets the from attribute

Parámetros

Nombre Tipo Opcional Descripción
from string ❌

Retorna

Tip

Tipo: ImageExecution

withScheduleMinutesInterval(interval)

Sets the interval for schedule in minutes

Parámetros

Nombre Tipo Opcional Descripción
interval number ❌ in minutes

Retorna

Tip

Tipo: ImageExecution

withScheduleTo(to)

Sets the to attribute

Parámetros

Nombre Tipo Opcional Descripción
to string ❌

Retorna

Tip

Tipo: ImageExecution

withTag(imageExecutionTag)

Sets the tag for imageExecution

Parámetros

Nombre Tipo Opcional Descripción
imageExecutionTag string ❌

Retorna

Tip

Tipo: ImageExecution

withTimeout(timeout)

Sets the execution timeout for imageExecution

Parámetros

Nombre Tipo Opcional Descripción
timeout string ❌

Retorna

Tip

Tipo: ImageExecution

Image Execution Finder

This class allows making GET requests to the planner resource of the OpenGate North API.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

findByOrganization(organization)

Download a complete list of image executions for the organization. This executes a GET HTTP method.

Retorna

Tip

Tipo: Promise

Pipeline

This is a base object that represents a pipeline of image executions and REST requests to run on a schedule.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

addImageExecution(imageExecution)

Adds an Image Execution to the pipeline

Parámetros

Nombre Tipo Opcional Descripción
imageExecution ImageExecution ❌

Retorna

Tip

Tipo: Pipeline

addRestResquest(restRequest)

Adds a rest request to the pipeline

Parámetros

Nombre Tipo Opcional Descripción
restRequest RestRequest ❌

Retorna

Tip

Tipo: Pipeline

withIdentifier(identifier)

Sets the identifier attribute

Parámetros

Nombre Tipo Opcional Descripción
identifier string ❌

Retorna

Tip

Tipo: Pipeline

withOrganization(organization)

Set the organization attribute

Parámetros

Nombre Tipo Opcional Descripción
organization string ❌

Retorna

Tip

Tipo: Pipeline

withScheduleCronExpression(cronExpression, timezone)

Sets the crontab expression for schedule

Parámetros

Nombre Tipo Opcional Descripción
cronExpression string ❌
timezone string ❌

Retorna

Tip

Tipo: Pipeline

withScheduleExecuteNow(executeNow)

Sets the executeNow attribute

Parámetros

Nombre Tipo Opcional Descripción
executeNow boolean ❌

Retorna

Tip

Tipo: Pipeline

withScheduleFrom(from)

Sets the from attribute

Parámetros

Nombre Tipo Opcional Descripción
from string ❌

Retorna

Tip

Tipo: Pipeline

withScheduleMinutesInterval(interval)

Sets the interval for schedule in minutes

Parámetros

Nombre Tipo Opcional Descripción
interval number ❌ in minutes

Retorna

Tip

Tipo: Pipeline

withScheduleTo(to)

Sets the to attribute

Parámetros

Nombre Tipo Opcional Descripción
to string ❌

Retorna

Tip

Tipo: Pipeline

Pipeline Finder

This class allows making GET requests to the planner resource of the OpenGate North API.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

findByOrganization(organization)

Download a complete list of pipelines for the organization. This executes a GET HTTP method.

Retorna

Tip

Tipo: Promise

Rest Request

This is a base object that represents a REST request to run on a schedule.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

withAsyncResponseMaxTimeToWaitCallback(asyncResponseMaxTimeToWaitCallback)

Sets the async response with selected timeout

Parámetros

Nombre Tipo Opcional Descripción
asyncResponseMaxTimeToWaitCallback string ❌

Retorna

Tip

Tipo: RestRequest

withBody(restRequestBody)

Sets the body for restRequest

Parámetros

Nombre Tipo Opcional Descripción
restRequestBody string ❌

Retorna

Tip

Tipo: RestRequest

withHeaders(restRequestHeaders)

Sets the header for restRequest

Parámetros

Nombre Tipo Opcional Descripción
restRequestHeaders string ❌

Retorna

Tip

Tipo: RestRequest

withIdentifier(identifier)

Sets the identifier attribute

Parámetros

Nombre Tipo Opcional Descripción
identifier string ❌

Retorna

Tip

Tipo: RestRequest

withMethod(restRequestMethod)

Sets the method for restRequest

Parámetros

Nombre Tipo Opcional Descripción
restRequestMethod string ❌

Retorna

Tip

Tipo: RestRequest

withOrganization(organization)

Set the organization attribute

Parámetros

Nombre Tipo Opcional Descripción
organization string ❌

Retorna

Tip

Tipo: RestRequest

withScheduleCronExpression(cronExpression, timezone)

Sets the crontab expression for schedule

Parámetros

Nombre Tipo Opcional Descripción
cronExpression string ❌
timezone string ❌

Retorna

Tip

Tipo: RestRequest

withScheduleExecuteNow(executeNow)

Sets the executeNow attribute

Parámetros

Nombre Tipo Opcional Descripción
executeNow boolean ❌

Retorna

Tip

Tipo: RestRequest

withScheduleFrom(from)

Sets the from attribute

Parámetros

Nombre Tipo Opcional Descripción
from string ❌

Retorna

Tip

Tipo: RestRequest

withScheduleMinutesInterval(interval)

Sets the interval for schedule in minutes

Parámetros

Nombre Tipo Opcional Descripción
interval number ❌ in minutes

Retorna

Tip

Tipo: RestRequest

withScheduleTo(to)

Sets the to attribute

Parámetros

Nombre Tipo Opcional Descripción
to string ❌

Retorna

Tip

Tipo: RestRequest

withSyncResponseTimeout(syncResponseTimeout)

Sets the sync response with selected timeout

Parámetros

Nombre Tipo Opcional Descripción
syncResponseTimeout string ❌

Retorna

Tip

Tipo: RestRequest

withUrl(restRequestUrl)

Sets the url for restRequest

Parámetros

Nombre Tipo Opcional Descripción
restRequestUrl string ❌

Retorna

Tip

Tipo: RestRequest

Rest Request Finder

This class allows making GET requests to the planner resource of the OpenGate North API.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

findByOrganization(organization)

Download a complete list of REST requests for the organization. This executes a GET HTTP method.

Retorna

Tip

Tipo: Promise

Schedule History Finder

This class allows making GET requests to the planner resource of the OpenGate North API.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

findByOrganization(organization)

Download a complete list of scheduler history for the organization. This execute a GET http method

Retorna

Tip

Tipo: Promise

findByOrganizationAndType(organization, type)

Download a complete list of scheduler history for the organization. This execute a GET http method

Retorna

Tip

Tipo: Promise