Skip to main content

ServiceBusQueueParameters

@webda/azure

Class: ServiceBusQueueParameters

Defined in: azure/src/services/servicebus.service.ts:98

Service Bus work queue settings.

Extends​

  • QueueParameters

Implements​

  • ServiceBusSettings

Constructors​

Constructor​

new ServiceBusQueueParameters(): ServiceBusQueueParameters

Returns​

ServiceBusQueueParameters

Inherited from​

QueueParameters.constructor

Properties​

clientId?​

optional clientId?: string

Defined in: azure/src/services/servicebus.service.ts:122

Client ID

Implementation of​

ServiceBusSettings.clientId

clientSecret?​

optional clientSecret?: string | SecretString

Defined in: azure/src/services/servicebus.service.ts:126

Client secret

Implementation of​

ServiceBusSettings.clientSecret

connectionString?​

optional connectionString?: string | SecretString

Defined in: azure/src/services/servicebus.service.ts:106

Connection string

Implementation of​

ServiceBusSettings.connectionString

createIfNotExists​

createIfNotExists: boolean = false

Defined in: azure/src/services/servicebus.service.ts:110

Create if not exists

Implementation of​

ServiceBusSettings.createIfNotExists

endpoint?​

optional endpoint?: string

Defined in: azure/src/services/servicebus.service.ts:134

Endpoint

Implementation of​

ServiceBusSettings.endpoint

idleDelayer?​

optional idleDelayer?: WaitDelayerDefinition

Defined in: core/lib/queues/queueservice.d.ts:48

Delayer between two receives of the main consumer while the queue returns no message

Queues answering immediately when empty (PostgresQueue, AMQPQueue...) would otherwise be polled in a tight loop. The delay grows with the consecutive empty receives, up to maxIdleDelay; the time spent in the receive is deducted, so long-polling queues (SQSQueue, FileQueue, MemoryQueue with a timeout) are not slowed down.

Default​

{ "type": "exponential", "interval": 50 }

Inherited from​

QueueParameters.idleDelayer

maxConsumers​

maxConsumers: number

Defined in: core/lib/queues/queueservice.d.ts:38

Max number of queue consumers Queue will auto increase to this max number if queue is loaded and it will decrease to just one consumer if no messages are available

Default​

10

Inherited from​

QueueParameters.maxConsumers

maxIdleDelay?​

optional maxIdleDelay?: number

Defined in: core/lib/queues/queueservice.d.ts:57

Maximum delay between two receives while the queue stays empty, in milliseconds

It bounds the extra latency of the first message after an idle period, and the polling rate of an idle consumer (4 receives per second at 250ms).

Default​

250

Inherited from​

QueueParameters.maxIdleDelay

maxMessages​

maxMessages: number = 10

Defined in: azure/src/services/servicebus.service.ts:138

Max messages

maxPendingMessages​

maxPendingMessages: number = 1000

Defined in: azure/src/services/servicebus.service.ts:146

Max pending messages

maxWaitTimeInMs​

maxWaitTimeInMs: number = 1000

Defined in: azure/src/services/servicebus.service.ts:142

Max wait time in ms

namespace​

namespace: string

Defined in: azure/src/services/servicebus.service.ts:102

Namespace

Implementation of​

ServiceBusSettings.namespace

queue​

queue: string

Defined in: azure/src/services/servicebus.service.ts:114

Queue

subscriptionId?​

optional subscriptionId?: string

Defined in: azure/src/services/servicebus.service.ts:130

Subscription ID

Implementation of​

ServiceBusSettings.subscriptionId

tenantId?​

optional tenantId?: string

Defined in: azure/src/services/servicebus.service.ts:118

Tenant ID

Implementation of​

ServiceBusSettings.tenantId

type​

type: string

Defined in: core/lib/services/serviceparameters.d.ts:9

Type of the service

Inherited from​

QueueParameters.type

workerDelayer?​

optional workerDelayer?: WaitDelayerDefinition

Defined in: core/lib/queues/queueservice.d.ts:25

Delayer between two failed attempts to process messages

Inherited from​

QueueParameters.workerDelayer

workerParallelism​

workerParallelism: boolean

Defined in: core/lib/queues/queueservice.d.ts:30

Define if worker should process multi message received in //

Default​

true

Inherited from​

QueueParameters.workerParallelism

Methods​

load()​

load(params?): this

Defined in: azure/src/services/servicebus.service.ts:152

Perform load.

Parameters​

params?​

any = {}

Returns​

this

Overrides​

QueueParameters.load

update()​

update(params, delta): this

Defined in: core/lib/application/parameters.d.ts:21

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​

QueueParameters.update

with()​

with(callback): this

Defined in: core/lib/application/parameters.d.ts:27

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​

QueueParameters.with