Package org.springframework.kafka.event

Class ConsumerPausedEvent

java.lang.Object

java.util.EventObject

org.springframework.context.ApplicationEvent

org.springframework.kafka.event.KafkaEvent

org.springframework.kafka.event.ConsumerPausedEvent

All Implemented Interfaces:

Serializable

public class ConsumerPausedEvent
extends KafkaEvent

An event published when a consumer is paused.

Since:

2.1.5

Author:

Gary Russell

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
ConsumerPausedEvent(Object source, Object container, Collection<org.apache.kafka.common.TopicPartition> partitions)	Construct an instance with the provided source and partitions.
ConsumerPausedEvent(Object source, Object container, Collection<org.apache.kafka.common.TopicPartition> partitions, String reason)	Construct an instance with the provided source and partitions.

Method Summary

Modifier and Type	Method	Description
Collection<org.apache.kafka.common.TopicPartition>	getPartitions()	Return the paused partitions.
String	toString()

Methods inherited from class org.springframework.kafka.event.KafkaEvent

getContainer, getSource

Methods inherited from class org.springframework.context.ApplicationEvent

getTimestamp

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ConsumerPausedEvent

public ConsumerPausedEvent(Object source,
 Object container,
 Collection<org.apache.kafka.common.TopicPartition> partitions)

Construct an instance with the provided source and partitions.

Parameters:

source - the container instance that generated the event.

container - the container or the parent container if the container is a child.

partitions - the partitions.

Since:

2.2.1

ConsumerPausedEvent

public ConsumerPausedEvent(Object source,
 Object container,
 Collection<org.apache.kafka.common.TopicPartition> partitions,
 String reason)

Construct an instance with the provided source and partitions.

Parameters:

source - the container instance that generated the event.

container - the container or the parent container if the container is a child.

partitions - the partitions.

reason - the reason for the pause.

Since:

2.8.9

Method Details

getPartitions

public Collection<org.apache.kafka.common.TopicPartition> getPartitions()

Return the paused partitions.

Returns:

the partitions.

toString

public String toString()

Overrides:

toString in class EventObject