org.apache.beam.runners.fnexecution.state

Interface StateRequestHandlers.BagUserStateHandler<K,V,W extends BoundedWindow>

Enclosing class:

StateRequestHandlers

@ThreadSafe
public static interface StateRequestHandlers.BagUserStateHandler<K,V,W extends BoundedWindow>

A handler for bag user state.

Note that this handler is expected to be thread safe as it will be invoked concurrently.

Method Summary

Modifier and Type	Method and Description
void	append(K key, W window, java.util.Iterator<V> values) Appends the values to the bag user state for the given key and window.
void	clear(K key, W window) Clears the bag user state for the given key and window.
java.lang.Iterable<V>	get(K key, W window) Returns an Iterable of values representing the bag user state for the given key and window.
default java.util.Optional<org.apache.beam.vendor.grpc.v1p21p0.com.google.protobuf.ByteString>	getCacheToken() Returns the currently valid cache token.

Method Detail

get

java.lang.Iterable<V> get(K key,
                          W window)

Returns an Iterable of values representing the bag user state for the given key and window.

TODO: Add support for bag user state chunking and caching if a Reiterable is returned.

append

void append(K key,
            W window,
            java.util.Iterator<V> values)

Appends the values to the bag user state for the given key and window.

clear

void clear(K key,
           W window)

Clears the bag user state for the given key and window.

getCacheToken

default java.util.Optional<org.apache.beam.vendor.grpc.v1p21p0.com.google.protobuf.ByteString> getCacheToken()

Returns the currently valid cache token.