com.google.cloud.dataflow.sdk.util

Interface SideInputReader

All Known Subinterfaces:

SizedSideInputReader

All Known Implementing Classes:

DataflowSideInputReader, DirectSideInputReader, NullSideInputReader, SizedSideInputReader.Defaults, StreamingModeExecutionContext.StreamingModeSideInputReader

public interface SideInputReader

The interface to objects that provide side inputs. Particular implementations may read a side input directly or use appropriate sorts of caching, etc.

Method Summary

Modifier and Type	Method and Description
<T> boolean	contains(PCollectionView<T> view) Returns true if the given PCollectionView is valid for this reader.
<T> T	get(PCollectionView<T> view, BoundedWindow window) Returns the value of the given PCollectionView for the given BoundedWindow.
boolean	isEmpty() Returns true if there are no side inputs in this reader.

Method Detail

get

@Nullable
<T> T get(PCollectionView<T> view,
                    BoundedWindow window)

Returns the value of the given PCollectionView for the given BoundedWindow.

It is valid for a side input to be null. It is not valid for this to return null for any other reason.

contains

<T> boolean contains(PCollectionView<T> view)

Returns true if the given PCollectionView is valid for this reader.

isEmpty

boolean isEmpty()

Returns true if there are no side inputs in this reader.