Wait Queue Item

Waits until a queue has an item available, then claims it for this job.

Behaviour

Risk: Low · Idempotent: No · Safe to retry: No · Recovery: Not replayed after a crash

Package Orchestrator activities VeloPhex.Orchestrator.Activities 0.7.1-rc.12 · Supported (Core profile) · type id velophex.orchestrator.waitQueueItem

Properties#

Input#

Queue Name#

QueueName · String · Required · Default: Not specified in package metadata

The name of the queue in the job's workspace.

Timeout (ms)#

TimeoutMs · Int32 · Optional · Default: Not specified in package metadata

How long to wait for an item, in milliseconds. 0 waits 30 seconds.

Options#

Poll Interval (ms)#

PollIntervalMs · Int32 · Optional · Default: Not specified in package metadata

How often to ask the queue again while it is empty, in milliseconds. 0 asks every 5 seconds; the shortest interval is 1000.

Reference Filter#

ReferenceFilter · String · Optional · Default: Not specified in package metadata

Claims only an item with this reference, or with a reference starting with it when Reference Match is Prefix. Empty claims any item.

Reference Match#

ReferenceMatch · String · Optional · Default: Exact

How Reference Filter compares: Exact, or Prefix for references that start with it.

Allowed values: Exact, Prefix.

Output#

Found#

Found · Boolean · Output

False when the timeout passed with no item available; Transaction Item is then empty.

Transaction Item#

TransactionItem · QueueItem · Output

The claimed item: its Specific Content, Reference and Retry No.

Retry and risk#

This activity is not marked safe to retry: if it fails partway, check whether its work already happened before running it again. If a run is interrupted and the outcome of a step is unknown, the step is never retried automatically (what to do). How activities declare this: characteristics, retries and risk.

Every activity also has the engine's common properties: Timeout and Continue On Error.

Related activities#

• Add Queue Item
• Bulk Add Queue Items
• Delete Queue Items
• Get Queue Items
• Get Transaction Item
• Postpone Transaction Item
• Set Transaction Progress
• Set Transaction Status

Generated from VeloPhex.Orchestrator.Activities 0.7.1-rc.12. Category: Queues. Keywords: queue, item, wait, poll, claim, dequeue, next, transaction, orchestrator.

Properties

Input

Options

Output

Retry and risk

Related activities