org.apache.kafka.connect.transforms.predicates

Interface Predicate<R extends ConnectRecord<R>>

Type Parameters:

R - The type of record.

All Superinterfaces:

AutoCloseable, org.apache.kafka.common.Configurable

public interface Predicate<R extends ConnectRecord<R>>
extends org.apache.kafka.common.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.

Method Summary

Modifier and Type	Method and Description
void	close()
org.apache.kafka.common.config.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 Detail

config

org.apache.kafka.common.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