com.aliyun.openservices.ons.api

Interface PullConsumer

All Superinterfaces:

Admin

public interface PullConsumer
extends Admin

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PullConsumer.TopicPartitionChangeListener

Method Summary

Methods

Modifier and Type	Method and Description
void	assign(Collection<TopicPartition> topicPartitions) Manually assign a list of partitions to this consumer.
void	commitSync() Sync commit current consumed offset to server.
Long	committed(TopicPartition topicPartition) Get the last committed offset for the given message queue (whether the commit happened by this process or another).
Long	offsetForTimestamp(TopicPartition topicPartition, Long timestamp) Look up the offsets for the given message queue by timestamp.
void	pause(Collection<TopicPartition> topicPartitions) Suspend fetching from the requested message queues.
List<Message>	poll(long timeout) Fetch data for the topics or partitions specified using assign API.
void	registerTopicPartitionChangedListener(String topic, PullConsumer.TopicPartitionChangeListener callback) Register a callback for sensing topic metadata changes.
void	resume(Collection<TopicPartition> topicPartitions) Resume specified message queues which have been paused with pause(Collection).
void	seek(TopicPartition topicPartition, long offset) Overrides the fetch offsets that the consumer will use on the next poll(long) }.
void	seekToBeginning(TopicPartition topicPartition) Overrides the fetch offsets with the beginning offset in server that the consumer will use on the next poll(long) }.
void	seekToEnd(TopicPartition topicPartition) Overrides the fetch offsets with the end offset in server that the consumer will use on the next poll(long) }.
Set<TopicPartition>	topicPartitions(String topic) Get metadata about the partitions for a given topic.

Methods inherited from interface com.aliyun.openservices.ons.api.Admin

isClosed, isStarted, shutdown, start, updateCredential

Method Detail

topicPartitions

Set<TopicPartition> topicPartitions(String topic)

Get metadata about the partitions for a given topic. This method will issue a remote call to the server if it does not already have any metadata about the given topic.

Parameters:

topic -

Returns:

assign

void assign(Collection<TopicPartition> topicPartitions)

Manually assign a list of partitions to this consumer. This interface does not allow for incremental assignment and will replace the previous assignment (if there is one). If auto-commit is enabled, an async commit (based on the old assignment) will be triggered before the new assignment replaces the old one.

Parameters:

topicPartitions -

registerTopicPartitionChangedListener

void registerTopicPartitionChangedListener(String topic,
                                         PullConsumer.TopicPartitionChangeListener callback)

Register a callback for sensing topic metadata changes.

Parameters:

topic -

callback -

poll

List<Message> poll(long timeout)

Fetch data for the topics or partitions specified using assign API. It is an error to not have subscribed to any topics or partitions before polling for data.

Parameters:

timeout - in millisecond

Returns:

seek

void seek(TopicPartition topicPartition,
        long offset)

Overrides the fetch offsets that the consumer will use on the next poll(long) }. If this API is invoked for the same message queue more than once, the latest offset will be used on the next poll(). Note that you may lose data if this API is arbitrarily used in the middle of consumption.

Parameters:

topicPartition -

offset -

seekToBeginning

void seekToBeginning(TopicPartition topicPartition)

Overrides the fetch offsets with the beginning offset in server that the consumer will use on the next poll(long) }.

Parameters:

topicPartition -

seekToEnd

void seekToEnd(TopicPartition topicPartition)

Overrides the fetch offsets with the end offset in server that the consumer will use on the next poll(long) }.

Parameters:

topicPartition -

pause

void pause(Collection<TopicPartition> topicPartitions)

Suspend fetching from the requested message queues. Future calls to poll(long) will not return any records from these message queues until they have been resumed using resume(Collection). Note that this method does not affect message queue subscription. In particular, it does not cause a group rebalance.

Parameters:

topicPartitions -

resume

void resume(Collection<TopicPartition> topicPartitions)

Resume specified message queues which have been paused with pause(Collection). New calls to poll(long) will return records from these partitions if there are any to be fetched. If the message queues were not previously paused, this method is a no-op.

Parameters:

topicPartitions -

offsetForTimestamp

Long offsetForTimestamp(TopicPartition topicPartition,
                      Long timestamp)

Look up the offsets for the given message queue by timestamp. The returned offset for each message queue is the earliest offset whose timestamp is greater than or equal to the given timestamp in the corresponding message queue.

Parameters:

topicPartition -

timestamp -

Returns:

committed

Long committed(TopicPartition topicPartition)

Get the last committed offset for the given message queue (whether the commit happened by this process or another). This offset will be used as the position for the consumer in the event of a failure.

Parameters:

topicPartition -

Returns:

commitSync

void commitSync()

Sync commit current consumed offset to server.