KeyedPCollectionTuple (Google Cloud Dataflow SDK API)

java.lang.Object
- com.google.cloud.dataflow.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
```
Represents an immutable tuple of keyed PCollections (i.e. PCollections of KV<K, ?>), with key type 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

Methods
Modifier and Type	Method and Description
`<V> KeyedPCollectionTuple<K>`	`and(TupleTag<V> tag, PCollection<KV<K,V>> pc)` Returns a new `KeyedPCollections<K>` that is the same as this, appended with the given PCollection.
`<O extends POutput> O`	`apply(PTransform<KeyedPCollectionTuple<K>,O> transform)` Applies the given transform to this input.
`static <K> KeyedPCollectionTuple<K>`	`empty(Pipeline pipeline)` Returns an empty `KeyedPCollections<K>` on the given pipeline.
`java.util.Collection<? extends PValue>`	`expand()` Expands the component PCollections, stripping off any tag-specific information.
`void`	`finishSpecifying()` After building, finalizes this PInput to make it ready for being used as an input to a PTransform.
`CoGbkResultSchema`	`getCoGbkResultSchema()` Returns the CoGbkResultSchema associated with this KeyedPCollections.
`Coder<K>`	`getKeyCoder()` Returns the KeyCoder for all PCollections in this KeyedPCollections.
`java.util.List<KeyedPCollectionTuple.TaggedKeyedPCollection<K,?>>`	`getKeyedCollections()` Returns a list of TaggedKeyedPCollections for the PCollections contained in this `KeyedPCollections<K>`.
`Pipeline`	`getPipeline()` Returns the owning Pipeline of this PInput.
`boolean`	`isEmpty()`
`static <K,VI> KeyedPCollectionTuple<K>`	`of(TupleTag<VI> tag, PCollection<KV<K,VI>> pc)` Returns a new `KeyedPCollections<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 KeyedPCollections<K> on the given pipeline.
  - of
```
public static <K,VI> KeyedPCollectionTuple<K> of(TupleTag<VI> tag,
                                 PCollection<KV<K,VI>> pc)
```
    Returns a new KeyedPCollections<K> with the given tag and initial PCollection.
  - and
```
public <V> KeyedPCollectionTuple<K> and(TupleTag<V> tag,
                               PCollection<KV<K,V>> pc)
```
    Returns a new KeyedPCollections<K> that is the same as this, appended with the given PCollection.
  - isEmpty
```
public boolean isEmpty()
```
  - getKeyedCollections
```
public java.util.List<KeyedPCollectionTuple.TaggedKeyedPCollection<K,?>> getKeyedCollections()
```
    Returns a list of TaggedKeyedPCollections for the PCollections contained in this KeyedPCollections<K>.
  - apply
```
public <O extends POutput> O apply(PTransform<KeyedPCollectionTuple<K>,O> transform)
```
    Applies the given transform to this input.
  - expand
```
public java.util.Collection<? extends 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 KeyCoder for all PCollections in this KeyedPCollections.
  - getCoGbkResultSchema
```
public CoGbkResultSchema getCoGbkResultSchema()
```
    Returns the CoGbkResultSchema associated with this KeyedPCollections.
  - getPipeline
```
public Pipeline getPipeline()
```
    Description copied from interface: PInput
    
    Returns the owning Pipeline of this PInput.
    
    Specified by:
    
    getPipeline in interface PInput
  - finishSpecifying
```
public void finishSpecifying()
```
    Description copied from interface: PInput
    
    After building, finalizes this PInput to make it ready for being used as an input to a PTransform.
    Automatically invoked whenever apply() is invoked on this PInput, so users do not normally call this explicitly.
    
    Specified by:
    
    finishSpecifying in interface PInput

Class KeyedPCollectionTuple<K>

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

empty

of

and

isEmpty

getKeyedCollections

apply

expand

getKeyCoder

getCoGbkResultSchema

getPipeline

finishSpecifying