Package com.bakdata.kafka.admin

Class ConsumerGroupsClient.ConsumerGroupClient

java.lang.Object
com.bakdata.kafka.admin.ConsumerGroupsClient.ConsumerGroupClient
Enclosing class:
ConsumerGroupsClient
public final class ConsumerGroupsClient.ConsumerGroupClient extends Object
A client for a specific consumer group.

  • Method Summary

    Modifier and Type
    Method
    Description
    ConfigClient
    config()
    Create a client for the configuration of this consumer group.
    void
    delete()
    Delete a consumer group.
    void
    deleteIfExists()
    Delete a consumer group only if it exists.
    Optional<org.apache.kafka.clients.admin.ConsumerGroupDescription>
    describe()
    Describe a consumer group.
    boolean
    exists()
    Checks whether a Kafka consumer group exists.
    Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata>
    listOffsets()
    List offsets for a consumer group.
    void
    reset(org.apache.kafka.clients.admin.OffsetSpec offsetSpec)
    Reset consumer group offset.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • delete

      public void delete()
      Delete a consumer group.

    • describe

      public Optional<org.apache.kafka.clients.admin.ConsumerGroupDescription> describe()
      Describe a consumer group.
      Returns:
      consumer group description

    • listOffsets

      public Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata> listOffsets()
      List offsets for a consumer group.
      Returns:
      consumer group offsets

    • exists

      public boolean exists()
      Checks whether a Kafka consumer group exists.
      Returns:
      whether a Kafka consumer group with the specified name exists or not

    • deleteIfExists

      public void deleteIfExists()
      Delete a consumer group only if it exists.

    • reset

      public void reset(org.apache.kafka.clients.admin.OffsetSpec offsetSpec)
      Reset consumer group offset.
      Parameters:
      offsetSpec - specification where offsets should be reset to

    • config

      public ConfigClient config()
      Create a client for the configuration of this consumer group.
      Returns:
      config client