org.apache.flink.cdc.common.factories

接口 Factory

所有已知子接口:

DataSinkFactory, DataSourceFactory

@PublicEvolving
public interface Factory

Base interface for all kind of factories that create object instances from a list of key-value pairs in Flink CDC DataSource & DataSink API.

A factory is uniquely identified by Class and identifier().

The list of available factories is discovered using Java's Service Provider Interfaces (SPI). Classes that implement this interface can be added to META_INF/services/Factory in JAR files.

Every factory declares a set of required and optional options. This information will not be used during discovery but is helpful when generating documentation and performing validation. A factory may discover further (nested) factories, the options of the nested factories must not be declared in the sets of this factory.

It is the responsibility of each factory to perform validation before returning an instance.

嵌套类概要

嵌套类

限定符和类型	接口和说明
static interface	Factory.Context Provides session information describing the factory to be accessed.

方法概要

限定符和类型	方法和说明
String	identifier() Returns a unique identifier among same factory interfaces.
Set<ConfigOption<?>>	optionalOptions() Returns a set of ConfigOption that an implementation of this factory consumes in addition to requiredOptions().
Set<ConfigOption<?>>	requiredOptions() Returns a set of ConfigOption that an implementation of this factory requires in addition to optionalOptions().

方法详细资料

identifier

String identifier()

Returns a unique identifier among same factory interfaces.

requiredOptions

Set<ConfigOption<?>> requiredOptions()

Returns a set of ConfigOption that an implementation of this factory requires in addition to optionalOptions().

optionalOptions

Set<ConfigOption<?>> optionalOptions()

Returns a set of ConfigOption that an implementation of this factory consumes in addition to requiredOptions().