Package org.apache.kafka.clients.consumer

Interface Consumer<K,V>

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

KafkaConsumer, MockConsumer

public interface Consumer<K,V>
extends Closeable

See Also:

• KafkaConsumer
• MockConsumer

Method Summary

Modifier and Type	Method	Description
void	assign(Collection<TopicPartition> partitions)
Set<TopicPartition>	assignment()
Map<TopicPartition,Long>	beginningOffsets(Collection<TopicPartition> partitions)
Map<TopicPartition,Long>	beginningOffsets(Collection<TopicPartition> partitions, Duration timeout)
Uuid	clientInstanceId(Duration timeout)	See KafkaConsumer.clientInstanceId(Duration)}
void	close()
void	close(Duration timeout)	Deprecated.
void	close(CloseOptions option)
void	commitAsync()
void	commitAsync(Map<TopicPartition,OffsetAndMetadata> offsets, OffsetCommitCallback callback)
void	commitAsync(OffsetCommitCallback callback)
void	commitSync()
void	commitSync(Duration timeout)
void	commitSync(Map<TopicPartition,OffsetAndMetadata> offsets)
void	commitSync(Map<TopicPartition,OffsetAndMetadata> offsets, Duration timeout)
Map<TopicPartition,OffsetAndMetadata>	committed(Set<TopicPartition> partitions)
Map<TopicPartition,OffsetAndMetadata>	committed(Set<TopicPartition> partitions, Duration timeout)
OptionalLong	currentLag(TopicPartition topicPartition)
Map<TopicPartition,Long>	endOffsets(Collection<TopicPartition> partitions)
Map<TopicPartition,Long>	endOffsets(Collection<TopicPartition> partitions, Duration timeout)
void	enforceRebalance()
void	enforceRebalance(String reason)
ConsumerGroupMetadata	groupMetadata()
Map<String,List<PartitionInfo>>	listTopics()
Map<String,List<PartitionInfo>>	listTopics(Duration timeout)
Map<MetricName,? extends Metric>	metrics()
Map<TopicPartition,OffsetAndTimestamp>	offsetsForTimes(Map<TopicPartition,Long> timestampsToSearch)
Map<TopicPartition,OffsetAndTimestamp>	offsetsForTimes(Map<TopicPartition,Long> timestampsToSearch, Duration timeout)
List<PartitionInfo>	partitionsFor(String topic)
List<PartitionInfo>	partitionsFor(String topic, Duration timeout)
void	pause(Collection<TopicPartition> partitions)
Set<TopicPartition>	paused()
ConsumerRecords<K,V>	poll(Duration timeout)
long	position(TopicPartition partition)
long	position(TopicPartition partition, Duration timeout)
void	registerMetricForSubscription(KafkaMetric metric)
void	resume(Collection<TopicPartition> partitions)
void	seek(TopicPartition partition, long offset)
void	seek(TopicPartition partition, OffsetAndMetadata offsetAndMetadata)
void	seekToBeginning(Collection<TopicPartition> partitions)
void	seekToEnd(Collection<TopicPartition> partitions)
void	subscribe(Collection<String> topics)
void	subscribe(Collection<String> topics, ConsumerRebalanceListener callback)
void	subscribe(Pattern pattern)
void	subscribe(Pattern pattern, ConsumerRebalanceListener callback)
void	subscribe(SubscriptionPattern pattern)
void	subscribe(SubscriptionPattern pattern, ConsumerRebalanceListener callback)
Set<String>	subscription()
void	unregisterMetricFromSubscription(KafkaMetric metric)
void	unsubscribe()
void	wakeup()

Method Details

assignment

Set<TopicPartition> assignment()

See Also:

• KafkaConsumer.assignment()

subscription

Set<String> subscription()

See Also:

• KafkaConsumer.subscription()

subscribe

void subscribe(Collection<String> topics)

See Also:

• KafkaConsumer.subscribe(Collection)

subscribe

void subscribe(Collection<String> topics,
 ConsumerRebalanceListener callback)

See Also:

• KafkaConsumer.subscribe(Collection, ConsumerRebalanceListener)

assign

void assign(Collection<TopicPartition> partitions)

See Also:

• KafkaConsumer.assign(Collection)

subscribe

void subscribe(Pattern pattern,
 ConsumerRebalanceListener callback)

See Also:

• KafkaConsumer.subscribe(Pattern, ConsumerRebalanceListener)

subscribe

void subscribe(Pattern pattern)

See Also:

• KafkaConsumer.subscribe(Pattern)

subscribe

void subscribe(SubscriptionPattern pattern,
 ConsumerRebalanceListener callback)

See Also:

• KafkaConsumer.subscribe(SubscriptionPattern, ConsumerRebalanceListener)

subscribe

void subscribe(SubscriptionPattern pattern)

See Also:

• KafkaConsumer.subscribe(SubscriptionPattern)

unsubscribe

void unsubscribe()

See Also:

• KafkaConsumer.unsubscribe()

poll

ConsumerRecords<K,V> poll(Duration timeout)

See Also:

• KafkaConsumer.poll(Duration)

commitSync

void commitSync()

See Also:

• KafkaConsumer.commitSync()

commitSync

void commitSync(Duration timeout)

See Also:

• KafkaConsumer.commitSync(Duration)

commitSync

void commitSync(Map<TopicPartition,OffsetAndMetadata> offsets)

See Also:

• KafkaConsumer.commitSync(Map)

commitSync

void commitSync(Map<TopicPartition,OffsetAndMetadata> offsets,
 Duration timeout)

See Also:

• KafkaConsumer.commitSync(Map, Duration)

commitAsync

void commitAsync()

See Also:

• KafkaConsumer.commitAsync()

commitAsync

void commitAsync(OffsetCommitCallback callback)

See Also:

• KafkaConsumer.commitAsync(OffsetCommitCallback)

commitAsync

void commitAsync(Map<TopicPartition,OffsetAndMetadata> offsets,
 OffsetCommitCallback callback)

See Also:

• KafkaConsumer.commitAsync(Map, OffsetCommitCallback)

registerMetricForSubscription

void registerMetricForSubscription(KafkaMetric metric)

See Also:

• KafkaConsumer.registerMetricForSubscription(KafkaMetric)

unregisterMetricFromSubscription

void unregisterMetricFromSubscription(KafkaMetric metric)

See Also:

• KafkaConsumer.unregisterMetricFromSubscription(KafkaMetric)

seek

void seek(TopicPartition partition,
 long offset)

See Also:

• KafkaConsumer.seek(TopicPartition, long)

seek

void seek(TopicPartition partition,
 OffsetAndMetadata offsetAndMetadata)

See Also:

• KafkaConsumer.seek(TopicPartition, OffsetAndMetadata)

seekToBeginning

void seekToBeginning(Collection<TopicPartition> partitions)

See Also:

• KafkaConsumer.seekToBeginning(Collection)

seekToEnd

void seekToEnd(Collection<TopicPartition> partitions)

See Also:

• KafkaConsumer.seekToEnd(Collection)

position

long position(TopicPartition partition)

See Also:

• KafkaConsumer.position(TopicPartition)

position

long position(TopicPartition partition,
 Duration timeout)

See Also:

• KafkaConsumer.position(TopicPartition, Duration)

committed

Map<TopicPartition,OffsetAndMetadata> committed(Set<TopicPartition> partitions)

See Also:

• KafkaConsumer.committed(Set)

committed

Map<TopicPartition,OffsetAndMetadata> committed(Set<TopicPartition> partitions,
 Duration timeout)

See Also:

• KafkaConsumer.committed(Set, Duration)

clientInstanceId

Uuid clientInstanceId(Duration timeout)

See KafkaConsumer.clientInstanceId(Duration)}

metrics

Map<MetricName,? extends Metric> metrics()

See Also:

• KafkaConsumer.metrics()

partitionsFor

List<PartitionInfo> partitionsFor(String topic)

See Also:

• KafkaConsumer.partitionsFor(String)

partitionsFor

List<PartitionInfo> partitionsFor(String topic,
 Duration timeout)

See Also:

• KafkaConsumer.partitionsFor(String, Duration)

listTopics

Map<String,List<PartitionInfo>> listTopics()

See Also:

• KafkaConsumer.listTopics()

listTopics

Map<String,List<PartitionInfo>> listTopics(Duration timeout)

See Also:

• KafkaConsumer.listTopics(Duration)

paused

Set<TopicPartition> paused()

See Also:

• KafkaConsumer.paused()

pause

void pause(Collection<TopicPartition> partitions)

See Also:

• KafkaConsumer.pause(Collection)

resume

void resume(Collection<TopicPartition> partitions)

See Also:

• KafkaConsumer.resume(Collection)

offsetsForTimes

Map<TopicPartition,OffsetAndTimestamp> offsetsForTimes(Map<TopicPartition,Long> timestampsToSearch)

See Also:

• KafkaConsumer.offsetsForTimes(Map)

offsetsForTimes

Map<TopicPartition,OffsetAndTimestamp> offsetsForTimes(Map<TopicPartition,Long> timestampsToSearch,
 Duration timeout)

See Also:

• KafkaConsumer.offsetsForTimes(Map, Duration)

beginningOffsets

Map<TopicPartition,Long> beginningOffsets(Collection<TopicPartition> partitions)

See Also:

• KafkaConsumer.beginningOffsets(Collection)

beginningOffsets

Map<TopicPartition,Long> beginningOffsets(Collection<TopicPartition> partitions,
 Duration timeout)

See Also:

• KafkaConsumer.beginningOffsets(Collection, Duration)

endOffsets

Map<TopicPartition,Long> endOffsets(Collection<TopicPartition> partitions)

See Also:

• KafkaConsumer.endOffsets(Collection)

endOffsets

Map<TopicPartition,Long> endOffsets(Collection<TopicPartition> partitions,
 Duration timeout)

See Also:

• KafkaConsumer.endOffsets(Collection, Duration)

currentLag

OptionalLong currentLag(TopicPartition topicPartition)

See Also:

• KafkaConsumer.currentLag(TopicPartition)

groupMetadata

ConsumerGroupMetadata groupMetadata()

See Also:

• KafkaConsumer.groupMetadata()

enforceRebalance

void enforceRebalance()

See Also:

• KafkaConsumer.enforceRebalance()

enforceRebalance

void enforceRebalance(String reason)

See Also:

• KafkaConsumer.enforceRebalance(String)

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

See Also:

• KafkaConsumer.close()

close

@Deprecated
void close(Duration timeout)

Deprecated.

See Also:

• KafkaConsumer.close(Duration)

close

void close(CloseOptions option)

See Also:

• KafkaConsumer.close(CloseOptions)

wakeup

void wakeup()

See Also:

• KafkaConsumer.wakeup()