org.apache.beam.runners.samza.state

Interface SamzaSetState<T>

All Superinterfaces:

org.apache.beam.sdk.state.GroupingState<T,java.lang.Iterable<T>>, org.apache.beam.sdk.state.ReadableState<java.lang.Iterable<T>>, org.apache.beam.sdk.state.SetState<T>, org.apache.beam.sdk.state.State

public interface SamzaSetState<T>
extends org.apache.beam.sdk.state.SetState<T>

Samza's extended SetState, allowing extra access methods to the state.

Method Summary

Modifier and Type	Method and Description
void	closeIterators() Closes the iterator returned from readIterator().
org.apache.beam.sdk.state.ReadableState<java.util.Iterator<T>>	readIterator() Returns an iterator from the current set state.

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

addIfAbsent, contains, readLater, remove

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

readIterator

org.apache.beam.sdk.state.ReadableState<java.util.Iterator<T>> readIterator()

Returns an iterator from the current set state. Note this is different from the iterable implementation in ReadableState.read(), where we load the entries into memory and return iterable from that. To handle large state that doesn't fit in memory, we also need this method so it's possible to iterate on large data set and close the iterator when not needed.

Returns:

a ReadableState of an iterator

closeIterators

void closeIterators()

Closes the iterator returned from readIterator().