Skip to main content

@webda/gcpReadme | API


Class: GCPQueueParameters

GCPQueue Parameters

Extends

  • QueueParameters

Constructors

new GCPQueueParameters(params)

new GCPQueueParameters(params): GCPQueueParameters

Parameters

params: any

Returns

GCPQueueParameters

Inherited from

QueueParameters.constructor

Inherit Doc

Source

core/lib/queues/queueservice.d.ts:42

Properties

maxConsumers

maxConsumers: number

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

Source

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


openapi?

openapi?: OpenAPIWebdaDefinition

OpenAPI override

Schema Ignore

Inherited from

QueueParameters.openapi

Source

core/lib/services/service.d.ts:104


subscription

subscription: string

Subscription to use for the queue

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

Source

gcp/src/services/queue.ts:17


timeout?

timeout?: number

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

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

Source

gcp/src/services/queue.ts:23


topic

topic: string

Topic to use

Source

gcp/src/services/queue.ts:11


type

type: string

Type of the service

Inherited from

QueueParameters.type

Source

core/lib/services/service.d.ts:95


url?

url?: string

URL on which to serve the content

Inherited from

QueueParameters.url

Source

core/lib/services/service.d.ts:99


workerDelayer?

workerDelayer?: WaitDelayerDefinition

Delayer between two failed attempts to process messages

Inherited from

QueueParameters.workerDelayer

Source

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


workerParallelism?

workerParallelism?: boolean

Define if worker should process multi message received in //

Default

true

Inherited from

QueueParameters.workerParallelism

Source

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