Skip to main content

GCPQueueParameters

@webda/gcp

Class: GCPQueueParameters

Defined in: gcp/src/services/queue.service.ts:8

GCPQueue Parameters

Extends​

  • QueueParameters

Constructors​

Constructor​

new GCPQueueParameters(): GCPQueueParameters

Returns​

GCPQueueParameters

Inherited from​

QueueParameters.constructor

Properties​

maxConsumers​

maxConsumers: number

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

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

mode?​

optional mode?: "consumer" | "receiver"

Defined in: gcp/src/services/queue.service.ts:31

If receiver, the usage is to call receiveMessage and deleteMessage manually If consumer, the usage is to call consume, the normal flow is used in parallel

Default​

"consumer"

subscription​

subscription: string

Defined in: gcp/src/services/queue.service.ts:18

Subscription to use for the queue

All instances will use the same subscription to create a queue style pubsub

timeout?​

optional timeout?: number

Defined in: gcp/src/services/queue.service.ts:24

Timeout when receiveMessage is used before returning empty result (in ms)

If not define then no timeout is applied and receiveMessage can hang forever

topic​

topic: string

Defined in: gcp/src/services/queue.service.ts:12

Topic to use

type​

type: string

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

Type of the service

Inherited from​

QueueParameters.type

workerDelayer?​

optional workerDelayer?: WaitDelayerDefinition

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

Delayer between two failed attempts to process messages

Inherited from​

QueueParameters.workerDelayer

workerParallelism​

workerParallelism: boolean

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

Define if worker should process multi message received in //

Default​

true

Inherited from​

QueueParameters.workerParallelism

Methods​

load()​

load(params?): this

Defined in: gcp/src/services/queue.service.ts:38

Parameters​

params?​

any = {}

the input parameters

Returns​

this

this

Overrides​

QueueParameters.load

update()​

update(params, delta): this

Defined in: 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​

QueueParameters.update

with()​

with(callback): this

Defined in: 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​

QueueParameters.with