Interface RmHealthProbeClient

All Known Implementing Classes:
RmHealthProbeClientImpl
public interface RmHealthProbeClient
Client interface for managing HealthProbe resources in the resource manager.

HealthProbe is a lightweight synthetic resource used for per-broker metadata healthchecks. Each probe cycle creates, reads, and deletes a HealthProbe to verify that both the Watch and CRUD APIs are functional.

HealthProbe is Environment-scoped ([org, environment]): probes live under the dedicated "kafka-internal" org, in the environment of the physical Kafka cluster whose brokers run them. The scope attributes are embedded in the ObjectIdentifier passed to the per-resource operations, following the same identifier-scope convention as RmGroupConfigClient (which is instead LogicalKafkaCluster-scoped).

  • Method Summary

    Modifier and Type
    Method
    Description
    CompletableFuture<io.confluent.rm.kafka.v1.HealthProbe>
    createHealthProbe(io.confluent.rm.kafka.v1.HealthProbe healthProbe)
    Creates a new HealthProbe resource in the resource manager.
    CompletableFuture<Optional<io.confluent.rm.kafka.v1.HealthProbe>>
    deleteHealthProbe(io.confluent.resourcemanager.api.model.identifier.ObjectIdentifier<io.confluent.rm.kafka.v1.HealthProbe> id)
    Deletes a HealthProbe resource from the resource manager.
    CompletableFuture<Optional<io.confluent.rm.kafka.v1.HealthProbe>>
    getHealthProbe(io.confluent.resourcemanager.api.model.identifier.ObjectIdentifier<io.confluent.rm.kafka.v1.HealthProbe> id)
    Retrieves a HealthProbe resource from the resource manager.
    RmWatcher<io.confluent.rm.kafka.v1.HealthProbe>
    healthProbeWatch()
    Creates a watcher for monitoring HealthProbe changes in the resource manager.
    CompletableFuture<io.confluent.resourcemanager.api.model.ObjectList<io.confluent.rm.kafka.v1.HealthProbe>>
    listHealthProbes(List<io.confluent.resourcemanager.protobuf.apis.meta.v1.ScopeAttribute> scope, String continueToken)
    Lists a single page of HealthProbe resources in the given scope.

  • Method Details

    • createHealthProbe

      CompletableFuture<io.confluent.rm.kafka.v1.HealthProbe> createHealthProbe(io.confluent.rm.kafka.v1.HealthProbe healthProbe)
      Creates a new HealthProbe resource in the resource manager.
      Parameters:
      healthProbe - the HealthProbe to create
      Returns:
      a CompletableFuture that completes with the created HealthProbe

    • getHealthProbe

      CompletableFuture<Optional<io.confluent.rm.kafka.v1.HealthProbe>> getHealthProbe(io.confluent.resourcemanager.api.model.identifier.ObjectIdentifier<io.confluent.rm.kafka.v1.HealthProbe> id)
      Retrieves a HealthProbe resource from the resource manager.
      Parameters:
      id - the identifier of the HealthProbe to retrieve, with environment scope attributes
      Returns:
      a CompletableFuture that completes with an Optional containing the HealthProbe, or empty if the HealthProbe was not found

    • deleteHealthProbe

      CompletableFuture<Optional<io.confluent.rm.kafka.v1.HealthProbe>> deleteHealthProbe(io.confluent.resourcemanager.api.model.identifier.ObjectIdentifier<io.confluent.rm.kafka.v1.HealthProbe> id)
      Deletes a HealthProbe resource from the resource manager.
      Parameters:
      id - the identifier of the HealthProbe to delete, with environment scope attributes
      Returns:
      a CompletableFuture that completes with an Optional containing the deleted HealthProbe, or empty if the HealthProbe was not found

    • listHealthProbes

      CompletableFuture<io.confluent.resourcemanager.api.model.ObjectList<io.confluent.rm.kafka.v1.HealthProbe>> listHealthProbes(List<io.confluent.resourcemanager.protobuf.apis.meta.v1.ScopeAttribute> scope, String continueToken)
      Lists a single page of HealthProbe resources in the given scope. Pass a null/empty continueToken for the first page, or the continue token from a previous page's ListMeta to fetch the next page.
      Parameters:
      scope - the scope attributes to list within
      continueToken - the continuation token from a previous page, or null/empty for the first
      Returns:
      a CompletableFuture that completes with the page of HealthProbe resources in the scope

    • healthProbeWatch

      RmWatcher<io.confluent.rm.kafka.v1.HealthProbe> healthProbeWatch()
      Creates a watcher for monitoring HealthProbe changes in the resource manager.
      Returns:
      a Watcher that notifies of HealthProbe creation, modification, and deletion events