Interface PCollectionView<T>
-
- Type Parameters:
T
- the type of the value(s) accessible via thisPCollectionView
- All Known Implementing Classes:
PCollectionViews.SimplePCollectionView
public interface PCollectionView<T> extends PValue, java.io.Serializable
APCollectionView<T>
is an immutable view of aPCollection
as a value of typeT
that can be accessed as a side input to aParDo
transform.A
PCollectionView
should always be the output of aPTransform
. It is the joint responsibility of this transform and eachPipelineRunner
to implement the view in a runner-specific manner.The most common case is using the
View
transforms to prepare aPCollection
for use as a side input toParDo
. SeeView.asSingleton()
,View.asIterable()
, andView.asMap()
for more detail on specific views available in the SDK.NOTE: View methods should not be considered to be user-accessible. They are implementation details of how a Runner obtains information required to construct a view, and are subject to change at any time.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description Coder<?>
getCoderInternal()
Deprecated.this method will be removed entirely.@Nullable PCollection<?>
getPCollection()
For internal use only.TupleTag<?>
getTagInternal()
Deprecated.this method will be removed entirely.ViewFn<?,T>
getViewFn()
Deprecated.this method will be removed entirely.WindowingStrategy<?,?>
getWindowingStrategyInternal()
Deprecated.this method will be removed entirely.WindowMappingFn<?>
getWindowMappingFn()
For internal use only.-
Methods inherited from interface org.apache.beam.sdk.values.PInput
getPipeline
-
Methods inherited from interface org.apache.beam.sdk.values.POutput
finishSpecifyingOutput, getPipeline
-
Methods inherited from interface org.apache.beam.sdk.values.PValue
expand, finishSpecifying, getName
-
-
-
-
Method Detail
-
getPCollection
@Internal @Nullable PCollection<?> getPCollection()
For internal use only.Gets the
PCollection
thisPCollectionView
was created from.The
PCollection
may not be available in all contexts.
-
getTagInternal
@Deprecated @Internal TupleTag<?> getTagInternal()
Deprecated.this method will be removed entirely. ThePCollection
underlying a side input, is part of the side input's specification with aParDo
transform, which will obtain that information via a package-private channel.For internal use only.
-
getWindowMappingFn
@Experimental(CORE_RUNNERS_ONLY) @Internal WindowMappingFn<?> getWindowMappingFn()
For internal use only.Returns the
WindowMappingFn
used to map windows from a main input to the side input of thisPCollectionView
.
-
getWindowingStrategyInternal
@Deprecated @Internal WindowingStrategy<?,?> getWindowingStrategyInternal()
Deprecated.this method will be removed entirely. ThePCollection
underlying a side input, including itsWindowingStrategy
, is part of the side input's specification with aParDo
transform, which will obtain that information via a package-private channel.For internal use only.
-
getCoderInternal
@Deprecated @Internal Coder<?> getCoderInternal()
Deprecated.this method will be removed entirely. ThePCollection
underlying a side input, including itsCoder
, is part of the side input's specification with aParDo
transform, which will obtain that information via a package-private channel.For internal use only.
-
-