Skip to main content

AsyncJobServiceParameters

@webda/async

Class: AsyncJobServiceParameters

Defined in: packages/async/src/services/asyncjobservice.service.ts:50

Inherit Doc​

Extends​

  • ServiceParameters

Constructors​

Constructor​

new AsyncJobServiceParameters(): AsyncJobServiceParameters

Returns​

AsyncJobServiceParameters

Inherited from​

ServiceParameters.constructor

Properties​

asyncActionModel?​

optional asyncActionModel?: string

Defined in: packages/async/src/services/asyncjobservice.service.ts:122

Model to use when launching async action

Default​

Webda/AsyncWebdaAction

asyncOperationDefinition?​

optional asyncOperationDefinition?: string

Defined in: packages/async/src/services/asyncjobservice.service.ts:135

JSON file of the AsyncOperation definition

Generated with webda operations operations.json

asyncOperationModel?​

optional asyncOperationModel?: string

Defined in: packages/async/src/services/asyncjobservice.service.ts:129

Model to use when launching async operation

Default​

Webda/AsyncOperationAction

concurrencyLimit?​

optional concurrencyLimit?: number

Defined in: packages/async/src/services/asyncjobservice.service.ts:80

Limit the maximum number of jobs running in //

fallbackOnFirst​

fallbackOnFirst: boolean

Defined in: packages/async/src/services/asyncjobservice.service.ts:72

Fallback on first runner if none match

Default​

false

includeCron?​

optional includeCron?: boolean

Defined in: packages/async/src/services/asyncjobservice.service.ts:92

Include Cron annotation to launch them as AsyncOperationAction

Default​

true

includeSchedulerInWorker?​

optional includeSchedulerInWorker?: boolean

Defined in: packages/async/src/services/asyncjobservice.service.ts:96

Include the scheduler system in the worker

localLaunch?​

optional localLaunch?: boolean

Defined in: packages/async/src/services/asyncjobservice.service.ts:56

If set runner will be called without queue

Default​

false

logsLimit​

logsLimit: number

Defined in: packages/async/src/services/asyncjobservice.service.ts:115

Limit the number of lines of logs available for an async action

If you need to store large amount of logs then you should use the CloudWatchLogger or similar logger

Default​

500

onlyHttpHook?​

optional onlyHttpHook?: boolean

Defined in: packages/async/src/services/asyncjobservice.service.ts:86

Define if we should only use an http hook and not rely on store for AsyncOperation

Default​

false

queue​

queue: string

Defined in: packages/async/src/services/asyncjobservice.service.ts:61

Queue to post execution to

Default​

AsyncActionsQueue

runners​

runners: string[]

Defined in: packages/async/src/services/asyncjobservice.service.ts:76

Runners to use

schedulerResolution?​

optional schedulerResolution?: number

Defined in: packages/async/src/services/asyncjobservice.service.ts:106

Schedule action resolution

If set to 1000ms, you can schedule action per second by default it resolve per minute

Default​

60000

type​

type: string

Defined in: packages/core/lib/services/serviceparameters.d.ts:8

Type of the service

Inherited from​

ServiceParameters.type

url​

url: string

Defined in: packages/async/src/services/asyncjobservice.service.ts:67

URL to expose job status report hook

Default​

/async

Methods​

load()​

load(params?): this

Defined in: packages/async/src/services/asyncjobservice.service.ts:142

Parameters​

params?​

any = {}

the input parameters

Returns​

this

this

Overrides​

ServiceParameters.load

update()​

update(params, delta): this

Defined in: packages/core/lib/services/serviceparameters.d.ts:25

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ServiceParameters.update

with()​

with(callback): this

Defined in: packages/core/lib/services/serviceparameters.d.ts:31

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ServiceParameters.with