Annotation Interface SuppressKafkaInternalApiUsage

@Documented @Public @Retention(RUNTIME) @Target({TYPE,METHOD,FIELD,CONSTRUCTOR}) public @interface SuppressKafkaInternalApiUsage
Marks a class, method, field, or constructor as intentionally permitted to reference Kafka classes that are not part of the InterfaceAudience.Public surface. The KafkaInternalApiChecker build plugin honours this annotation: a reference to an internal Kafka class from an element (or its enclosing class) carrying this annotation is skipped, and the supplied value() is printed by the checker so reviewers can see why the exception was granted.

Use sparingly — every suppression is a place where the consumer accepts the risk of Kafka-internal change.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    value
    Human-readable justification for the suppression.

  • Element Details

    • value

      String value
      Human-readable justification for the suppression. Printed by the checker when the suppression is honoured.
      Default:
      ""