Package org.apache.beam.sdk.values

Class PCollectionViews

java.lang.Object

org.apache.beam.sdk.values.PCollectionViews

@Internal
public class PCollectionViews
extends java.lang.Object

For internal use only; no backwards compatibility guarantees.

Implementations of PCollectionView shared across the SDK.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PCollectionViews.HasDefaultValue<T>
static class	PCollectionViews.IterableViewFn<T>	Deprecated. See PCollectionViews.IterableViewFn2.
static class	PCollectionViews.IterableViewFn2<T>	Implementation which is able to adapt an iterable materialization to a Iterable<T>.
static class	PCollectionViews.ListViewFn<T>	Deprecated. See PCollectionViews.ListViewFn2.
static class	PCollectionViews.ListViewFn2<T>	Implementation which is able to adapt a multimap materialization to a List<T>.
static class	PCollectionViews.MapViewFn<K,V>	Deprecated. See PCollectionViews.MapViewFn2.
static class	PCollectionViews.MapViewFn2<K,V>	Implementation which is able to adapt a multimap materialization to a Map<K, V>.
static class	PCollectionViews.MultimapViewFn<K,V>	Deprecated. See PCollectionViews.MultimapViewFn2.
static class	PCollectionViews.MultimapViewFn2<K,V>	Implementation which is able to adapt a multimap materialization to a Map<K, Iterable<V>>.
static class	PCollectionViews.SimplePCollectionView<ElemT,PrimitiveViewT,ViewT,W extends BoundedWindow>	A class for PCollectionView implementations, with additional type parameters that are not visible at pipeline assembly time when the view is used as a side input.
static class	PCollectionViews.SingletonViewFn<T>	Deprecated. See PCollectionViews.SingletonViewFn2.
static class	PCollectionViews.SingletonViewFn2<T>	Implementation which is able to adapt an iterable materialization to a T.
static interface	PCollectionViews.TypeDescriptorSupplier<T>
static class	PCollectionViews.ValueOrMetadata<T,MetaT>	Stores values or metadata about values.
static class	PCollectionViews.ValueOrMetadataCoder<T,MetaT>	A coder for PCollectionViews.ValueOrMetadata.

Constructor Summary

Constructors

Constructor	Description
PCollectionViews()

Method Summary

Modifier and Type	Method	Description
static <T,W extends BoundedWindow> PCollectionView<java.lang.Iterable<T>>	iterableView(PCollection<T> pCollection, PCollectionViews.TypeDescriptorSupplier<T> typeDescriptorSupplier, WindowingStrategy<?,W> windowingStrategy)	Returns a PCollectionView<Iterable<T>> capable of processing elements windowed using the provided WindowingStrategy.
static <T,W extends BoundedWindow> PCollectionView<java.lang.Iterable<T>>	iterableViewUsingVoidKey(TupleTag<Materializations.MultimapView<java.lang.Void,T>> tag, PCollection<KV<java.lang.Void,T>> pCollection, PCollectionViews.TypeDescriptorSupplier<T> typeDescriptorSupplier, WindowingStrategy<?,W> windowingStrategy)	Deprecated. See iterableView(org.apache.beam.sdk.values.PCollection<T>, org.apache.beam.sdk.values.PCollectionViews.TypeDescriptorSupplier<T>, org.apache.beam.sdk.values.WindowingStrategy<?, W>).
static <T,W extends BoundedWindow> PCollectionView<java.util.List<T>>	listView(PCollection<KV<java.lang.Long,PCollectionViews.ValueOrMetadata<T,OffsetRange>>> pCollection, PCollectionViews.TypeDescriptorSupplier<T> typeDescriptorSupplier, WindowingStrategy<?,W> windowingStrategy)	Returns a PCollectionView<List<T>> capable of processing elements windowed using the provided WindowingStrategy.
static <T,W extends BoundedWindow> PCollectionView<java.util.List<T>>	listView(PCollection<KV<java.lang.Long,PCollectionViews.ValueOrMetadata<T,OffsetRange>>> pCollection, TupleTag<Materializations.MultimapView<java.lang.Long,PCollectionViews.ValueOrMetadata<T,OffsetRange>>> tag, PCollectionViews.TypeDescriptorSupplier<T> typeDescriptorSupplier, WindowingStrategy<?,W> windowingStrategy)	Returns a PCollectionView<List<T>> capable of processing elements windowed using the provided WindowingStrategy.
static <T,W extends BoundedWindow> PCollectionView<java.util.List<T>>	listViewUsingVoidKey(PCollection<KV<java.lang.Void,T>> pCollection, TupleTag<Materializations.MultimapView<java.lang.Void,T>> tag, PCollectionViews.TypeDescriptorSupplier<T> typeDescriptorSupplier, WindowingStrategy<?,W> windowingStrategy)	Deprecated. See listView(org.apache.beam.sdk.values.PCollection<org.apache.beam.sdk.values.KV<java.lang.Long, org.apache.beam.sdk.values.PCollectionViews.ValueOrMetadata<T, org.apache.beam.sdk.io.range.OffsetRange>>>, org.apache.beam.sdk.values.PCollectionViews.TypeDescriptorSupplier<T>, org.apache.beam.sdk.values.WindowingStrategy<?, W>).
static <T,W extends BoundedWindow> PCollectionView<java.util.List<T>>	listViewUsingVoidKey(TupleTag<Materializations.MultimapView<java.lang.Void,T>> tag, PCollection<KV<java.lang.Void,T>> pCollection, PCollectionViews.TypeDescriptorSupplier<T> typeDescriptorSupplier, WindowingStrategy<?,W> windowingStrategy)	Deprecated. See listView(org.apache.beam.sdk.values.PCollection<org.apache.beam.sdk.values.KV<java.lang.Long, org.apache.beam.sdk.values.PCollectionViews.ValueOrMetadata<T, org.apache.beam.sdk.io.range.OffsetRange>>>, org.apache.beam.sdk.values.PCollectionViews.TypeDescriptorSupplier<T>, org.apache.beam.sdk.values.WindowingStrategy<?, W>).
static <K,V,W extends BoundedWindow> PCollectionView<java.util.Map<K,V>>	mapView(PCollection<KV<K,V>> pCollection, PCollectionViews.TypeDescriptorSupplier<K> keyTypeDescriptorSupplier, PCollectionViews.TypeDescriptorSupplier<V> valueTypeDescriptorSupplier, WindowingStrategy<?,W> windowingStrategy)	Returns a PCollectionView<Map<K, V>> capable of processing elements windowed using the provided WindowingStrategy.
static <K,V,W extends BoundedWindow> PCollectionView<java.util.Map<K,V>>	mapViewUsingVoidKey(TupleTag<Materializations.MultimapView<java.lang.Void,KV<K,V>>> tag, PCollection<KV<java.lang.Void,KV<K,V>>> pCollection, PCollectionViews.TypeDescriptorSupplier<K> keyTypeDescriptorSupplier, PCollectionViews.TypeDescriptorSupplier<V> valueTypeDescriptorSupplier, WindowingStrategy<?,W> windowingStrategy)	Deprecated. See mapView(org.apache.beam.sdk.values.PCollection<org.apache.beam.sdk.values.KV<K, V>>, org.apache.beam.sdk.values.PCollectionViews.TypeDescriptorSupplier<K>, org.apache.beam.sdk.values.PCollectionViews.TypeDescriptorSupplier<V>, org.apache.beam.sdk.values.WindowingStrategy<?, W>).
static <K,V,W extends BoundedWindow> PCollectionView<java.util.Map<K,java.lang.Iterable<V>>>	multimapView(PCollection<KV<K,V>> pCollection, PCollectionViews.TypeDescriptorSupplier<K> keyTypeDescriptorSupplier, PCollectionViews.TypeDescriptorSupplier<V> valueTypeDescriptorSupplier, WindowingStrategy<?,W> windowingStrategy)	Returns a PCollectionView<Map<K, Iterable<V>>> capable of processing elements windowed using the provided WindowingStrategy.
static <K,V,W extends BoundedWindow> PCollectionView<java.util.Map<K,java.lang.Iterable<V>>>	multimapViewUsingVoidKey(TupleTag<Materializations.MultimapView<java.lang.Void,KV<K,V>>> tag, PCollection<KV<java.lang.Void,KV<K,V>>> pCollection, PCollectionViews.TypeDescriptorSupplier<K> keyTypeDescriptorSupplier, PCollectionViews.TypeDescriptorSupplier<V> valueTypeDescriptorSupplier, WindowingStrategy<?,W> windowingStrategy)	Deprecated. See multimapView(org.apache.beam.sdk.values.PCollection<org.apache.beam.sdk.values.KV<K, V>>, org.apache.beam.sdk.values.PCollectionViews.TypeDescriptorSupplier<K>, org.apache.beam.sdk.values.PCollectionViews.TypeDescriptorSupplier<V>, org.apache.beam.sdk.values.WindowingStrategy<?, W>).
static <T,W extends BoundedWindow> PCollectionView<T>	singletonView(PCollection<T> pCollection, PCollectionViews.TypeDescriptorSupplier<T> typeDescriptorSupplier, WindowingStrategy<?,W> windowingStrategy, boolean hasDefault, @Nullable T defaultValue, Coder<T> defaultValueCoder)	Returns a PCollectionView<T> capable of processing elements windowed using the provided WindowingStrategy.
static <T,W extends BoundedWindow> PCollectionView<T>	singletonViewUsingVoidKey(TupleTag<Materializations.MultimapView<java.lang.Void,T>> tag, PCollection<KV<java.lang.Void,T>> pCollection, PCollectionViews.TypeDescriptorSupplier<T> typeDescriptorSupplier, WindowingStrategy<?,W> windowingStrategy, boolean hasDefault, @Nullable T defaultValue, Coder<T> defaultValueCoder)	Deprecated. See singletonView(org.apache.beam.sdk.values.PCollection<T>, org.apache.beam.sdk.values.PCollectionViews.TypeDescriptorSupplier<T>, org.apache.beam.sdk.values.WindowingStrategy<?, W>, boolean, T, org.apache.beam.sdk.coders.Coder<T>).
static java.util.Map<TupleTag<?>,PValue>	toAdditionalInputs(java.lang.Iterable<PCollectionView<?>> views)	Expands a list of PCollectionView into the form needed for PTransform.getAdditionalInputs().

Methods inherited from class java.lang.Object

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

Constructor Detail

PCollectionViews

public PCollectionViews()

Method Detail

singletonView

public static <T,W extends BoundedWindow> PCollectionView<T> singletonView(PCollection<T> pCollection,
                                                                                 PCollectionViews.TypeDescriptorSupplier<T> typeDescriptorSupplier,
                                                                                 WindowingStrategy<?,W> windowingStrategy,
                                                                                 boolean hasDefault,
                                                                                 @Nullable T defaultValue,
                                                                                 Coder<T> defaultValueCoder)

Returns a PCollectionView<T> capable of processing elements windowed using the provided WindowingStrategy.

If hasDefault is true, then the view will take on the value defaultValue for any empty windows.

singletonViewUsingVoidKey

@Deprecated
public static <T,W extends BoundedWindow> PCollectionView<T> singletonViewUsingVoidKey(TupleTag<Materializations.MultimapView<java.lang.Void,T>> tag,
                                                                                             PCollection<KV<java.lang.Void,T>> pCollection,
                                                                                             PCollectionViews.TypeDescriptorSupplier<T> typeDescriptorSupplier,
                                                                                             WindowingStrategy<?,W> windowingStrategy,
                                                                                             boolean hasDefault,
                                                                                             @Nullable T defaultValue,
                                                                                             Coder<T> defaultValueCoder)

Deprecated.

See singletonView(org.apache.beam.sdk.values.PCollection<T>, org.apache.beam.sdk.values.PCollectionViews.TypeDescriptorSupplier<T>, org.apache.beam.sdk.values.WindowingStrategy<?, W>, boolean, T, org.apache.beam.sdk.coders.Coder<T>).

Returns a PCollectionView<T> capable of processing elements windowed using the provided WindowingStrategy.

If hasDefault is true, then the view will take on the value defaultValue for any empty windows.

iterableView

public static <T,W extends BoundedWindow> PCollectionView<java.lang.Iterable<T>> iterableView(PCollection<T> pCollection,
                                                                                                    PCollectionViews.TypeDescriptorSupplier<T> typeDescriptorSupplier,
                                                                                                    WindowingStrategy<?,W> windowingStrategy)

Returns a PCollectionView<Iterable<T>> capable of processing elements windowed using the provided WindowingStrategy.

iterableViewUsingVoidKey

@Deprecated
public static <T,W extends BoundedWindow> PCollectionView<java.lang.Iterable<T>> iterableViewUsingVoidKey(TupleTag<Materializations.MultimapView<java.lang.Void,T>> tag,
                                                                                                                PCollection<KV<java.lang.Void,T>> pCollection,
                                                                                                                PCollectionViews.TypeDescriptorSupplier<T> typeDescriptorSupplier,
                                                                                                                WindowingStrategy<?,W> windowingStrategy)

Deprecated.

See iterableView(org.apache.beam.sdk.values.PCollection<T>, org.apache.beam.sdk.values.PCollectionViews.TypeDescriptorSupplier<T>, org.apache.beam.sdk.values.WindowingStrategy<?, W>).

Returns a PCollectionView<Iterable<T>> capable of processing elements windowed using the provided WindowingStrategy.

listView

public static <T,W extends BoundedWindow> PCollectionView<java.util.List<T>> listView(PCollection<KV<java.lang.Long,PCollectionViews.ValueOrMetadata<T,OffsetRange>>> pCollection,
                                                                                            PCollectionViews.TypeDescriptorSupplier<T> typeDescriptorSupplier,
                                                                                            WindowingStrategy<?,W> windowingStrategy)

Returns a PCollectionView<List<T>> capable of processing elements windowed using the provided WindowingStrategy.

listView

public static <T,W extends BoundedWindow> PCollectionView<java.util.List<T>> listView(PCollection<KV<java.lang.Long,PCollectionViews.ValueOrMetadata<T,OffsetRange>>> pCollection,
                                                                                            TupleTag<Materializations.MultimapView<java.lang.Long,PCollectionViews.ValueOrMetadata<T,OffsetRange>>> tag,
                                                                                            PCollectionViews.TypeDescriptorSupplier<T> typeDescriptorSupplier,
                                                                                            WindowingStrategy<?,W> windowingStrategy)

Returns a PCollectionView<List<T>> capable of processing elements windowed using the provided WindowingStrategy.

listViewUsingVoidKey

@Deprecated
public static <T,W extends BoundedWindow> PCollectionView<java.util.List<T>> listViewUsingVoidKey(TupleTag<Materializations.MultimapView<java.lang.Void,T>> tag,
                                                                                                        PCollection<KV<java.lang.Void,T>> pCollection,
                                                                                                        PCollectionViews.TypeDescriptorSupplier<T> typeDescriptorSupplier,
                                                                                                        WindowingStrategy<?,W> windowingStrategy)

Deprecated.

See listView(org.apache.beam.sdk.values.PCollection<org.apache.beam.sdk.values.KV<java.lang.Long, org.apache.beam.sdk.values.PCollectionViews.ValueOrMetadata<T, org.apache.beam.sdk.io.range.OffsetRange>>>, org.apache.beam.sdk.values.PCollectionViews.TypeDescriptorSupplier<T>, org.apache.beam.sdk.values.WindowingStrategy<?, W>).

Returns a PCollectionView<List<T>> capable of processing elements windowed using the provided WindowingStrategy.

listViewUsingVoidKey

@Deprecated
public static <T,W extends BoundedWindow> PCollectionView<java.util.List<T>> listViewUsingVoidKey(PCollection<KV<java.lang.Void,T>> pCollection,
                                                                                                        TupleTag<Materializations.MultimapView<java.lang.Void,T>> tag,
                                                                                                        PCollectionViews.TypeDescriptorSupplier<T> typeDescriptorSupplier,
                                                                                                        WindowingStrategy<?,W> windowingStrategy)

Deprecated.

See listView(org.apache.beam.sdk.values.PCollection<org.apache.beam.sdk.values.KV<java.lang.Long, org.apache.beam.sdk.values.PCollectionViews.ValueOrMetadata<T, org.apache.beam.sdk.io.range.OffsetRange>>>, org.apache.beam.sdk.values.PCollectionViews.TypeDescriptorSupplier<T>, org.apache.beam.sdk.values.WindowingStrategy<?, W>).

Returns a PCollectionView<List<T>> capable of processing elements windowed using the provided WindowingStrategy.

mapView

public static <K,V,W extends BoundedWindow> PCollectionView<java.util.Map<K,V>> mapView(PCollection<KV<K,V>> pCollection,
                                                                                                          PCollectionViews.TypeDescriptorSupplier<K> keyTypeDescriptorSupplier,
                                                                                                          PCollectionViews.TypeDescriptorSupplier<V> valueTypeDescriptorSupplier,
                                                                                                          WindowingStrategy<?,W> windowingStrategy)

Returns a PCollectionView<Map<K, V>> capable of processing elements windowed using the provided WindowingStrategy.

mapViewUsingVoidKey

@Deprecated
public static <K,V,W extends BoundedWindow> PCollectionView<java.util.Map<K,V>> mapViewUsingVoidKey(TupleTag<Materializations.MultimapView<java.lang.Void,KV<K,V>>> tag,
                                                                                                                      PCollection<KV<java.lang.Void,KV<K,V>>> pCollection,
                                                                                                                      PCollectionViews.TypeDescriptorSupplier<K> keyTypeDescriptorSupplier,
                                                                                                                      PCollectionViews.TypeDescriptorSupplier<V> valueTypeDescriptorSupplier,
                                                                                                                      WindowingStrategy<?,W> windowingStrategy)

Deprecated.

See mapView(org.apache.beam.sdk.values.PCollection<org.apache.beam.sdk.values.KV<K, V>>, org.apache.beam.sdk.values.PCollectionViews.TypeDescriptorSupplier<K>, org.apache.beam.sdk.values.PCollectionViews.TypeDescriptorSupplier<V>, org.apache.beam.sdk.values.WindowingStrategy<?, W>).

Returns a PCollectionView<Map<K, V>> capable of processing elements windowed using the provided WindowingStrategy.

multimapView

public static <K,V,W extends BoundedWindow> PCollectionView<java.util.Map<K,java.lang.Iterable<V>>> multimapView(PCollection<KV<K,V>> pCollection,
                                                                                                                                   PCollectionViews.TypeDescriptorSupplier<K> keyTypeDescriptorSupplier,
                                                                                                                                   PCollectionViews.TypeDescriptorSupplier<V> valueTypeDescriptorSupplier,
                                                                                                                                   WindowingStrategy<?,W> windowingStrategy)

Returns a PCollectionView<Map<K, Iterable<V>>> capable of processing elements windowed using the provided WindowingStrategy.

multimapViewUsingVoidKey

@Deprecated
public static <K,V,W extends BoundedWindow> PCollectionView<java.util.Map<K,java.lang.Iterable<V>>> multimapViewUsingVoidKey(TupleTag<Materializations.MultimapView<java.lang.Void,KV<K,V>>> tag,
                                                                                                                                               PCollection<KV<java.lang.Void,KV<K,V>>> pCollection,
                                                                                                                                               PCollectionViews.TypeDescriptorSupplier<K> keyTypeDescriptorSupplier,
                                                                                                                                               PCollectionViews.TypeDescriptorSupplier<V> valueTypeDescriptorSupplier,
                                                                                                                                               WindowingStrategy<?,W> windowingStrategy)

Deprecated.

See multimapView(org.apache.beam.sdk.values.PCollection<org.apache.beam.sdk.values.KV<K, V>>, org.apache.beam.sdk.values.PCollectionViews.TypeDescriptorSupplier<K>, org.apache.beam.sdk.values.PCollectionViews.TypeDescriptorSupplier<V>, org.apache.beam.sdk.values.WindowingStrategy<?, W>).

Returns a PCollectionView<Map<K, Iterable<V>>> capable of processing elements windowed using the provided WindowingStrategy.

toAdditionalInputs

public static java.util.Map<TupleTag<?>,PValue> toAdditionalInputs(java.lang.Iterable<PCollectionView<?>> views)

Expands a list of PCollectionView into the form needed for PTransform.getAdditionalInputs().