Consumer (clients 7.4.13-ce API)

All Superinterfaces:
AutoCloseable, Closeable
All Known Implementing Classes:
KafkaConsumer, MockConsumer
```
public interface Consumer<K,V>
extends Closeable
```
See Also:
KafkaConsumer, MockConsumer

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and 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)`
`void`	`close()`
`void`	`close(Duration timeout)`
`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)`
`OffsetAndMetadata`	`committed(TopicPartition partition)` Deprecated.
`OffsetAndMetadata`	`committed(TopicPartition partition, Duration timeout)` Deprecated.
`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)`
`ConsumerRecords<K,V>`	`poll(long timeout)` Deprecated.
`long`	`position(TopicPartition partition)`
`long`	`position(TopicPartition partition, Duration timeout)`
`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)`
`Set<String>`	`subscription()`
`void`	`unsubscribe()`
`void`	`wakeup()`

Method Detail

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)

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

See Also:: KafkaConsumer.subscribe(Collection, ConsumerRebalanceListener)

assign

void assign(Collection<TopicPartition> partitions)

See Also:: KafkaConsumer.assign(Collection)

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<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)

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

@Deprecated
OffsetAndMetadata committed(TopicPartition partition)

Deprecated.

See Also:: KafkaConsumer.committed(TopicPartition)

committed

@Deprecated
OffsetAndMetadata committed(TopicPartition partition,
                                        Duration timeout)

Deprecated.

See Also:: KafkaConsumer.committed(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)

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
```
void close(Duration timeout)
```
See Also:
KafkaConsumer.close(Duration)

wakeup
```
void wakeup()
```
See Also:
KafkaConsumer.wakeup()

Interface Consumer<K,V>

Method Summary

Method Detail

assignment

subscription

subscribe

subscribe

assign

subscribe

subscribe

unsubscribe

poll

poll

commitSync

commitSync

commitSync

commitSync

commitAsync

commitAsync

commitAsync

seek

seek

seekToBeginning

seekToEnd

position

position

committed

committed

committed

committed

metrics

partitionsFor

partitionsFor

listTopics

listTopics

paused

pause

resume

offsetsForTimes

offsetsForTimes

beginningOffsets

beginningOffsets

endOffsets

endOffsets

currentLag

groupMetadata

enforceRebalance

enforceRebalance

close

close

wakeup