org.apache.flink.streaming.api.transformations

Class BroadcastStateTransformation<IN1,IN2,OUT>

java.lang.Object

org.apache.flink.api.dag.Transformation<T>

org.apache.flink.streaming.api.transformations.PhysicalTransformation<OUT>

org.apache.flink.streaming.api.transformations.BroadcastStateTransformation<IN1,IN2,OUT>

Type Parameters:

IN1 - The type of the elements in the non-broadcasted input.

IN2 - The type of the elements in the broadcasted input.

OUT - The type of the elements that result from this transformation.

@Internal
public class BroadcastStateTransformation<IN1,IN2,OUT>
extends PhysicalTransformation<OUT>

This is the transformation for the Broadcast State pattern. In a nutshell, this transformation allows to take a broadcasted (non-keyed) stream, connect it with another keyed or non-keyed stream, and apply a function on the resulting connected stream. This function will have access to all the elements that belong to the non-keyed, broadcasted side, as this is kept in Flink's state.

For more information see the Broadcast State Pattern documentation page.

Field Summary

Fields inherited from class org.apache.flink.api.dag.Transformation

bufferTimeout, id, idCounter, name, outputType, typeUsed, UPPER_BOUND_MAX_PARALLELISM

Method Summary

Modifier and Type	Method and Description
static <IN1,IN2,OUT> BroadcastStateTransformation<IN1,IN2,OUT>	forKeyedStream(String name, KeyedStream<IN1,?> nonBroadcastStream, BroadcastStream<IN2> broadcastStream, StreamOperatorFactory<OUT> operatorFactory, org.apache.flink.api.common.typeinfo.TypeInformation<OUT> outTypeInfo, int parallelism)
static <IN1,IN2,OUT> BroadcastStateTransformation<IN1,IN2,OUT>	forNonKeyedStream(String name, DataStream<IN1> nonBroadcastStream, BroadcastStream<IN2> broadcastStream, StreamOperatorFactory<OUT> operatorFactory, org.apache.flink.api.common.typeinfo.TypeInformation<OUT> outTypeInfo, int parallelism)
org.apache.flink.api.dag.Transformation<IN2>	getBroadcastStream()
List<org.apache.flink.api.dag.Transformation<?>>	getInputs()
org.apache.flink.api.java.functions.KeySelector<IN1,?>	getKeySelector()
org.apache.flink.api.dag.Transformation<IN1>	getNonBroadcastStream()
StreamOperatorFactory<OUT>	getOperatorFactory()
org.apache.flink.api.common.typeinfo.TypeInformation<?>	getStateKeyType()
List<org.apache.flink.api.dag.Transformation<?>>	getTransitivePredecessors()
void	setChainingStrategy(ChainingStrategy strategy) Sets the chaining strategy of this Transformation.

Methods inherited from class org.apache.flink.api.dag.Transformation

declareManagedMemoryUseCaseAtOperatorScope, declareManagedMemoryUseCaseAtSlotScope, equals, getBufferTimeout, getCoLocationGroupKey, getId, getManagedMemoryOperatorScopeUseCaseWeights, getManagedMemorySlotScopeUseCases, getMaxParallelism, getMinResources, getName, getNewNodeId, getOutputType, getParallelism, getPreferredResources, getSlotSharingGroup, getUid, getUserProvidedNodeHash, hashCode, setBufferTimeout, setCoLocationGroupKey, setMaxParallelism, setName, setOutputType, setParallelism, setResources, setSlotSharingGroup, setUid, setUidHash, toString, updateManagedMemoryStateBackendUseCase

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getBroadcastStream

public org.apache.flink.api.dag.Transformation<IN2> getBroadcastStream()

getNonBroadcastStream

public org.apache.flink.api.dag.Transformation<IN1> getNonBroadcastStream()

getOperatorFactory

public StreamOperatorFactory<OUT> getOperatorFactory()

getStateKeyType

public org.apache.flink.api.common.typeinfo.TypeInformation<?> getStateKeyType()

getKeySelector

public org.apache.flink.api.java.functions.KeySelector<IN1,?> getKeySelector()

setChainingStrategy

public void setChainingStrategy(ChainingStrategy strategy)

Description copied from class: PhysicalTransformation

Sets the chaining strategy of this Transformation.

Specified by:

setChainingStrategy in class PhysicalTransformation<OUT>

getTransitivePredecessors

public List<org.apache.flink.api.dag.Transformation<?>> getTransitivePredecessors()

Specified by:

getTransitivePredecessors in class org.apache.flink.api.dag.Transformation<OUT>

getInputs

public List<org.apache.flink.api.dag.Transformation<?>> getInputs()

Specified by:

getInputs in class org.apache.flink.api.dag.Transformation<OUT>

forNonKeyedStream

public static <IN1,IN2,OUT> BroadcastStateTransformation<IN1,IN2,OUT> forNonKeyedStream(String name,
                                                                                        DataStream<IN1> nonBroadcastStream,
                                                                                        BroadcastStream<IN2> broadcastStream,
                                                                                        StreamOperatorFactory<OUT> operatorFactory,
                                                                                        org.apache.flink.api.common.typeinfo.TypeInformation<OUT> outTypeInfo,
                                                                                        int parallelism)

forKeyedStream

public static <IN1,IN2,OUT> BroadcastStateTransformation<IN1,IN2,OUT> forKeyedStream(String name,
                                                                                     KeyedStream<IN1,?> nonBroadcastStream,
                                                                                     BroadcastStream<IN2> broadcastStream,
                                                                                     StreamOperatorFactory<OUT> operatorFactory,
                                                                                     org.apache.flink.api.common.typeinfo.TypeInformation<OUT> outTypeInfo,
                                                                                     int parallelism)