Package org.apache.kafka.clients.consumer

Interface ShareConsumer<K,V>

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

KafkaShareConsumer, MockShareConsumer

@Evolving
public interface ShareConsumer<K,V>
extends Closeable

A client that consumes records from a Kafka cluster using a share group.

See Also:

• KafkaShareConsumer
• MockShareConsumer

Method Summary

Modifier and Type	Method	Description
void	acknowledge(ConsumerRecord<K,V> record)
void	acknowledge(ConsumerRecord<K,V> record, AcknowledgeType type)
Uuid	clientInstanceId(Duration timeout)
void	close()
void	close(Duration timeout)
void	commitAsync()
Map<TopicIdPartition,Optional<KafkaException>>	commitSync()
Map<TopicIdPartition,Optional<KafkaException>>	commitSync(Duration timeout)
Map<MetricName,? extends Metric>	metrics()
ConsumerRecords<K,V>	poll(Duration timeout)
void	registerMetricForSubscription(KafkaMetric metric)
void	setAcknowledgementCommitCallback(AcknowledgementCommitCallback callback)
void	subscribe(Collection<String> topics)
Set<String>	subscription()
void	unregisterMetricFromSubscription(KafkaMetric metric)
void	unsubscribe()
void	wakeup()

Method Details

subscription

Set<String> subscription()

See Also:

• KafkaShareConsumer.subscription()

subscribe

void subscribe(Collection<String> topics)

See Also:

• KafkaShareConsumer.subscribe(Collection)

unsubscribe

void unsubscribe()

See Also:

• KafkaShareConsumer.unsubscribe()

poll

ConsumerRecords<K,V> poll(Duration timeout)

See Also:

• KafkaShareConsumer.poll(Duration)

acknowledge

void acknowledge(ConsumerRecord<K,V> record)

See Also:

• KafkaShareConsumer.acknowledge(ConsumerRecord)

acknowledge

void acknowledge(ConsumerRecord<K,V> record,
 AcknowledgeType type)

See Also:

• KafkaShareConsumer.acknowledge(ConsumerRecord, AcknowledgeType)

commitSync

Map<TopicIdPartition,Optional<KafkaException>> commitSync()

See Also:

• KafkaShareConsumer.commitSync()

commitSync

Map<TopicIdPartition,Optional<KafkaException>> commitSync(Duration timeout)

See Also:

• KafkaShareConsumer.commitSync(Duration)

commitAsync

void commitAsync()

See Also:

• KafkaShareConsumer.commitAsync()

setAcknowledgementCommitCallback

void setAcknowledgementCommitCallback(AcknowledgementCommitCallback callback)

See Also:

• KafkaShareConsumer.setAcknowledgementCommitCallback(AcknowledgementCommitCallback)

clientInstanceId

Uuid clientInstanceId(Duration timeout)

See Also:

• KafkaShareConsumer.clientInstanceId(Duration)

metrics

Map<MetricName,? extends Metric> metrics()

See Also:

• KafkaShareConsumer.metrics()

registerMetricForSubscription

void registerMetricForSubscription(KafkaMetric metric)

See Also:

• KafkaShareConsumer.registerMetricForSubscription(KafkaMetric)

unregisterMetricFromSubscription

void unregisterMetricFromSubscription(KafkaMetric metric)

See Also:

• KafkaShareConsumer.unregisterMetricFromSubscription(KafkaMetric)

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

See Also:

• KafkaShareConsumer.close()

close

void close(Duration timeout)

See Also:

• KafkaShareConsumer.close(Duration)

wakeup

void wakeup()

See Also:

• KafkaShareConsumer.wakeup()