Package org.apache.kafka.clients.consumer

Class ConsumerRecords<K,V>

java.lang.Object

org.apache.kafka.clients.consumer.ConsumerRecords<K,V>

All Implemented Interfaces:

Iterable<ConsumerRecord<K,V>>

public class ConsumerRecords<K,V>
extends Object
implements Iterable<ConsumerRecord<K,V>>

A container that holds the list ConsumerRecord per partition for a particular topic. There is one ConsumerRecord list for every topic partition returned by a Consumer.poll(java.time.Duration) operation.

Field Summary

Fields

Modifier and Type	Field	Description
static final ConsumerRecords<Object,Object>	EMPTY

Constructor Summary

Constructors

Constructor	Description
ConsumerRecords(Map<TopicPartition,List<ConsumerRecord<K,V>>> records)	Deprecated. Since 4.0.
ConsumerRecords(Map<TopicPartition,List<ConsumerRecord<K,V>>> records, Map<TopicPartition,OffsetAndMetadata> nextOffsets)

Method Summary

Modifier and Type	Method	Description
int	count()	The number of records for all topics
static <K, V> ConsumerRecords<K,V>	empty()
boolean	isEmpty()
Iterator<ConsumerRecord<K,V>>	iterator()
Map<TopicPartition,OffsetAndMetadata>	nextOffsets()	Get the next offsets and metadata corresponding to all topic partitions for which the position have been advanced in this poll call
Set<TopicPartition>	partitions()	Get the partitions which have records contained in this record set.
Iterable<ConsumerRecord<K,V>>	records(String topic)	Get just the records for the given topic
List<ConsumerRecord<K,V>>	records(TopicPartition partition)	Get just the records for the given partition

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

EMPTY

public static final ConsumerRecords<Object,Object> EMPTY

Constructor Details

ConsumerRecords

@Deprecated
public ConsumerRecords(Map<TopicPartition,List<ConsumerRecord<K,V>>> records)

Deprecated.

Since 4.0. Use ConsumerRecords(Map, Map) instead.

ConsumerRecords

public ConsumerRecords(Map<TopicPartition,List<ConsumerRecord<K,V>>> records,
 Map<TopicPartition,OffsetAndMetadata> nextOffsets)

Method Details

records

public List<ConsumerRecord<K,V>> records(TopicPartition partition)

Get just the records for the given partition

Parameters:

partition - The partition to get records for

nextOffsets

public Map<TopicPartition,OffsetAndMetadata> nextOffsets()

Get the next offsets and metadata corresponding to all topic partitions for which the position have been advanced in this poll call

Returns:

the next offsets that the consumer will consume

records

public Iterable<ConsumerRecord<K,V>> records(String topic)

Get just the records for the given topic

partitions

public Set<TopicPartition> partitions()

Get the partitions which have records contained in this record set.

Returns:

the set of partitions with data in this record set (may be empty if no data was returned)

iterator

public Iterator<ConsumerRecord<K,V>> iterator()

Specified by:

iterator in interface Iterable<K>

count

public int count()

The number of records for all topics

isEmpty

public boolean isEmpty()

empty

public static <K,
V> ConsumerRecords<K,V> empty()