org.apache.beam.sdk.util.construction.graph

Interface ProtoOverrides.TransformReplacement

Enclosing class:

ProtoOverrides

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public static interface ProtoOverrides.TransformReplacement

A Function that takes a transform and the existing components and returns the new composite PTransform and additional components.

Method Summary

Modifier and Type	Method and Description
@Nullable org.apache.beam.model.pipeline.v1.RunnerApi.MessageWithComponents	getReplacement(java.lang.String transformId, org.apache.beam.model.pipeline.v1.RunnerApi.ComponentsOrBuilder existingComponents) Returns the updated composite structure for the provided RunnerApi.PTransform.

Method Detail

getReplacement

@Nullable org.apache.beam.model.pipeline.v1.RunnerApi.MessageWithComponents getReplacement(java.lang.String transformId,
                                                                                           org.apache.beam.model.pipeline.v1.RunnerApi.ComponentsOrBuilder existingComponents)

Returns the updated composite structure for the provided RunnerApi.PTransform.

If the return is null, then no replacement is performed, otherwise the returned RunnerApi.MessageWithComponents must contain a single RunnerApi.PTransform. The result RunnerApi.Components will be merged into the existing components, and the result RunnerApi.PTransform will be set as a replacement of the original RunnerApi.PTransform. Notably, this does not require that the existingComponents are present in the returned RunnerApi.MessageWithComponents.

Introduced components must not collide with any components in the existing components.