Package org.apache.kafka.clients.consumer

Interface Consumer<K,V>

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

ConsumerDelegate<K,V>

All Known Implementing Classes:

AsyncKafkaConsumer, KafkaConsumer, LegacyKafkaConsumer, MockConsumer

public interface Consumer<K,V>
extends Closeable

See Also:

• KafkaConsumer
• MockConsumer

Method Summary

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

Method Details

assignment

Set<org.apache.kafka.common.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<org.apache.kafka.common.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)

unsubscribe

void unsubscribe()

See Also:

• KafkaConsumer.unsubscribe()

poll

@Deprecated
ConsumerRecords<K,V> poll(long timeout)

Deprecated.

See Also:

• KafkaConsumer.poll(long)

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<org.apache.kafka.common.TopicPartition,OffsetAndMetadata> offsets)

See Also:

• KafkaConsumer.commitSync(Map)

commitSync

void commitSync(Map<org.apache.kafka.common.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<org.apache.kafka.common.TopicPartition,OffsetAndMetadata> offsets,
 OffsetCommitCallback callback)

See Also:

• KafkaConsumer.commitAsync(Map, OffsetCommitCallback)

seek

void seek(org.apache.kafka.common.TopicPartition partition,
 long offset)

See Also:

• KafkaConsumer.seek(TopicPartition, long)

seek

void seek(org.apache.kafka.common.TopicPartition partition,
 OffsetAndMetadata offsetAndMetadata)

See Also:

• KafkaConsumer.seek(TopicPartition, OffsetAndMetadata)

seekToBeginning

void seekToBeginning(Collection<org.apache.kafka.common.TopicPartition> partitions)

See Also:

• KafkaConsumer.seekToBeginning(Collection)

seekToEnd

void seekToEnd(Collection<org.apache.kafka.common.TopicPartition> partitions)

See Also:

• KafkaConsumer.seekToEnd(Collection)

position

long position(org.apache.kafka.common.TopicPartition partition)

See Also:

• KafkaConsumer.position(TopicPartition)

position

long position(org.apache.kafka.common.TopicPartition partition,
 Duration timeout)

See Also:

• KafkaConsumer.position(TopicPartition, Duration)

committed

@Deprecated
OffsetAndMetadata committed(org.apache.kafka.common.TopicPartition partition)

Deprecated.

See Also:

• KafkaConsumer.committed(TopicPartition)

committed

@Deprecated
OffsetAndMetadata committed(org.apache.kafka.common.TopicPartition partition,
 Duration timeout)

Deprecated.

See Also:

• KafkaConsumer.committed(TopicPartition, Duration)

committed

Map<org.apache.kafka.common.TopicPartition,OffsetAndMetadata> committed(Set<org.apache.kafka.common.TopicPartition> partitions)

See Also:

• KafkaConsumer.committed(Set)

committed

Map<org.apache.kafka.common.TopicPartition,OffsetAndMetadata> committed(Set<org.apache.kafka.common.TopicPartition> partitions,
 Duration timeout)

See Also:

• KafkaConsumer.committed(Set, Duration)

clientInstanceId

org.apache.kafka.common.Uuid clientInstanceId(Duration timeout)

See KafkaConsumer.clientInstanceId(Duration)}

metrics

Map<org.apache.kafka.common.MetricName,? extends org.apache.kafka.common.Metric> metrics()

See Also:

• KafkaConsumer.metrics()

partitionsFor

List<org.apache.kafka.common.PartitionInfo> partitionsFor(String topic)

See Also:

• KafkaConsumer.partitionsFor(String)

partitionsFor

List<org.apache.kafka.common.PartitionInfo> partitionsFor(String topic,
 Duration timeout)

See Also:

• KafkaConsumer.partitionsFor(String, Duration)

listTopics

Map<String,List<org.apache.kafka.common.PartitionInfo>> listTopics()

See Also:

• KafkaConsumer.listTopics()

listTopics

Map<String,List<org.apache.kafka.common.PartitionInfo>> listTopics(Duration timeout)

See Also:

• KafkaConsumer.listTopics(Duration)

paused

Set<org.apache.kafka.common.TopicPartition> paused()

See Also:

• KafkaConsumer.paused()

pause

void pause(Collection<org.apache.kafka.common.TopicPartition> partitions)

See Also:

• KafkaConsumer.pause(Collection)

resume

void resume(Collection<org.apache.kafka.common.TopicPartition> partitions)

See Also:

• KafkaConsumer.resume(Collection)

offsetsForTimes

Map<org.apache.kafka.common.TopicPartition,OffsetAndTimestamp> offsetsForTimes(Map<org.apache.kafka.common.TopicPartition,Long> timestampsToSearch)

See Also:

• KafkaConsumer.offsetsForTimes(Map)

offsetsForTimes

Map<org.apache.kafka.common.TopicPartition,OffsetAndTimestamp> offsetsForTimes(Map<org.apache.kafka.common.TopicPartition,Long> timestampsToSearch,
 Duration timeout)

See Also:

• KafkaConsumer.offsetsForTimes(Map, Duration)

beginningOffsets

Map<org.apache.kafka.common.TopicPartition,Long> beginningOffsets(Collection<org.apache.kafka.common.TopicPartition> partitions)

See Also:

• KafkaConsumer.beginningOffsets(Collection)

beginningOffsets

Map<org.apache.kafka.common.TopicPartition,Long> beginningOffsets(Collection<org.apache.kafka.common.TopicPartition> partitions,
 Duration timeout)

See Also:

• KafkaConsumer.beginningOffsets(Collection, Duration)

endOffsets

Map<org.apache.kafka.common.TopicPartition,Long> endOffsets(Collection<org.apache.kafka.common.TopicPartition> partitions)

See Also:

• KafkaConsumer.endOffsets(Collection)

endOffsets

Map<org.apache.kafka.common.TopicPartition,Long> endOffsets(Collection<org.apache.kafka.common.TopicPartition> partitions,
 Duration timeout)

See Also:

• KafkaConsumer.endOffsets(Collection, Duration)

currentLag

OptionalLong currentLag(org.apache.kafka.common.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

void close(Duration timeout)

See Also:

• KafkaConsumer.close(Duration)

wakeup

void wakeup()

See Also:

• KafkaConsumer.wakeup()