import NotebookScheduler from 'opengate-js/src/notebookScheduler/NotebookScheduler.js'

public class | source

NotebookScheduler

Extends:

BaseProvision → NotebookScheduler

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	create(): *
public	generateReport(generateReport: boolean): NotebookScheduler Sets the generateReport attribute
public	update()
public	withCronPattern(cronPattern: string): NotebookScheduler Sets the crontab pattern
public	withIdentifier(identifier: string): NotebookScheduler Sets the identifier attribute
public	withNotebookId(notebookId: string): NotebookScheduler Sets the notebookId attribute
public	withParams(params: ):
public	withReportRetentionDays(reportRetentionDays: number): NotebookScheduler Sets the reportRetentionDays attribute

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 create(): * source

This invoke a request to OpenGate North API and the callback is managed by promises This function create a entity of provision

Override:

BaseProvision#create

Return:

public generateReport(generateReport: boolean): NotebookScheduler source

Sets the generateReport attribute

Params:

Name	Type	Attribute	Description
generateReport	boolean

Return:

NotebookScheduler

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 withCronPattern(cronPattern: string): NotebookScheduler source

Sets the crontab pattern

Params:

Name	Type	Attribute	Description
cronPattern	string

Return:

NotebookScheduler

public withIdentifier(identifier: string): NotebookScheduler source

Sets the identifier attribute

Params:

Name	Type	Attribute	Description
identifier	string

Return:

NotebookScheduler

public withNotebookId(notebookId: string): NotebookScheduler source

Sets the notebookId attribute

Params:

Name	Type	Attribute	Description
notebookId	string

Return:

NotebookScheduler

public withParams(params: ): source

Params:

Name	Type	Attribute	Description
params	*

Return:

public withReportRetentionDays(reportRetentionDays: number): NotebookScheduler source

Sets the reportRetentionDays attribute

Params:

Name	Type	Attribute	Description
reportRetentionDays	number

Return:

NotebookScheduler

NotebookScheduler

Extends:

Constructor Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(Reference: InternalOpenGateAPI) source

Override:

Params:

Public Methods

public create(): * source

Override:

Return:

public generateReport(generateReport: boolean): NotebookScheduler source

Params:

Return:

public update() source

Override:

public withCronPattern(cronPattern: string): NotebookScheduler source

Params:

Return:

public withIdentifier(identifier: string): NotebookScheduler source

Params:

Return:

public withNotebookId(notebookId: string): NotebookScheduler source

Params:

Return:

public withParams(params: *): * source

Params:

Return:

public withReportRetentionDays(reportRetentionDays: number): NotebookScheduler source

Params:

Return:

public withParams(params: ): source