Package org.apache.beam.fn.harness.state

Class StateBackedIterable<T>

java.lang.Object

org.apache.beam.sdk.util.common.ElementByteSizeObservableIterable<T,org.apache.beam.sdk.util.common.ElementByteSizeObservableIterator<T>>

org.apache.beam.fn.harness.state.StateBackedIterable<T>

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<T>

public class StateBackedIterable<T>
extends org.apache.beam.sdk.util.common.ElementByteSizeObservableIterable<T,org.apache.beam.sdk.util.common.ElementByteSizeObservableIterator<T>>
implements java.io.Serializable

A state backed iterable which allows for fetching elements over the portability state API. See remote references for additional details.

One must supply a StateBackedIterable.StateBackedIterableTranslationContext when using CoderTranslator.fromComponents(java.util.List<org.apache.beam.sdk.coders.Coder<?>>, byte[], org.apache.beam.sdk.util.construction.CoderTranslation.TranslationContext) to be able to create a StateBackedIterable.Coder.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StateBackedIterable.Coder<T>	Decodes an Iterable that might be backed by state.
static class	StateBackedIterable.Registrar	A CoderTranslatorRegistrar for beam:coder:state_backed_iterable:v1.
static interface	StateBackedIterable.StateBackedIterableTranslationContext	Additional parameters required by the StateBackedIterable.Coder.

Constructor Summary

Constructors

Constructor	Description
StateBackedIterable(Cache<?,?> cache, BeamFnStateClient beamFnStateClient, java.lang.String instructionId, org.apache.beam.model.fnexecution.v1.BeamFnApi.StateKey stateKey, org.apache.beam.sdk.coders.Coder<T> elemCoder, java.util.List<T> prefix)

Method Summary

Modifier and Type	Method	Description
protected org.apache.beam.sdk.util.common.ElementByteSizeObservableIterator<T>	createIterator()
protected java.lang.Object	writeReplace()

Methods inherited from class org.apache.beam.sdk.util.common.ElementByteSizeObservableIterable

addObserver, iterator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

StateBackedIterable

public StateBackedIterable(Cache<?,?> cache,
                           BeamFnStateClient beamFnStateClient,
                           java.lang.String instructionId,
                           org.apache.beam.model.fnexecution.v1.BeamFnApi.StateKey stateKey,
                           org.apache.beam.sdk.coders.Coder<T> elemCoder,
                           java.util.List<T> prefix)

Method Detail

createIterator

protected org.apache.beam.sdk.util.common.ElementByteSizeObservableIterator<T> createIterator()

Specified by:

createIterator in class org.apache.beam.sdk.util.common.ElementByteSizeObservableIterable<T,org.apache.beam.sdk.util.common.ElementByteSizeObservableIterator<T>>

writeReplace

protected java.lang.Object writeReplace()
                                 throws java.io.ObjectStreamException

Throws:

java.io.ObjectStreamException