org.apache.beam.sdk.state

Interface OrderedListState<T>

All Superinterfaces:

GroupingState<TimestampedValue<T>,java.lang.Iterable<TimestampedValue<T>>>, ReadableState<java.lang.Iterable<TimestampedValue<T>>>, State

@Experimental(value=STATE)
public interface OrderedListState<T>
extends GroupingState<TimestampedValue<T>,java.lang.Iterable<TimestampedValue<T>>>

A ReadableState cell containing a list of values sorted by timestamp. Timestamped values can be added to the list, and subranges can be read out in order. Subranges of the list can be deleted as well.

Method Summary

Modifier and Type	Method and Description
void	clearRange(Instant minTimestamp, Instant limitTimestamp) Clear a timestamp-limited subrange of the list.
java.lang.Iterable<TimestampedValue<T>>	readRange(Instant minTimestamp, Instant limitTimestamp) Read a timestamp-limited subrange of the list.
OrderedListState<T>	readRangeLater(Instant minTimestamp, Instant limitTimestamp) Call to indicate that a specific range will be read from the list, allowing runners to batch multiple range reads.

Methods inherited from interface org.apache.beam.sdk.state.GroupingState

add, isEmpty, readLater

Methods inherited from interface org.apache.beam.sdk.state.ReadableState

read

Methods inherited from interface org.apache.beam.sdk.state.State

clear

Method Detail

readRange

java.lang.Iterable<TimestampedValue<T>> readRange(Instant minTimestamp,
                                                  Instant limitTimestamp)

Read a timestamp-limited subrange of the list. The result is ordered by timestamp.

All values with timestamps >= minTimestamp and < limitTimestamp will be in the resuling iterable. This means that only timestamps strictly less than Instant.ofEpochMilli(Long.MAX_VALUE) can be used as timestamps.

clearRange

void clearRange(Instant minTimestamp,
                Instant limitTimestamp)

Clear a timestamp-limited subrange of the list.

All values with timestamps >= minTimestamp and < limitTimestamp will be removed from the list.

readRangeLater

OrderedListState<T> readRangeLater(Instant minTimestamp,
                                   Instant limitTimestamp)

Call to indicate that a specific range will be read from the list, allowing runners to batch multiple range reads.