QueueItemsExtension<T> extension

Filters and progress for a collection of queue items, such as queue.items() or a snapshot's items.

For the queue's own views of its items (queue.items(), the current batch and a snapshot's live items), the counts come from the queue, so items.completed.length, progress and summary take the same time however many items there are. For other collections, such as a list or an earlier batch, they go through the items.

on

Properties

canceled → Iterable<QueueItem<T>>

Available on Iterable<QueueItem<T>>, provided by the QueueItemsExtension extension

The canceled items.
no setter
completed → Iterable<QueueItem<T>>

Available on Iterable<QueueItem<T>>, provided by the QueueItemsExtension extension

The items processed successfully.
no setter
failed → Iterable<QueueItem<T>>

Available on Iterable<QueueItem<T>>, provided by the QueueItemsExtension extension

The items that failed with no retries left. During the failed update of an attempt that will be retried, that item is here too.
no setter
pending → Iterable<QueueItem<T>>

Available on Iterable<QueueItem<T>>, provided by the QueueItemsExtension extension

The items waiting to be processed.
no setter
processing → Iterable<QueueItem<T>>

Available on Iterable<QueueItem<T>>, provided by the QueueItemsExtension extension

The items being processed.
no setter
progress → double

Available on Iterable<QueueItem<T>>, provided by the QueueItemsExtension extension

The share of the items that have finished, from 0 to 1, rounded to two decimal places. Items that are pending or processing haven't finished. It's 1 only when every item has finished, or when there are no items. During the failed update of an attempt that will be retried, that item counts as finished.
no setter
summary → String

Available on Iterable<QueueItem<T>>, provided by the QueueItemsExtension extension

A few lines counting the items and the pending, processing, completed, failed and canceled ones, and the progress.
no setter