com.google.cloud.dataflow.sdk.util

Class BaseExecutionContext.StepContext

java.lang.Object

com.google.cloud.dataflow.sdk.util.BaseExecutionContext.StepContext

All Implemented Interfaces:

ExecutionContext.StepContext

Enclosing class:

BaseExecutionContext

public abstract static class BaseExecutionContext.StepContext
extends Object
implements ExecutionContext.StepContext

Base class for implementations of ExecutionContext.StepContext.

To complete a concrete subclass, implement timerInternals() and stateInternals().

Constructor Summary

Constructors

Constructor and Description
StepContext(ExecutionContext executionContext, String stepName, String transformName)

Method Summary

Modifier and Type	Method and Description
ExecutionContext	getExecutionContext() The context in which this step is executing.
String	getStepName() The name of the step.
String	getTransformName() The name of the transform for the step.
void	noteOutput(WindowedValue<?> output) Hook for subclasses to implement that will be called whenever DoFn.Context.output(OutputT) is called.
void	noteSideOutput(TupleTag<?> tag, WindowedValue<?> output) Hook for subclasses to implement that will be called whenever DoFn.Context.sideOutput(com.google.cloud.dataflow.sdk.values.TupleTag<T>, T) is called.
abstract StateInternals	stateInternals()
abstract TimerInternals	timerInternals()
<T,W extends BoundedWindow> void	writePCollectionViewData(TupleTag<?> tag, Iterable<WindowedValue<T>> data, Coder<Iterable<WindowedValue<T>>> dataCoder, W window, Coder<W> windowCoder) Writes the given PCollectionView data to a globally accessible location.

Methods inherited from class java.lang.Object

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

Constructor Detail

StepContext

public StepContext(ExecutionContext executionContext,
                   String stepName,
                   String transformName)

Method Detail

getStepName

public String getStepName()

Description copied from interface: ExecutionContext.StepContext

The name of the step.

Specified by:

getStepName in interface ExecutionContext.StepContext

getTransformName

public String getTransformName()

Description copied from interface: ExecutionContext.StepContext

The name of the transform for the step.

Specified by:

getTransformName in interface ExecutionContext.StepContext

getExecutionContext

public ExecutionContext getExecutionContext()

Description copied from interface: ExecutionContext.StepContext

The context in which this step is executing.

Specified by:

getExecutionContext in interface ExecutionContext.StepContext

noteOutput

public void noteOutput(WindowedValue<?> output)

Description copied from interface: ExecutionContext.StepContext

Hook for subclasses to implement that will be called whenever DoFn.Context.output(OutputT) is called.

Specified by:

noteOutput in interface ExecutionContext.StepContext

noteSideOutput

public void noteSideOutput(TupleTag<?> tag,
                           WindowedValue<?> output)

Description copied from interface: ExecutionContext.StepContext

Hook for subclasses to implement that will be called whenever DoFn.Context.sideOutput(com.google.cloud.dataflow.sdk.values.TupleTag<T>, T) is called.

Specified by:

noteSideOutput in interface ExecutionContext.StepContext

writePCollectionViewData

public <T,W extends BoundedWindow> void writePCollectionViewData(TupleTag<?> tag,
                                                                 Iterable<WindowedValue<T>> data,
                                                                 Coder<Iterable<WindowedValue<T>>> dataCoder,
                                                                 W window,
                                                                 Coder<W> windowCoder)
                                                          throws IOException

Description copied from interface: ExecutionContext.StepContext

Writes the given PCollectionView data to a globally accessible location.

Specified by:

writePCollectionViewData in interface ExecutionContext.StepContext

Throws:

IOException

stateInternals

public abstract StateInternals stateInternals()

Specified by:

stateInternals in interface ExecutionContext.StepContext

timerInternals

public abstract TimerInternals timerInternals()

Specified by:

timerInternals in interface ExecutionContext.StepContext