Base Operation Builder

BaseOperationBuilder

BaseOperationBuilder Objects

class BaseOperationBuilder()

Defines the builder to execute an operation that is into catalog

constructor
function constructor()

Constructor

Arguments:

  • ogapi InternalOpenGateAPI - this is configuration about Opengate North API.
  • config object - this is configuration about operation.
appendEntitiesBy
function appendEntitiesBy()

Util used into BaseOperationBuilder to append entities the three different ways. By filter, By tags, By entityList

build
function build() -> 'Operation'

Build a instance of Operation

Returns:

  • Operation

Example:

 ogapi.operations.builderFactory.newXXXBuilder().build()
executeAtDate
function executeAtDate(date: Date,active: boolean) -> 'BaseOperationBuilder,CronExpressionBuilder'

The operation will be created with delayed start or if you not pass any argument then the method return a cron expression builder.

Arguments:

  • date Date
  • active boolean - If active is false, an operation is created in paused

Returns:

  • BaseOperationBuilder,CronExpressionBuilder
executeEach
function executeEach(date: Date,name: string,end: number or Date,active: boolean,description: string) -> 'ExecuteEachBuilder'

The operation will execute with a period that you must define with ExecuteEachBuilder

Arguments:

  • date Date - Date when operation will be executed
  • name string - Name associated to periodicity
  • end number or Date - When periodicity ends. By repetitions or by date
  • active boolean - If active is false, an operation is created in paused
  • description string - Description associated to periodicity

Returns:

  • ExecuteEachBuilder
executeEvery
function executeEvery(date: Date,name: string,end: number or Date,active: boolean,description: string) -> 'ExecuteEveryBuilder'

The operation will execute with a period that you must define with ExecuteEveryBuilder

Arguments:

  • date Date - Date when operation will be executed
  • name string - Name associated to periodicity
  • end number or Date - When periodicity ends. By repetitions or by date
  • active boolean - If active is false, an operation is created in paused
  • description string - Description associated to periodicity

Returns:

  • ExecuteEveryBuilder
executeIDLE
function executeIDLE() -> 'BaseOperationBuilder'

The operation will be created in IDLE state

Returns:

  • BaseOperationBuilder
executeImmediately
function executeImmediately() -> 'BaseOperationBuilder'

The operation will be execute immediately.

Returns:

  • BaseOperationBuilder
executeLater
function executeLater(minutes: number,active: boolean) -> 'BaseOperationBuilder,CronExpressionBuilder'

The operation will be created with delayed start or if you not pass any argument then the method return a cron expression builder.

Arguments:

  • minutes number
  • active boolean - If active is false, an operation is created in paused

Returns:

  • BaseOperationBuilder,CronExpressionBuilder
withAckTimeout
function withAckTimeout(milliseconds: number,format: string) -> 'BaseOperationBuilder'

Set ackTimeout to operation.

Arguments:

  • milliseconds number
  • format string - Can be 'milliseconds' || 'ms' ,'seconds' || 's', 'minutes' || 'm', 'hours' || 'h', 'days' || 'd', 'weeks' || 'w', 'months' || 'M'

Returns:

  • BaseOperationBuilder

Example:

 ogapi.operations.builderFactory.newXXXBuilder().withAckTimeout(11)
withCallback
function withCallback(url: string) -> 'BaseOperationBuilder'

Set a callback to operation. If it is set also will be set notify with true value

Arguments:

  • url string - If null then parameter will be removed into builder

Returns:

  • BaseOperationBuilder

Example:

 ogapi.operations.builderFactory.newXXXBuilder().withCallback("http://my.web")
withJobTimeout
function withJobTimeout(milliseconds: number,format: string) -> 'BaseOperationBuilder'

Set a timeout of job.

Arguments:

  • milliseconds number - if null then parameter will be removed into builder
  • format string - Can be 'milliseconds' || 'ms' ,'seconds' || 's', 'mintutes' || 'm', 'hours' || 'h', 'days' || 'd', 'weeks' || 'w', 'months' || 'M'

Returns:

  • BaseOperationBuilder

Example:

 ogapi.operations.builderFactory.newXXXBuilder().withJobTimeout(180)
withNotes
function withNotes(notes: string) -> 'BaseOperationBuilder'

Set notes to operation

Arguments:

  • notes string - If null then parameter will be removed into builder

Returns:

  • BaseOperationBuilder

Example:

 ogapi.operations.builderFactory.newXXXBuilder().withNotes("own notes")
withOperationRetries
function withOperationRetries(operationRetries: Array) -> 'BaseOperationBuilder'

Set operation retries

Arguments:

  • operationRetries Array

Returns:

  • BaseOperationBuilder

Example:

 ogapi.operations.builderFactory.newXXXBuilder().withOperationRetries(11)
withParameter
function withParameter(parameter: *,value: *) -> '*'

Arguments:

  • parameter *
  • value *

Returns:

  • *
withParameters
function withParameters(parameters: object) -> 'BaseOperationBuilder'

Set parameters of the operation

Arguments:

  • parameters object

Returns:

  • BaseOperationBuilder

Example:

 ogapi.operations.builderFactory.newXXXBuilder().withParameters({ param1: 'value1', param2: 'value2'})
withRetries
function withRetries(retriesNumber: number) -> 'BaseOperationBuilder'

Set number of retries that operation will have.

Arguments:

  • retriesNumber number

Returns:

  • BaseOperationBuilder

Example:

 ogapi.operations.builderFactory.newXXXBuilder().withRetries(2)
withRetriesDelay
function withRetriesDelay(milliseconds: number,format: string) -> 'BaseOperationBuilder'

Set delay between operation retries.

Arguments:

  • milliseconds number
  • format string - Can be 'milliseconds' || 'ms' ,'seconds' || 's', 'minutes' || 'm', 'hours' || 'h', 'days' || 'd', 'weeks' || 'w', 'months' || 'M'

Returns:

  • BaseOperationBuilder

Example:

 ogapi.operations.builderFactory.newXXXBuilder().withRetriesDelay(11)
withScatteringMaxSpread
function withScatteringMaxSpread(percentage: number) -> 'BaseOperationBuilder'

Set a scattering max spread to operation.

Arguments:

  • percentage number - if null then parameter will be removed into builder

Returns:

  • BaseOperationBuilder

Example:

 ogapi.operations.builderFactory.newXXXBuilder().withScatteringMaxSpread(20)
withScatteringStrategy
function withScatteringStrategy(factor: number,warningMaxRate: number) -> 'BaseOperationBuilder'

Set a scattering strategy to operation.

Arguments:

  • factor number - if null then parameter will be removed into builder
  • warningMaxRate number

Returns:

  • BaseOperationBuilder

Example:

 ogapi.operations.builderFactory.newXXXBuilder().withScatteringStrategy(20,4)
withTimeout
function withTimeout(milliseconds: number,format: string) -> 'BaseOperationBuilder'

Set timeout to operation.

Arguments:

  • milliseconds number
  • format string - Can be 'milliseconds' || 'ms' ,'seconds' || 's', 'minutes' || 'm', 'hours' || 'h', 'days' || 'd', 'weeks' || 'w', 'months' || 'M'

Returns:

  • BaseOperationBuilder

Example:

 ogapi.operations.builderFactory.newXXXBuilder().withTimeout(11)