org.apache.beam.runners.fnexecution.control

Class ProcessBundleDescriptors

java.lang.Object

org.apache.beam.runners.fnexecution.control.ProcessBundleDescriptors

public class ProcessBundleDescriptors
extends java.lang.Object

Utility methods for creating BeamFnApi.ProcessBundleDescriptor instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProcessBundleDescriptors.BagUserStateSpec<K,V,W extends BoundedWindow> A container type storing references to the key, value, and window Coder used when handling bag user state requests.
static class	ProcessBundleDescriptors.ExecutableProcessBundleDescriptor
static class	ProcessBundleDescriptors.SideInputSpec<T,W extends BoundedWindow> A container type storing references to the value, and window Coder used when handling side input state requests.
static class	ProcessBundleDescriptors.TimerSpec<K,V,W extends BoundedWindow> A container type storing references to the key, timer and payload coders and the remote input destination used when handling timer requests.

Constructor Summary

Constructors

Constructor and Description
ProcessBundleDescriptors()

Method Summary

Modifier and Type	Method and Description
static ProcessBundleDescriptors.ExecutableProcessBundleDescriptor	fromExecutableStage(java.lang.String id, org.apache.beam.sdk.util.construction.graph.ExecutableStage stage, org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor dataEndpoint)
static ProcessBundleDescriptors.ExecutableProcessBundleDescriptor	fromExecutableStage(java.lang.String id, org.apache.beam.sdk.util.construction.graph.ExecutableStage stage, org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor dataEndpoint, org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor stateEndpoint) Note that the BeamFnApi.ProcessBundleDescriptor is constructed by: Adding gRPC read and write nodes wiring them to the specified data endpoint.
static java.util.Map<java.lang.String,java.util.Map<java.lang.String,ProcessBundleDescriptors.SideInputSpec>>	getSideInputs(org.apache.beam.sdk.util.construction.graph.ExecutableStage stage)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessBundleDescriptors

public ProcessBundleDescriptors()

Method Detail

fromExecutableStage

public static ProcessBundleDescriptors.ExecutableProcessBundleDescriptor fromExecutableStage(java.lang.String id,
                                                                                             org.apache.beam.sdk.util.construction.graph.ExecutableStage stage,
                                                                                             org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor dataEndpoint,
                                                                                             org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor stateEndpoint)
                                                                                      throws java.io.IOException

Note that the BeamFnApi.ProcessBundleDescriptor is constructed by:

• Adding gRPC read and write nodes wiring them to the specified data endpoint.
• Setting the state Endpoints.ApiServiceDescriptor to the specified state endpoint.
• Modifying the coder on PCollections that are accessed as side inputs to be length prefixed making them binary compatible with the coder chosen when that side input is materialized.

Throws:

java.io.IOException

fromExecutableStage

public static ProcessBundleDescriptors.ExecutableProcessBundleDescriptor fromExecutableStage(java.lang.String id,
                                                                                             org.apache.beam.sdk.util.construction.graph.ExecutableStage stage,
                                                                                             org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor dataEndpoint)
                                                                                      throws java.io.IOException

Throws:

java.io.IOException

getSideInputs

public static java.util.Map<java.lang.String,java.util.Map<java.lang.String,ProcessBundleDescriptors.SideInputSpec>> getSideInputs(org.apache.beam.sdk.util.construction.graph.ExecutableStage stage)
                                                                                                                            throws java.io.IOException

Throws:

java.io.IOException