-
- All Implemented Interfaces:
-
java.io.Serializable,org.apache.beam.sdk.transforms.display.HasDisplayData
public final class MapElementFn<InputT extends Object, OutputT extends Object> extends BaseElementFn<InputT, OutputT>
This class proposes a custom map operation while interacting with org.apache.beam.sdk.transforms.DoFn lifecycle.
<br></br>
This class is based on an output type descriptor and take a org.apache.beam.sdk.transforms.SerializableFunction to execute the mapping treatment lazily. This output type allows to give type information and handle default coder for output. This function is mandatory and executed in the ProcessElement stage of Beam lifecycle.
<br></br>
This class can take actions SerializableAction, used in the DoFn Beam lifecycle.
withSetupAction : executed in the setup method
withStartBundleAction : executed in the start bundle method
withFinishBundleAction : executed in the finish bundle method
withTeardownAction : executed in the teardown method
These functions are not required and if they are given, they are executed lazily in the dedicated method.
<br></br>
Example usage:
// With serializable function but without lifecycle actions. MapElementFn.into(TypeDescriptors.integers()) .via((String word) -> 1 / word.length) // With serializable function but without start action. MapElementFn.into(TypeDescriptors.integers()) .via((String word) -> 1 / word.length) .withSetupAction(() -> System.out.println("Starting of mapping...") .withStartBundleAction(() -> System.out.println("Starting bundle of mapping...") .withFinishBundleAction(() -> System.out.println("Ending bundle of mapping...") .withTeardownAction(() -> System.out.println("Ending of mapping...")
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classMapElementFn.Companion
-
Method Summary
Modifier and Type Method Description final <NewInputT extends Any> MapElementFn<NewInputT, OutputT>via(SerializableFunction<NewInputT, OutputT> inputElementMapper)Method that takes the org.apache.beam.sdk.transforms.SerializableFunction that will be evaluated in the process element phase. final MapElementFn<InputT, OutputT>withSetupAction(SerializableAction setupAction)Method that takes the fr.groupbees.midgard.transforms.SerializableAction that will be evaluated in the setup phase. final MapElementFn<InputT, OutputT>withStartBundleAction(SerializableAction startBundleAction)Method that takes the fr.groupbees.midgard.transforms.SerializableAction that will be evaluated in the start bundle phase. final MapElementFn<InputT, OutputT>withFinishBundleAction(SerializableAction finishBundleAction)Method that takes the fr.groupbees.midgard.transforms.SerializableAction that will be evaluated in the finish bundle phase. final MapElementFn<InputT, OutputT>withTeardownAction(SerializableAction teardownAction)Method that takes the fr.groupbees.midgard.transforms.SerializableAction that will be evaluated in the teardown phase. final Unitsetup()Setup action in the DoFn worker lifecycle. final UnitstartBundle()Start bundle action in the DoFn worker lifecycle. final UnitfinishBundle()Finish bundle action in the DoFn worker lifecycle. final Unitteardown()Teardown action in the DoFn worker lifecycle. final UnitprocessElement(DoFn.ProcessContext<InputT, OutputT> ctx)ProcessElement. -
Methods inherited from class fr.groupbees.midgard.transforms.BaseElementFn
getInputTypeDescriptor, getOutputTypeDescriptor -
Methods inherited from class org.apache.beam.sdk.transforms.DoFn
getAllowedTimestampSkew, populateDisplayData, prepareForProcessing -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
via
final <NewInputT extends Any> MapElementFn<NewInputT, OutputT> via(SerializableFunction<NewInputT, OutputT> inputElementMapper)
Method that takes the org.apache.beam.sdk.transforms.SerializableFunction that will be evaluated in the process element phase.
This function is mandatory in process element phase.
- Parameters:
inputElementMapper- serializable function from input and to output
-
withSetupAction
final MapElementFn<InputT, OutputT> withSetupAction(SerializableAction setupAction)
Method that takes the fr.groupbees.midgard.transforms.SerializableAction that will be evaluated in the setup phase.
This function is not mandatory in the setup phase.
- Parameters:
setupAction- setup action
-
withStartBundleAction
final MapElementFn<InputT, OutputT> withStartBundleAction(SerializableAction startBundleAction)
Method that takes the fr.groupbees.midgard.transforms.SerializableAction that will be evaluated in the start bundle phase.
This function is not mandatory in the start bundle phase.
- Parameters:
startBundleAction- start bundle action
-
withFinishBundleAction
final MapElementFn<InputT, OutputT> withFinishBundleAction(SerializableAction finishBundleAction)
Method that takes the fr.groupbees.midgard.transforms.SerializableAction that will be evaluated in the finish bundle phase.
This function is not mandatory in the finish bundle phase.
- Parameters:
finishBundleAction- finish bundle action
-
withTeardownAction
final MapElementFn<InputT, OutputT> withTeardownAction(SerializableAction teardownAction)
Method that takes the fr.groupbees.midgard.transforms.SerializableAction that will be evaluated in the teardown phase.
This function is not mandatory in the teardown phase.
- Parameters:
teardownAction- teardown action
-
startBundle
@DoFn.StartBundle() final Unit startBundle()
Start bundle action in the DoFn worker lifecycle.
-
finishBundle
@DoFn.FinishBundle() final Unit finishBundle()
Finish bundle action in the DoFn worker lifecycle.
-
processElement
@DoFn.ProcessElement() final Unit processElement(DoFn.ProcessContext<InputT, OutputT> ctx)
ProcessElement.
- Parameters:
ctx- a ProcessContext object
-
-
-
-