Interface RmGroupConfigClient

All Known Implementing Classes:
RmGroupConfigClientImpl

public interface RmGroupConfigClient
Client interface for managing group dynamic configurations in the resource manager. This client manages a single GroupConfig resource per Group that contains all group configs. Follows the same pattern as RmTopicClient - LKC ID is embedded in the ObjectIdentifier scope.
  • Method Summary

    Modifier and Type
    Method
    Description
    CompletableFuture<io.confluent.rm.kafka.v1.GroupConfig>
    createGroupConfig(io.confluent.rm.kafka.v1.GroupConfig config)
    Creates a new GroupConfig resource for an Group.
    CompletableFuture<Optional<io.confluent.rm.kafka.v1.GroupConfig>>
    deleteGroupConfig(io.confluent.resourcemanager.api.model.identifier.ObjectIdentifier<io.confluent.rm.kafka.v1.GroupConfig> id)
    Deletes the GroupConfig resource for a Group.
    CompletableFuture<Optional<io.confluent.rm.kafka.v1.GroupConfig>>
    getGroupConfig(io.confluent.resourcemanager.api.model.identifier.ObjectIdentifier<io.confluent.rm.kafka.v1.GroupConfig> id)
    Retrieves the GroupConfig resource for an Group.
    RmWatcher<io.confluent.rm.kafka.v1.GroupConfig>
    Creates a watcher to monitor changes to GroupConfig resources.
    CompletableFuture<Optional<io.confluent.rm.kafka.v1.GroupConfig>>
    updateDynamicConfigs(io.confluent.rm.kafka.v1.GroupConfig config, io.confluent.rm.kafka.v1.GroupDynamicConfigs dynamicConfigs)
    Updates the Dynamic Configuration for existing Group resource.
  • Method Details

    • getGroupConfig

      CompletableFuture<Optional<io.confluent.rm.kafka.v1.GroupConfig>> getGroupConfig(io.confluent.resourcemanager.api.model.identifier.ObjectIdentifier<io.confluent.rm.kafka.v1.GroupConfig> id)
      Retrieves the GroupConfig resource for an Group.
      Parameters:
      id - The ObjectIdentifier with LKC scope attributes (org, environment, logical-kafka-cluster).
      Returns:
      A CompletableFuture that completes with an Optional containing the GroupConfig, or empty if the resource is not found.
    • updateDynamicConfigs

      CompletableFuture<Optional<io.confluent.rm.kafka.v1.GroupConfig>> updateDynamicConfigs(io.confluent.rm.kafka.v1.GroupConfig config, io.confluent.rm.kafka.v1.GroupDynamicConfigs dynamicConfigs)
      Updates the Dynamic Configuration for existing Group resource.
      Parameters:
      config - The GroupConfig resource to update.
      Returns:
      A CompletableFuture that completes with the updated GroupConfig.
    • createGroupConfig

      CompletableFuture<io.confluent.rm.kafka.v1.GroupConfig> createGroupConfig(io.confluent.rm.kafka.v1.GroupConfig config)
      Creates a new GroupConfig resource for an Group.
      Parameters:
      config - The GroupConfig resource to create.
      Returns:
      A CompletableFuture that completes with the created GroupConfig.
    • deleteGroupConfig

      CompletableFuture<Optional<io.confluent.rm.kafka.v1.GroupConfig>> deleteGroupConfig(io.confluent.resourcemanager.api.model.identifier.ObjectIdentifier<io.confluent.rm.kafka.v1.GroupConfig> id)
      Deletes the GroupConfig resource for a Group.
      Parameters:
      id - The ObjectIdentifier with LKC scope attributes.
      Returns:
      A CompletableFuture that completes with an Optional containing the deleted GroupConfig, or empty if the resource was not found.
    • GroupConfigWatch

      RmWatcher<io.confluent.rm.kafka.v1.GroupConfig> GroupConfigWatch()
      Creates a watcher to monitor changes to GroupConfig resources.
      Returns:
      A Watcher instance for GroupConfig create, update, and delete events