Packages

t

akka.kafka.scaladsl

PartitionAssignmentHandler

trait PartitionAssignmentHandler extends AnyRef

The API is new and may change in further releases.

Allows the user to execute user code when Kafka rebalances partitions between consumers, or an Alpakka Kafka consumer is stopped. Use with care: These callbacks are called synchronously on the same thread Kafka's poll() is called. A warning will be logged if a callback takes longer than the configured partition-handler-warning.

There is no point in calling Committable's commit methods as their committing won't be executed as long as any of the callbacks in this class are called. Calling commitSync on the passed akka.kafka.RestrictedConsumer is available.

This complements the methods of Kafka's ConsumerRebalanceListener with an onStop callback which is called before Consumer.close.

Annotations
@ApiMayChange()
Source
PartitionAssignmentHandler.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PartitionAssignmentHandler
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def onAssign(assignedTps: Set[TopicPartition], consumer: RestrictedConsumer): Unit

    See org.apache.kafka.clients.consumer.ConsumerRebalanceListener#onPartitionsAssigned

    assignedTps

    The list of partitions that are now assigned to the consumer (may include partitions previously assigned to the consumer)

    consumer

    The akka.kafka.RestrictedConsumer gives some access to the internally used Consumer

  2. abstract def onLost(lostTps: Set[TopicPartition], consumer: RestrictedConsumer): Unit

    Called when partition metadata has changed and partitions no longer exist.

    Called when partition metadata has changed and partitions no longer exist. This can occur if a topic is deleted or if the leader's metadata is stale. See org.apache.kafka.clients.consumer.ConsumerRebalanceListener#onPartitionsLost

    lostTps

    The list of partitions that are no longer valid

    consumer

    The akka.kafka.RestrictedConsumer gives some access to the internally used Consumer

  3. abstract def onRevoke(revokedTps: Set[TopicPartition], consumer: RestrictedConsumer): Unit

    See org.apache.kafka.clients.consumer.ConsumerRebalanceListener#onPartitionsRevoked

    revokedTps

    The list of partitions that were revoked from the consumer

    consumer

    The akka.kafka.RestrictedConsumer gives some access to the internally used Consumer

  4. abstract def onStop(currentTps: Set[TopicPartition], consumer: RestrictedConsumer): Unit

    Called before a consumer is closed.

    currentTps

    The list of partitions that are currently assigned to the consumer

    consumer

    The akka.kafka.RestrictedConsumer gives some access to the internally used Consumer

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped