Subsections of notebookScheduler

Notebook Finder

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

constructor

Constructor

Parámetros

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

findAll()

Download a complete list of notebooks for the user. This execute a GET http method

Retorna

Tip

Tipo: Promise

Notebook Launcher

This is the base object for everything you can do with a notebook launcher.

constructor

Constructor

Parámetros

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

generateReport(generateReport)

Sets the generateReport attribute

Parámetros

Nombre Tipo Opcional Descripción
generateReport boolean ❌

Retorna

Tip

Tipo: NotebookLauncher

withIdentifier(identifier)

Sets the identifier attribute

Parámetros

Nombre Tipo Opcional Descripción
identifier string ❌

Retorna

Tip

Tipo: NotebookLauncher

withReportRetentionDays(reportRetentionDays)

Sets the reportRetentionDays attribute

Parámetros

Nombre Tipo Opcional Descripción
reportRetentionDays number ❌

Retorna

Tip

Tipo: NotebookLauncher

Notebook Scheduler

This is the base object for everything you can do with a notebook scheduler.

constructor

Constructor

Parámetros

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

generateReport(generateReport)

Sets the generateReport attribute

Parámetros

Nombre Tipo Opcional Descripción
generateReport boolean ❌

Retorna

Tip

Tipo: NotebookScheduler

withCronPattern(cronPattern)

Sets the crontab pattern

Parámetros

Nombre Tipo Opcional Descripción
cronPattern string ❌

Retorna

Tip

Tipo: NotebookScheduler

withIdentifier(identifier)

Sets the identifier attribute

Parámetros

Nombre Tipo Opcional Descripción
identifier string ❌

Retorna

Tip

Tipo: NotebookScheduler

withNotebookId(notebookId)

Sets the notebookId attribute

Parámetros

Nombre Tipo Opcional Descripción
notebookId string ❌

Retorna

Tip

Tipo: NotebookScheduler

withReportRetentionDays(reportRetentionDays)

Sets the reportRetentionDays attribute

Parámetros

Nombre Tipo Opcional Descripción
reportRetentionDays number ❌

Retorna

Tip

Tipo: NotebookScheduler

Scheduler Finder

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

constructor

Constructor

Parámetros

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

findAll()

Download a complete list of notebook schedulers for the user. This execute a GET http method

Retorna

Tip

Tipo: Promise