Package org.apache.flink.streaming.api.runners.python.beam.state

Class BeamStateRequestHandler

java.lang.Object

org.apache.flink.streaming.api.runners.python.beam.state.BeamStateRequestHandler

All Implemented Interfaces:

org.apache.beam.runners.fnexecution.state.StateRequestHandler

public class BeamStateRequestHandler
extends Object
implements org.apache.beam.runners.fnexecution.state.StateRequestHandler

The handler for Beam state requests sent from Python side, which does actual operations on Flink state.

Constructor Summary

Constructors

Constructor	Description
BeamStateRequestHandler(BeamStateStore keyedStateStore, BeamStateStore operatorStateStore, BeamStateHandler<org.apache.flink.api.common.state.ListState<byte[]>> bagStateHandler, BeamStateHandler<org.apache.flink.api.common.state.MapState<ByteArrayWrapper,byte[]>> mapStateHandler)

Method Summary

Modifier and Type	Method	Description
Iterable<org.apache.beam.model.fnexecution.v1.BeamFnApi.ProcessBundleRequest.CacheToken>	getCacheTokens()
CompletionStage<org.apache.beam.model.fnexecution.v1.BeamFnApi.StateResponse.Builder>	handle(org.apache.beam.model.fnexecution.v1.BeamFnApi.StateRequest request)
static BeamStateRequestHandler	of(org.apache.flink.runtime.state.KeyedStateBackend<?> keyedStateBackend, org.apache.flink.runtime.state.OperatorStateBackend operatorStateBackend, org.apache.flink.api.common.typeutils.TypeSerializer<?> keySerializer, org.apache.flink.api.common.typeutils.TypeSerializer<?> namespaceSerializer, org.apache.flink.configuration.ReadableConfig config)	Create a BeamStateRequestHandler.

Methods inherited from class java.lang.Object

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

Constructor Detail

BeamStateRequestHandler

public BeamStateRequestHandler(BeamStateStore keyedStateStore,
                               BeamStateStore operatorStateStore,
                               BeamStateHandler<org.apache.flink.api.common.state.ListState<byte[]>> bagStateHandler,
                               BeamStateHandler<org.apache.flink.api.common.state.MapState<ByteArrayWrapper,byte[]>> mapStateHandler)

Method Detail

handle

public CompletionStage<org.apache.beam.model.fnexecution.v1.BeamFnApi.StateResponse.Builder> handle(org.apache.beam.model.fnexecution.v1.BeamFnApi.StateRequest request)
                                                                                             throws Exception

Specified by:

handle in interface org.apache.beam.runners.fnexecution.state.StateRequestHandler

Throws:

Exception

getCacheTokens

public Iterable<org.apache.beam.model.fnexecution.v1.BeamFnApi.ProcessBundleRequest.CacheToken> getCacheTokens()

Specified by:

getCacheTokens in interface org.apache.beam.runners.fnexecution.state.StateRequestHandler

of

public static BeamStateRequestHandler of(@Nullable
                                         org.apache.flink.runtime.state.KeyedStateBackend<?> keyedStateBackend,
                                         @Nullable
                                         org.apache.flink.runtime.state.OperatorStateBackend operatorStateBackend,
                                         @Nullable
                                         org.apache.flink.api.common.typeutils.TypeSerializer<?> keySerializer,
                                         @Nullable
                                         org.apache.flink.api.common.typeutils.TypeSerializer<?> namespaceSerializer,
                                         org.apache.flink.configuration.ReadableConfig config)

Create a BeamStateRequestHandler.

Parameters:

keyedStateBackend - if null, BeamStateRequestHandler would throw an error when receive keyed-state requests.

operatorStateBackend - if null, BeamStateRequestHandler would throw an error when receive operator-state requests.

keySerializer - key serializer for KeyedStateBackend, must not be null if keyedStatedBackend is not null.

namespaceSerializer - namespace serializer for KeyedStateBackend, could be null when there's no window logic involved.

config - state-related configurations

Returns:

A new BeamBagStateHandler