org.apache.beam.sdk.values

Class KV<K,V>

java.lang.Object

org.apache.beam.sdk.values.KV<K,V>

Type Parameters:

K - the type of the key

V - the type of the value

All Implemented Interfaces:

java.io.Serializable

public class KV<K,V>
extends java.lang.Object
implements java.io.Serializable

An immutable key/value pair.

Various PTransforms like GroupByKey and Combine.perKey(org.apache.beam.sdk.transforms.SerializableFunction<java.lang.Iterable<V>, V>) operate on PCollections of KVs.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KV.OrderByKey<K extends java.lang.Comparable<? super K>,V> A Comparator that orders KVs by the natural ordering of their keys.
static class	KV.OrderByValue<K,V extends java.lang.Comparable<? super V>> A Comparator that orders KVs by the natural ordering of their values.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
K	getKey() Returns the key of this KV.
V	getValue() Returns the value of this KV.
int	hashCode()
static <K,V> KV<K,V>	of(K key, V value) Returns a KV with the given key and value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

of

public static <K,V> KV<K,V> of(@Nullable
                               K key,
                               @Nullable
                               V value)

Returns a KV with the given key and value.

getKey

@Nullable
public K getKey()

Returns the key of this KV.

getValue

public V getValue()

Returns the value of this KV.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object