org.apache.twill.kafka.client

Interface KafkaConsumer.Preparer

Enclosing interface:

KafkaConsumer

public static interface KafkaConsumer.Preparer

A builder for preparing message consumption.

Method Summary

Modifier and Type	Method and Description
KafkaConsumer.Preparer	add(String topic, int partition, long offset) Consumes messages from a given offset.
KafkaConsumer.Preparer	addFromBeginning(String topic, int partition) Consumes messages from the earliest message available.
KafkaConsumer.Preparer	addLatest(String topic, int partition) Consumes messages from the latest message.
Cancellable	consume(KafkaConsumer.MessageCallback callback) Starts the consumption as being configured by this KafkaConsumer.Preparer.

Method Detail

add

KafkaConsumer.Preparer add(String topic,
                           int partition,
                           long offset)

Consumes messages from a given offset. If the given offset is invalid, it'll start consuming from the latest offset.

Parameters:

topic - Topic to consume from.

partition - Partition in the topic to consume from.

offset - Offset to starts with.

Returns:

This KafkaConsumer.Preparer instance.

addFromBeginning

KafkaConsumer.Preparer addFromBeginning(String topic,
                                        int partition)

Consumes messages from the earliest message available.

Parameters:

topic - Topic to consume from.

partition - Partition in the topic to consume from.

Returns:

This KafkaConsumer.Preparer instance.

addLatest

KafkaConsumer.Preparer addLatest(String topic,
                                 int partition)

Consumes messages from the latest message.

Parameters:

topic - Topic to consume from.

partition - Partition in the topic to consume from.

Returns:

This KafkaConsumer.Preparer instance.

consume

Cancellable consume(KafkaConsumer.MessageCallback callback)

Starts the consumption as being configured by this KafkaConsumer.Preparer.

Parameters:

callback - The KafkaConsumer.MessageCallback for receiving new messages.

Returns:

A Cancellable for cancelling message consumption.