PURISTA API / @purista/core / QueueDefinitionBuilder
Class: QueueDefinitionBuilder
Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:12
Constructors
Constructor
new QueueDefinitionBuilder(
queueName,queueDescription):QueueDefinitionBuilder
Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:30
Parameters
queueName
string
queueDescription
string
Returns
QueueDefinitionBuilder
Methods
addParameterSchema()
addParameterSchema(
schema):QueueDefinitionBuilder
Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:40
Parameters
schema
Returns
QueueDefinitionBuilder
addPayloadSchema()
addPayloadSchema(
schema):QueueDefinitionBuilder
Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:35
Parameters
schema
Returns
QueueDefinitionBuilder
addWorkerDefinition()
addWorkerDefinition(...
workers):QueueDefinitionBuilder
Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:178
Parameters
workers
Returns
QueueDefinitionBuilder
emitResultAsEvent()
emitResultAsEvent(
successEventName,options?):QueueDefinitionBuilder
Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:113
Convenience helper for emitting successful worker output as a PURISTA event.
Parameters
successEventName
string
options?
Omit<QueueResultPolicy, "mode" | "successEventName">
Returns
QueueDefinitionBuilder
getDefinition()
getDefinition():
Promise<QueueDefinition>
Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:183
Returns
Promise<QueueDefinition>
markAsDeprecated()
markAsDeprecated():
QueueDefinitionBuilder
Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:165
Returns
QueueDefinitionBuilder
markSchedulable()
markSchedulable(
options):QueueDefinitionBuilder
Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:124
Mark this queue as a direct schedule target.
Parameters
options
ScheduleOptions & object
Returns
QueueDefinitionBuilder
setBeforeEnqueueTransform()
setBeforeEnqueueTransform(
transform):QueueDefinitionBuilder
Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:145
Parameters
transform
Returns
QueueDefinitionBuilder
setBeforeExecuteTransform()
setBeforeExecuteTransform(
transform):QueueDefinitionBuilder
Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:150
Parameters
transform
Returns
QueueDefinitionBuilder
setDeadLetterOptions()
setDeadLetterOptions(
options):QueueDefinitionBuilder
Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:155
Parameters
options
queueName?
string
Returns
QueueDefinitionBuilder
setExecutionProfile()
setExecutionProfile(
profile,options):QueueDefinitionBuilder
Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:63
Apply the built-in long-running queue execution profile.
Parameters
profile
"longRunning"
options
maxRuntimeMs
number
strict?
boolean
Returns
QueueDefinitionBuilder
Example
queue.setExecutionProfile('longRunning', {
maxRuntimeMs: 6 * 60 * 60_000,
})setLifecycleConfig()
setLifecycleConfig(
config):QueueDefinitionBuilder
Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:45
Parameters
config
Partial<QueueLifecycleConfig>
Returns
QueueDefinitionBuilder
setQueueBridgeConfig()
setQueueBridgeConfig(
config):QueueDefinitionBuilder
Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:170
Parameters
config
Partial<DefinitionQueueBridgeConfig>
Returns
QueueDefinitionBuilder
setResultPolicy()
setResultPolicy(
policy):QueueDefinitionBuilder
Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:101
Persist or emit queue worker completion metadata.
Parameters
policy
Returns
QueueDefinitionBuilder
Example
queue.setResultPolicy({
mode: 'event',
successEventName: 'billing.monthlyClosing.completed',
})setTags()
setTags(
tags):QueueDefinitionBuilder
Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:160
Parameters
tags
string[]
Returns
QueueDefinitionBuilder