io.cdap.cdap.api.dataset.lib

Class PartitionKey

java.lang.Object

io.cdap.cdap.api.dataset.lib.PartitionKey

public class PartitionKey
extends Object

Types and methods to specify partitioning keys for datasets.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PartitionKey.Builder A builder for partitioning objects.

Method Summary

Modifier and Type	Method and Description
static PartitionKey.Builder	builder()
static PartitionKey.Builder	builder(Partitioning partitioning)
boolean	equals(Object other)
Comparable	getField(String fieldName)
Map<String,Comparable>	getFields()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getFields

public Map<String,Comparable> getFields()

Returns:

all field names and their values in a map.

getField

public Comparable getField(String fieldName)

Returns:

the value of a field

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public static PartitionKey.Builder builder()

Returns:

a builder for a partition key.

builder

public static PartitionKey.Builder builder(Partitioning partitioning)

Returns:

a builder for a partition key with a known partitioning. This builder will only accept fields that are defined in the partitioning.