KeyedPCollectionTuple (Apache Beam 2.49.0)

java.lang.Object
- org.apache.beam.sdk.transforms.join.KeyedPCollectionTuple<K>

Type Parameters:

K - the type of key shared by all constituent PCollections

All Implemented Interfaces:

PInput
```
public class KeyedPCollectionTuple<K>
extends java.lang.Object
implements PInput
```
An immutable tuple of keyed PCollections with key type K. (PCollections containing values of type KV<K, ?>)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`KeyedPCollectionTuple.TaggedKeyedPCollection<K,V>` A utility class to help ensure coherence of tag and input PCollection types.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<V> KeyedPCollectionTuple<K>`	`and(java.lang.String tag, PCollection<KV<K,V>> pc)` A version of `and(String, PCollection)` that takes in a string instead of a TupleTag.
`<V> KeyedPCollectionTuple<K>`	`and(TupleTag<V> tag, PCollection<KV<K,V>> pc)` Returns a new `KeyedPCollectionTuple<K>` that is the same as this, appended with the given PCollection.
`<OutputT extends POutput> OutputT`	`apply(PTransform<KeyedPCollectionTuple<K>,OutputT> transform)` Like `apply(String, PTransform)` but defaulting to the name provided by the `PTransform`.
`<OutputT extends POutput> OutputT`	`apply(java.lang.String name, PTransform<KeyedPCollectionTuple<K>,OutputT> transform)` Applies the given `PTransform` to this input `KeyedPCollectionTuple` and returns its `OutputT`.
`static <K> KeyedPCollectionTuple<K>`	`empty(Pipeline pipeline)` Returns an empty `KeyedPCollectionTuple<K>` on the given pipeline.
`java.util.Map<TupleTag<?>,PValue>`	`expand()` Expands the component `PCollections`, stripping off any tag-specific information.
`CoGbkResultSchema`	`getCoGbkResultSchema()` Returns the `CoGbkResultSchema` associated with this `KeyedPCollectionTuple`.
`Coder<K>`	`getKeyCoder()` Returns the key `Coder` for all `PCollections` in this `KeyedPCollectionTuple`.
`java.util.List<KeyedPCollectionTuple.TaggedKeyedPCollection<K,?>>`	`getKeyedCollections()` Returns a list of `TaggedKeyedPCollections` for the `PCollections` contained in this `KeyedPCollectionTuple`.
`Pipeline`	`getPipeline()` Returns the owning `Pipeline` of this `PInput`.
`boolean`	`isEmpty()`
`static <K,InputT> KeyedPCollectionTuple<K>`	`of(java.lang.String tag, PCollection<KV<K,InputT>> pc)` A version of `of(TupleTag, PCollection)` that takes in a string instead of a TupleTag.
`static <K,InputT> KeyedPCollectionTuple<K>`	`of(TupleTag<InputT> tag, PCollection<KV<K,InputT>> pc)` Returns a new `KeyedPCollectionTuple<K>` with the given tag and initial PCollection.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - empty
```
public static <K> KeyedPCollectionTuple<K> empty(Pipeline pipeline)
```
    Returns an empty KeyedPCollectionTuple<K> on the given pipeline.
  - of
```
public static <K,InputT> KeyedPCollectionTuple<K> of(TupleTag<InputT> tag,
                                                     PCollection<KV<K,InputT>> pc)
```
    Returns a new KeyedPCollectionTuple<K> with the given tag and initial PCollection.
  - of
```
public static <K,InputT> KeyedPCollectionTuple<K> of(java.lang.String tag,
                                                     PCollection<KV<K,InputT>> pc)
```
    A version of of(TupleTag, PCollection) that takes in a string instead of a TupleTag.
    This method is simpler for cases when a typed tuple-tag is not needed to extract a PCollection, for example when using schema transforms.
  - and
```
public <V> KeyedPCollectionTuple<K> and(TupleTag<V> tag,
                                        PCollection<KV<K,V>> pc)
```
    Returns a new KeyedPCollectionTuple<K> that is the same as this, appended with the given PCollection.
  - and
```
public <V> KeyedPCollectionTuple<K> and(java.lang.String tag,
                                        PCollection<KV<K,V>> pc)
```
    A version of and(String, PCollection) that takes in a string instead of a TupleTag.
    This method is simpler for cases when a typed tuple-tag is not needed to extract a PCollection, for example when using schema transforms.
  - isEmpty
```
public boolean isEmpty()
```
  - getKeyedCollections
```
public java.util.List<KeyedPCollectionTuple.TaggedKeyedPCollection<K,?>> getKeyedCollections()
```
    Returns a list of TaggedKeyedPCollections for the PCollections contained in this KeyedPCollectionTuple.
  - apply
```
public <OutputT extends POutput> OutputT apply(PTransform<KeyedPCollectionTuple<K>,OutputT> transform)
```
    Like apply(String, PTransform) but defaulting to the name provided by the PTransform.
  - apply
```
public <OutputT extends POutput> OutputT apply(java.lang.String name,
                                               PTransform<KeyedPCollectionTuple<K>,OutputT> transform)
```
    Applies the given PTransform to this input KeyedPCollectionTuple and returns its OutputT. This uses name to identify the specific application of the transform. This name is used in various places, including the monitoring UI, logging, and to stably identify this application node in the job graph.
  - expand
```
public java.util.Map<TupleTag<?>,PValue> expand()
```
    Expands the component PCollections, stripping off any tag-specific information.
    
    Specified by:
    
    expand in interface PInput
  - getKeyCoder
```
public Coder<K> getKeyCoder()
```
    Returns the key Coder for all PCollections in this KeyedPCollectionTuple.
  - getCoGbkResultSchema
```
public CoGbkResultSchema getCoGbkResultSchema()
```
    Returns the CoGbkResultSchema associated with this KeyedPCollectionTuple.
  - getPipeline
```
public Pipeline getPipeline()
```
    Description copied from interface: PInput
    
    Returns the owning Pipeline of this PInput.
    
    Specified by:
    
    getPipeline in interface PInput

Class KeyedPCollectionTuple<K>

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

empty

of

of

and

and

isEmpty

getKeyedCollections

apply

apply

expand

getKeyCoder

getCoGbkResultSchema

getPipeline