Package org.apache.kafka.connect.transforms.predicates

Interface Predicate<R extends ConnectRecord<R>>

Type Parameters:
R - The type of record.
All Superinterfaces:
AutoCloseable, Configurable
public interface Predicate<R extends ConnectRecord<R>> extends Configurable, AutoCloseable

A predicate on records. Predicates can be used to conditionally apply a Transformation by configuring the transformation's predicate (and negate) configuration parameters. In particular, the Filter transformation can be conditionally applied in order to filter certain records from further processing.

Kafka Connect may discover implementations of this interface using the Java ServiceLoader mechanism. To support this, implementations of this interface should also contain a service provider configuration file in META-INF/services/org.apache.kafka.connect.transforms.predicates.Predicate.

Implement Monitorable to enable the predicate to register metrics. The following tags are automatically added to all metrics registered: connector set to connector name, task set to the task id and predicate set to the predicate alias.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
     
    ConfigDef
    config()
    Configuration specification for this predicate.
    boolean
    test(R record)
    Returns whether the given record satisfies this predicate.

    Methods inherited from interface org.apache.kafka.common.Configurable

    configure

  • Method Details

    • config

      ConfigDef config()
      Configuration specification for this predicate.
      Returns:
      the configuration definition for this predicate; never null

    • test

      boolean test(R record)
      Returns whether the given record satisfies this predicate.
      Parameters:
      record - the record to evaluate; may not be null
      Returns:
      true if the predicate matches, or false otherwise

    • close

      void close()
      Specified by:
      close in interface AutoCloseable