AsyncJobServiceParameters
Class: AsyncJobServiceParameters
Inherit Doc
Extends
ServiceParameters
Constructors
new AsyncJobServiceParameters(params)
new AsyncJobServiceParameters(
params):AsyncJobServiceParameters
Parameters
• params: any
Returns
Overrides
ServiceParameters.constructor
Source
async/src/services/asyncjobservice.ts:154
Properties
asyncActionModel?
asyncActionModel?:
string
Model to use when launching async action
Default
Webda/AsyncWebdaAction
Source
async/src/services/asyncjobservice.ts:139
asyncOperationDefinition?
asyncOperationDefinition?:
string
JSON file of the AsyncOperation definition
Generated with webda operations operations.json
Source
async/src/services/asyncjobservice.ts:152
asyncOperationModel?
asyncOperationModel?:
string
Model to use when launching async operation
Default
Webda/AsyncOperationAction
Source
async/src/services/asyncjobservice.ts:146
binaryStore?
binaryStore?:
string
If we want to expose a way to upload/download binary for the job
It will expose a /download and /upload additional url
Deprecated
will be removed in 4.0 to only use object AsyncAction
Source
async/src/services/asyncjobservice.ts:54
concurrencyLimit?
concurrencyLimit?:
number
Limit the maximum number of jobs running in //
Source
async/src/services/asyncjobservice.ts:85
fallbackOnFirst
fallbackOnFirst:
boolean
Fallback on first runner if none match
Default
false
Source
async/src/services/asyncjobservice.ts:77
includeCron?
includeCron?:
boolean
Include Cron annotation to launch them as AsyncOperationAction
Default
true
Source
async/src/services/asyncjobservice.ts:97
includeSchedulerInWorker?
includeSchedulerInWorker?:
boolean
Include the scheduler system in the worker
Source
async/src/services/asyncjobservice.ts:101
localLaunch?
localLaunch?:
boolean
If set runner will be called without queue
Default
false
Source
async/src/services/asyncjobservice.ts:60
logFormat?
logFormat?:
string
Define the log format
Default
ConsoleLoggerDefaultFormat
Source
async/src/services/asyncjobservice.ts:126
logSaveDelay?
logSaveDelay?:
number
How long before saving logs (in ms)
Default
5000
Source
async/src/services/asyncjobservice.ts:132
logsLimit
logsLimit:
number
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
Source
async/src/services/asyncjobservice.ts:120
onlyHttpHook?
onlyHttpHook?:
boolean
Define if we should only use an http hook and not rely on store for AsyncOperation
Default
false
Source
async/src/services/asyncjobservice.ts:91
openapi?
openapi?:
OpenAPIWebdaDefinition
OpenAPI override
Schema Ignore
Inherited from
ServiceParameters.openapi
Source
core/lib/services/service.d.ts:103
queue
queue:
string
Queue to post execution to
Default
AsyncActionsQueue
Source
async/src/services/asyncjobservice.ts:65
runners
runners:
string[]
Runners to use
Source
async/src/services/asyncjobservice.ts:81
schedulerResolution?
schedulerResolution?:
number
Schedule action resolution
If set to 1000ms, you can schedule action per second by default it resolve per minute
Default
60000
Source
async/src/services/asyncjobservice.ts:111
type
type:
string
Type of the service
Inherited from
ServiceParameters.type
Source
core/lib/services/service.d.ts:94
url
url:
string
URL to expose job status report hook
Default
/async/jobs
Deprecated
will be removed in 4.0 to only use object AsyncAction
Overrides
ServiceParameters.url