org.apache.flink.streaming.connectors.kinesis

Class KinesisPartitioner<T>

java.lang.Object

org.apache.flink.streaming.connectors.kinesis.KinesisPartitioner<T>

Type Parameters:

T - record type

All Implemented Interfaces:

Serializable

@PublicEvolving
public abstract class KinesisPartitioner<T>
extends Object
implements Serializable

An interface for partitioning records.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
KinesisPartitioner()

Method Summary

Modifier and Type	Method and Description
String	getExplicitHashKey(T element) Optional method for setting an explicit hash key.
abstract String	getPartitionId(T element) Return a partition id based on the input.
void	initialize(int indexOfThisSubtask, int numberOfParallelSubtasks) Optional initializer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KinesisPartitioner

public KinesisPartitioner()

Method Detail

getPartitionId

public abstract String getPartitionId(T element)

Return a partition id based on the input.

Parameters:

element - Element to partition

Returns:

A string representing the partition id

getExplicitHashKey

public String getExplicitHashKey(T element)

Optional method for setting an explicit hash key.

Parameters:

element - Element to get the hash key for

Returns:

the hash key for the element

initialize

public void initialize(int indexOfThisSubtask,
                       int numberOfParallelSubtasks)

Optional initializer.

Parameters:

indexOfThisSubtask - Index of this partitioner instance

numberOfParallelSubtasks - Total number of parallel instances