Package io.smallrye.reactive.messaging.kafka.companion

Class ConsumerGroupsCompanion

java.lang.Object
io.smallrye.reactive.messaging.kafka.companion.ConsumerGroupsCompanion
public class ConsumerGroupsCompanion extends Object
Companion for Consumer Group operations on Kafka broker

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConsumerGroupsCompanion(org.apache.kafka.clients.admin.AdminClient adminClient, Duration kafkaApiTimeout)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    alterOffsets(String groupId, Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata> topicPartitionOffsets)
     
    void
    delete(String... groupId)
     
    void
    deleteOffsets(String groupId, List<org.apache.kafka.common.TopicPartition> topicPartitions)
     
    org.apache.kafka.clients.admin.ConsumerGroupDescription
    describe(String groupId)
     
    Map<String,org.apache.kafka.clients.admin.ConsumerGroupDescription>
    describe(String... groupId)
     
    Collection<org.apache.kafka.clients.admin.ConsumerGroupListing>
    list()
     
    Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata>
    offsets(String groupId)
     
    Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata>
    offsets(String groupId, List<org.apache.kafka.common.TopicPartition> topicPartitions)
     
    org.apache.kafka.clients.consumer.OffsetAndMetadata
    offsets(String groupId, org.apache.kafka.common.TopicPartition topicPartitions)
     
    Map<String,Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata>>
    offsets(List<org.apache.kafka.common.TopicPartition> topicPartitions)
     
    void
    removeMembers(String groupId, String... groupInstanceIds)
     
    void
    resetOffsets(String groupId, org.apache.kafka.common.TopicPartition partition)
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ConsumerGroupsCompanion

      public ConsumerGroupsCompanion(org.apache.kafka.clients.admin.AdminClient adminClient, Duration kafkaApiTimeout)

  • Method Details

    • list

      public Collection<org.apache.kafka.clients.admin.ConsumerGroupListing> list()
      Returns:
      the list of consumer groups

    • describe

      public Map<String,org.apache.kafka.clients.admin.ConsumerGroupDescription> describe(String... groupId)
      Parameters:
      groupId - consumer group ids
      Returns:
      the map of consumer group descriptions by id

    • describe

      public org.apache.kafka.clients.admin.ConsumerGroupDescription describe(String groupId)
      Parameters:
      groupId - consumer group id
      Returns:
      the consumer group description

    • delete

      public void delete(String... groupId)
      Parameters:
      groupId - consumer group ids

    • removeMembers

      public void removeMembers(String groupId, String... groupInstanceIds)
      Parameters:
      groupId - the consumer group id
      groupInstanceIds - group instance ids

    • offsets

      public Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata> offsets(String groupId)
      Parameters:
      groupId - consumer group id
      Returns:
      the map of topic partitions to offset

    • offsets

      public Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata> offsets(String groupId, List<org.apache.kafka.common.TopicPartition> topicPartitions)
      Parameters:
      groupId - consumer group id
      topicPartitions - list of topic partitions
      Returns:
      the map of topic partitions to offset

    • offsets

      public org.apache.kafka.clients.consumer.OffsetAndMetadata offsets(String groupId, org.apache.kafka.common.TopicPartition topicPartitions)
      Parameters:
      groupId - consumer group id
      topicPartitions - topic partition
      Returns:
      the offset

    • offsets

      public Map<String,Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata>> offsets(List<org.apache.kafka.common.TopicPartition> topicPartitions)
      Parameters:
      topicPartitions - list of topic partitions
      Returns:
      map of consumer group id to topic partitions offset

    • alterOffsets

      public void alterOffsets(String groupId, Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata> topicPartitionOffsets)
      Parameters:
      groupId - consumer group id
      topicPartitionOffsets - the map of topic partitions to offset

    • resetOffsets

      public void resetOffsets(String groupId, org.apache.kafka.common.TopicPartition partition)
      Parameters:
      groupId - consumer group id
      partition - topic partition

    • deleteOffsets

      public void deleteOffsets(String groupId, List<org.apache.kafka.common.TopicPartition> topicPartitions)
      Parameters:
      groupId - consumer group id
      topicPartitions - list of topic partitions