org.apache.beam.sdk.state

Interface BagState<T>

Type Parameters:

T - The type of elements in the bag.

All Superinterfaces:

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

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

A ReadableState cell containing a bag of values. Items can be added to the bag and the contents read out.

Implementations of this form of state are expected to implement GroupingState.add(InputT) efficiently, not via a sequence of read-modify-write.

Method Summary

Modifier and Type	Method and Description
BagState<T>	readLater() Indicate that the value will be read later.

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

add, isEmpty

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

read

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

clear

Method Detail

readLater

BagState<T> readLater()

Description copied from interface: ReadableState

Indicate that the value will be read later.

This allows an implementation to start an asynchronous prefetch or to include this state in the next batch of reads.

Specified by:

readLater in interface GroupingState<T,java.lang.Iterable<T>>

Specified by:

readLater in interface ReadableState<java.lang.Iterable<T>>

Returns:

this for convenient chaining