Interface ConnectPlugin

All Superinterfaces:
Versioned
All Known Subinterfaces:
ConnectorClientConfigOverridePolicy, ConnectRestExtension, Converter, HeaderConverter, Predicate<R>, Transformation<R>
All Known Implementing Classes:
Connector, SimpleHeaderConverter, SinkConnector, SourceConnector, StringConverter
public interface ConnectPlugin extends Versioned
Interface for components that provide version and configuration specifications. This interface establishes a common contract for all Kafka Connect components that define a version and expose configurable properties, enabling uniform discovery and introspection of component configurations.

Components implementing this interface declare their version and configuration requirements through a ConfigDef object, which describes the configuration properties including their names, types, default values, validators, and documentation.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.kafka.common.config.ConfigDef
    config()
    Returns the configuration specification for this component.

    Methods inherited from interface Versioned

    version

  • Method Details

    • config

      org.apache.kafka.common.config.ConfigDef config()
      Returns the configuration specification for this component.

      The returned ConfigDef object describes all configuration properties that this component accepts, including their types, default values, validators, importance levels, and documentation strings.

      Returns:
      the configuration definition for this component; never null