Package org.apache.beam.sdk.values

@DefaultAnnotation(org.checkerframework.checker.nullness.qual.NonNull.class) package org.apache.beam.sdk.values

Defines PCollection and other classes for representing data in a Pipeline.

In particular, see these collection abstractions:

• PCollection - an immutable collection of values of type T and the main representation for data in Beam.
• PCollectionView - an immutable view of a PCollection that can be accessed as a side input of a ParDo PTransform.
• PCollectionTuple - a heterogeneous tuple of PCollections used in cases where a PTransform takes or returns multiple PCollections.
• PCollectionList - a homogeneous list of PCollections used, for example, as input to Flatten.

And these classes for individual values play particular roles in Beam:

• KV - a key/value pair that is used by keyed transforms, most notably GroupByKey.
• TimestampedValue - a timestamp/value pair that is used for windowing and handling out-of-order data in streaming execution.

For further details, see the documentation for each class in this package.

Related Packages

Package	Description
org.apache.beam.sdk	Provides a simple, powerful model for building both batch and streaming parallel data processing Pipelines.

Class	Description
EncodableThrowable	A wrapper around a Throwable for use with coders.
FailsafeValueInSingleWindow<T,ErrorT>	An immutable tuple of value, timestamp, window, and pane.
FailsafeValueInSingleWindow.Coder<T,ErrorT>	A coder for FailsafeValueInSingleWindow.
KV<K,V>	An immutable key/value pair.
KV.OrderByKey<K extends Comparable<? super K>,V>	A Comparator that orders KVs by the natural ordering of their keys.
KV.OrderByValue<K,V extends Comparable<? super V>>	A Comparator that orders KVs by the natural ordering of their values.
OutputBuilder<T>	A builder for an output, to set all the fields and extended metadata of a Beam value.
PBegin	PBegin is the "input" to a root PTransform, such as Read or Create.
PCollection<T>	A PCollection<T> is an immutable collection of values of type T.
PCollection.IsBounded	The enumeration of cases for whether a PCollection is bounded.
PCollectionList<T>	A PCollectionList<T> is an immutable list of homogeneously typed PCollection<T>s.
PCollectionRowTuple	A PCollectionRowTuple is an immutable tuple of PCollections, "keyed" by a string tag.
PCollectionTuple	A PCollectionTuple is an immutable tuple of heterogeneously-typed PCollections, "keyed" by TupleTags.
PCollectionView<T>	A PCollectionView<T> is an immutable view of a PCollection as a value of type T that can be accessed as a side input to a ParDo transform.
PCollectionViews	For internal use only; no backwards compatibility guarantees.
PCollectionViews.HasDefaultValue<T>
PCollectionViews.InMemoryListFromMultimapViewFn<T>	Implementation which is able to adapt a multimap materialization to an in-memory List<T>.
PCollectionViews.InMemoryListViewFn<T>	Implementation which is able to adapt an iterable materialization to an in-memory List<T>.
PCollectionViews.InMemoryMapFromVoidKeyViewFn<K,V>	Implementation which is able to adapt a multimap materialization to an in-memory Map<K, V>.
PCollectionViews.InMemoryMapViewFn<K,V>	Implementation which is able to adapt an iterable materialization to an in-memory Map<K, V>.
PCollectionViews.InMemoryMultimapFromVoidKeyViewFn<K,V>	Implementation which is able to adapt a multimap materialization to an in-memory Map<K, Iterable<V>>.
PCollectionViews.InMemoryMultimapViewFn<K,V>	Implementation which is able to adapt an iterable materialization to an in-memory Map<K, Iterable<V>>.
PCollectionViews.IsSingletonView<T>
PCollectionViews.IterableBackedListViewFn<T>	Implementation which is able to adapt an iterable materialization to a List<T>.
PCollectionViews.IterableViewFn<T>	Deprecated. See PCollectionViews.IterableViewFn2.
PCollectionViews.IterableViewFn2<T>	Implementation which is able to adapt an iterable materialization to a Iterable<T>.
PCollectionViews.ListViewFn<T>	Deprecated. See PCollectionViews.ListViewFn2.
PCollectionViews.ListViewFn2<T>	Implementation which is able to adapt a multimap materialization to a List<T>.
PCollectionViews.MapViewFn<K,V>	Deprecated. See PCollectionViews.MapViewFn2.
PCollectionViews.MapViewFn2<K,V>	Implementation which is able to adapt a multimap materialization to a Map<K, V>.
PCollectionViews.MultimapViewFn<K,V>	Deprecated. See PCollectionViews.MultimapViewFn2.
PCollectionViews.MultimapViewFn2<K,V>	Implementation which is able to adapt a multimap materialization to a Map<K, Iterable<V>>.
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.
PCollectionViews.SingletonViewFn<T>	Deprecated. See PCollectionViews.SingletonViewFn2.
PCollectionViews.SingletonViewFn2<T>	Implementation which is able to adapt an iterable materialization to a T.
PCollectionViews.TypeDescriptorSupplier<T>
PCollectionViews.ValueOrMetadata<T,MetaT>	Stores values or metadata about values.
PCollectionViews.ValueOrMetadataCoder<T,MetaT>	A coder for PCollectionViews.ValueOrMetadata.
PDone	PDone is the output of a PTransform that has a trivial result, such as a WriteFiles.
PInput	The interface for things that might be input to a PTransform.
POutput	The interface for things that might be output from a PTransform.
PValue	For internal use.
PValueBase	For internal use.
PValues	For internal use.
Row	Row is an immutable tuple-like schema to represent one element in a PCollection.
Row.Builder	Builder for Row.
Row.Equals
Row.FieldValueBuilder	Builder for Row that bases a row on another row.
RowWithGetters<T extends @NonNull Object>	A Concrete subclass of Row that delegates to a set of provided FieldValueGetters.
RowWithStorage	Concrete subclass of Row that explicitly stores all fields of the row.
SchemaVerification
ShardedKey<K>	Deprecated. Use ShardedKey instead.
TaggedPValue	For internal use only; no backwards-compatibility guarantees.
TimestampedValue<V extends @Nullable Object>	An immutable pair of a value and a timestamp.
TimestampedValue.TimestampedValueCoder<T>	A Coder for TimestampedValue.
TupleTag<V>	A TupleTag is a typed tag to use as the key of a heterogeneously typed tuple, like PCollectionTuple.
TupleTagList	A TupleTagList is an immutable list of heterogeneously typed TupleTags.
TypeDescriptor<T>	A description of a Java type, including actual generic parameters where possible.
TypeDescriptors	A utility class for creating TypeDescriptor objects for different types, such as Java primitive types, containers and KVs of other TypeDescriptor objects, and extracting type variables of parameterized types (e.g.
TypeDescriptors.TypeVariableExtractor<InputT,OutputT>	A helper interface for use with TypeDescriptors.extractFromTypeParameters(Object, Class, TypeVariableExtractor).
TypeParameter<T>	Captures a free type variable that can be used in TypeDescriptor.where(org.apache.beam.sdk.values.TypeParameter<X>, org.apache.beam.sdk.values.TypeDescriptor<X>).
ValueInSingleWindow<T>	An immutable tuple of value, timestamp, window, and pane.
ValueInSingleWindow.Coder<T>	A coder for ValueInSingleWindow.
ValueWithRecordId<ValueT>	For internal use only; no backwards compatibility guarantees.
ValueWithRecordId.StripIdsDoFn<T>	DoFn to turn a ValueWithRecordId<T> back to the value T.
ValueWithRecordId.ValueWithRecordIdCoder<ValueT>	A Coder for ValueWithRecordId, using a wrapped value Coder.
WindowedValue<T>	A value along with Beam's windowing information and all other metadata.
WindowedValues	Implementations of WindowedValue and static utility methods.
WindowedValues.Builder<T>
WindowedValues.FullWindowedValueCoder<T>	Coder for WindowedValue.
WindowedValues.ParamWindowedValueCoder<T>	A parameterized coder for WindowedValue.
WindowedValues.SingleWindowedValue	A WindowedValues which holds exactly single window per value.
WindowedValues.ValueOnlyWindowedValueCoder<T>	Deprecated. Use ParamWindowedValueCoder instead, it is a general purpose implementation of the same concept but makes timestamp, windows and pane info configurable.
WindowedValues.WindowedValueCoder<T>	Abstract class for WindowedValue coder.
WindowingStrategy<T,W extends BoundedWindow>	A WindowingStrategy describes the windowing behavior for a specific collection of values.
WindowingStrategy.AccumulationMode	The accumulation modes that can be used with windowing.