Get Queue Items
Reads up to 100 items of a queue without claiming them, oldest first.
Behaviour
Risk: None · Idempotent: Yes · Safe to retry: Yes · Recovery: Replayed after a crash
Package Orchestrator activities VeloPhex.Orchestrator.Activities 0.7.1-rc.12 · Supported (Core profile) · type id velophex.orchestrator.getQueueItems
Properties#
Input#
Queue Name#
QueueName · String · Required · Default: Not specified in package metadata
The name of the queue in the job's workspace.
Status#
Status · String · Optional · Default: Not specified in package metadata
Comma-separated statuses: New, InProgress, Successful, Failed, Abandoned, Retried, Deleted. Empty reads every status.
Reference#
Reference · String · Optional · Default: Not specified in package metadata
Reads only items with this reference, or with a reference starting with it when Reference Match is Prefix.
Reference Match#
ReferenceMatch · String · Optional · Default: Exact
How Reference compares: Exact, or Prefix for references that start with it.
Allowed values: Exact, Prefix.
Created From#
CreatedFrom · DateTimeOffset? · Optional · Default: Not specified in package metadata
Reads only items created at or after this time.
Created To#
CreatedTo · DateTimeOffset? · Optional · Default: Not specified in package metadata
Reads only items created at or before this time.
Options#
Skip#
Skip · Int32 · Optional · Default: Not specified in package metadata
How many matching items to skip, for reading the next page.
Top#
Top · Int32 · Optional · Default: Not specified in package metadata
How many items to read, 1 to 100. 0 reads 100.
Output#
Items#
Items · IReadOnlyList<QueueItem> · Output
The items read, oldest first.
Total Count#
TotalCount · Int32 · Output
How many items match the filter in all, including those beyond this page.
Retry and risk#
This activity is safe to retry: running it again after a transient failure does not repeat a side effect. 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 Transaction Item
- Postpone Transaction Item
- Set Transaction Progress
- Set Transaction Status
- Wait Queue Item
Generated from VeloPhex.Orchestrator.Activities 0.7.1-rc.12. Category: Queues. Keywords: queue, items, list, search, filter, read, status, reference, transaction, orchestrator.
Properties
Input
Options
Output
Retry and risk
Related activities