org.apache.beam.sdk.util.construction

Class ExecutableStageTranslation

java.lang.Object

org.apache.beam.sdk.util.construction.ExecutableStageTranslation

public class ExecutableStageTranslation
extends java.lang.Object

Utilities for converting ExecutableStages to and from RunnerApi protocol buffers.

Constructor Summary

Constructors

Constructor and Description
ExecutableStageTranslation()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	generateNameFromStagePayload(org.apache.beam.model.pipeline.v1.RunnerApi.ExecutableStagePayload stagePayload)
static java.lang.String	generateNameFromTransformNames(java.util.Collection<java.lang.String> names, boolean truncateSiblingComposites) Creates a human-readable name for a set of stage names that occur in a single stage.
static org.apache.beam.model.pipeline.v1.RunnerApi.ExecutableStagePayload	getExecutableStagePayload(AppliedPTransform<?,?,?> appliedTransform) Extracts an RunnerApi.ExecutableStagePayload from the given transform.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutableStageTranslation

public ExecutableStageTranslation()

Method Detail

getExecutableStagePayload

public static org.apache.beam.model.pipeline.v1.RunnerApi.ExecutableStagePayload getExecutableStagePayload(AppliedPTransform<?,?,?> appliedTransform)
                                                                                                    throws java.io.IOException

Extracts an RunnerApi.ExecutableStagePayload from the given transform.

Throws:

java.io.IOException

generateNameFromStagePayload

public static java.lang.String generateNameFromStagePayload(org.apache.beam.model.pipeline.v1.RunnerApi.ExecutableStagePayload stagePayload)

generateNameFromTransformNames

public static java.lang.String generateNameFromTransformNames(java.util.Collection<java.lang.String> names,
                                                              boolean truncateSiblingComposites)

Creates a human-readable name for a set of stage names that occur in a single stage.

This name reflects the nested structure of the stages, as inferred by slashes in the stage names. Sibling stages will be listed as {A, B}, nested stages as A/B, and according to the value of truncateSiblingComposites the nesting stops at the first level that siblings are encountered.

This is best understood via examples, of which there are several in the tests for this class.

Parameters:

names - a list of full stage names in this fused operation

truncateSiblingComposites - whether to recursively descent into composite operations that have simblings, or stop the recursion at that level.

Returns:

a single string representation of all the stages in this fused operation