Package io.debezium.converters

Class CloudEventsConverterConfig

java.lang.Object

org.apache.kafka.common.config.AbstractConfig

org.apache.kafka.connect.storage.ConverterConfig

io.debezium.converters.CloudEventsConverterConfig

public class CloudEventsConverterConfig
extends org.apache.kafka.connect.storage.ConverterConfig

Configuration options for CloudEventsConverter instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	CloudEventsConverterConfig.MetadataSource
static enum	CloudEventsConverterConfig.MetadataSourceValue	The set of predefined MetadataSourceValue options

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLOUDEVENTS_DATA_SERIALIZER_TYPE_CONFIG
static final String	CLOUDEVENTS_DATA_SERIALIZER_TYPE_DEFAULT
private static final String	CLOUDEVENTS_DATA_SERIALIZER_TYPE_DOC
static final String	CLOUDEVENTS_EXTENSION_ATTRIBUTES_ENABLE_CONFIG
static final boolean	CLOUDEVENTS_EXTENSION_ATTRIBUTES_ENABLE_DEFAULT
private static final String	CLOUDEVENTS_EXTENSION_ATTRIBUTES_ENABLE_DOC
static final String	CLOUDEVENTS_METADATA_SOURCE_CONFIG
static final String	CLOUDEVENTS_METADATA_SOURCE_DEFAULT
private static final String	CLOUDEVENTS_METADATA_SOURCE_DOC
static final String	CLOUDEVENTS_SCHEMA_CLOUDEVENTS_NAME_CONFIG
static final String	CLOUDEVENTS_SCHEMA_CLOUDEVENTS_NAME_DEFAULT
private static final String	CLOUDEVENTS_SCHEMA_CLOUDEVENTS_NAME_DOC
static final String	CLOUDEVENTS_SCHEMA_DATA_NAME_SOURCE_HEADERS_ENABLE_CONFIG
static final boolean	CLOUDEVENTS_SCHEMA_DATA_NAME_SOURCE_HEADERS_ENABLE_DEFAULT
private static final String	CLOUDEVENTS_SCHEMA_DATA_NAME_SOURCE_HEADERS_ENABLE_DOC
static final String	CLOUDEVENTS_SCHEMA_NAME_ADJUSTMENT_MODE_CONFIG
static final String	CLOUDEVENTS_SCHEMA_NAME_ADJUSTMENT_MODE_DEFAULT
private static final String	CLOUDEVENTS_SCHEMA_NAME_ADJUSTMENT_MODE_DOC
static final String	CLOUDEVENTS_SERIALIZER_TYPE_CONFIG
static final String	CLOUDEVENTS_SERIALIZER_TYPE_DEFAULT
private static final String	CLOUDEVENTS_SERIALIZER_TYPE_DOC
private static final org.apache.kafka.common.config.ConfigDef	CONFIG

Fields inherited from class org.apache.kafka.connect.storage.ConverterConfig

TYPE_CONFIG

Fields inherited from class org.apache.kafka.common.config.AbstractConfig

CONFIG_PROVIDERS_CONFIG

Constructor Summary

Constructors

Constructor	Description
CloudEventsConverterConfig(Map<String,?> props)

Method Summary

Modifier and Type	Method	Description
SerializerType	cloudeventsDataSerializerTypeConfig()	Return which serializer type is used to serialize the data field of CloudEvents values.
SerializerType	cloudeventsSerializerType()	Return which serializer type is used to serialize CloudEvents values.
static org.apache.kafka.common.config.ConfigDef	configDef()
boolean	extensionAttributesEnable()	Return whether to include extension attributes in a cloud event.
CloudEventsConverterConfig.MetadataSource	metadataSource()	Return from where to retrieve metadata
String	schemaCloudEventsName()	Return CloudEvents schema name under which the schema is registered in a Schema Registry
CommonConnectorConfig.SchemaNameAdjustmentMode	schemaNameAdjustmentMode()	Return which adjustment mode is used to build message schema names.

Methods inherited from class org.apache.kafka.connect.storage.ConverterConfig

newConfigDef, type

Methods inherited from class org.apache.kafka.common.config.AbstractConfig

documentationOf, equals, get, getBoolean, getClass, getConfiguredInstance, getConfiguredInstance, getConfiguredInstances, getConfiguredInstances, getConfiguredInstances, getDouble, getInt, getList, getLong, getPassword, getShort, getString, hashCode, ignore, logUnused, nonInternalValues, originals, originals, originalsStrings, originalsWithPrefix, originalsWithPrefix, postProcessParsedConfig, typeOf, unused, values, valuesWithPrefixAllOrNothing, valuesWithPrefixOverride

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

CLOUDEVENTS_SERIALIZER_TYPE_CONFIG

public static final String CLOUDEVENTS_SERIALIZER_TYPE_CONFIG

See Also:

• Constant Field Values

CLOUDEVENTS_SERIALIZER_TYPE_DEFAULT

public static final String CLOUDEVENTS_SERIALIZER_TYPE_DEFAULT

See Also:

• Constant Field Values

CLOUDEVENTS_SERIALIZER_TYPE_DOC

private static final String CLOUDEVENTS_SERIALIZER_TYPE_DOC

See Also:

• Constant Field Values

CLOUDEVENTS_DATA_SERIALIZER_TYPE_CONFIG

public static final String CLOUDEVENTS_DATA_SERIALIZER_TYPE_CONFIG

See Also:

• Constant Field Values

CLOUDEVENTS_DATA_SERIALIZER_TYPE_DEFAULT

public static final String CLOUDEVENTS_DATA_SERIALIZER_TYPE_DEFAULT

See Also:

• Constant Field Values

CLOUDEVENTS_DATA_SERIALIZER_TYPE_DOC

private static final String CLOUDEVENTS_DATA_SERIALIZER_TYPE_DOC

See Also:

• Constant Field Values

CLOUDEVENTS_EXTENSION_ATTRIBUTES_ENABLE_CONFIG

public static final String CLOUDEVENTS_EXTENSION_ATTRIBUTES_ENABLE_CONFIG

See Also:

• Constant Field Values

CLOUDEVENTS_EXTENSION_ATTRIBUTES_ENABLE_DEFAULT

public static final boolean CLOUDEVENTS_EXTENSION_ATTRIBUTES_ENABLE_DEFAULT

See Also:

• Constant Field Values

CLOUDEVENTS_EXTENSION_ATTRIBUTES_ENABLE_DOC

private static final String CLOUDEVENTS_EXTENSION_ATTRIBUTES_ENABLE_DOC

See Also:

• Constant Field Values

CLOUDEVENTS_SCHEMA_NAME_ADJUSTMENT_MODE_CONFIG

public static final String CLOUDEVENTS_SCHEMA_NAME_ADJUSTMENT_MODE_CONFIG

See Also:

• Constant Field Values

CLOUDEVENTS_SCHEMA_NAME_ADJUSTMENT_MODE_DEFAULT

public static final String CLOUDEVENTS_SCHEMA_NAME_ADJUSTMENT_MODE_DEFAULT

See Also:

• Constant Field Values

CLOUDEVENTS_SCHEMA_NAME_ADJUSTMENT_MODE_DOC

private static final String CLOUDEVENTS_SCHEMA_NAME_ADJUSTMENT_MODE_DOC

See Also:

• Constant Field Values

CLOUDEVENTS_SCHEMA_CLOUDEVENTS_NAME_CONFIG

public static final String CLOUDEVENTS_SCHEMA_CLOUDEVENTS_NAME_CONFIG

See Also:

• Constant Field Values

CLOUDEVENTS_SCHEMA_CLOUDEVENTS_NAME_DEFAULT

public static final String CLOUDEVENTS_SCHEMA_CLOUDEVENTS_NAME_DEFAULT

CLOUDEVENTS_SCHEMA_CLOUDEVENTS_NAME_DOC

private static final String CLOUDEVENTS_SCHEMA_CLOUDEVENTS_NAME_DOC

See Also:

• Constant Field Values

CLOUDEVENTS_SCHEMA_DATA_NAME_SOURCE_HEADERS_ENABLE_CONFIG

public static final String CLOUDEVENTS_SCHEMA_DATA_NAME_SOURCE_HEADERS_ENABLE_CONFIG

See Also:

• Constant Field Values

CLOUDEVENTS_SCHEMA_DATA_NAME_SOURCE_HEADERS_ENABLE_DEFAULT

public static final boolean CLOUDEVENTS_SCHEMA_DATA_NAME_SOURCE_HEADERS_ENABLE_DEFAULT

See Also:

• Constant Field Values

CLOUDEVENTS_SCHEMA_DATA_NAME_SOURCE_HEADERS_ENABLE_DOC

private static final String CLOUDEVENTS_SCHEMA_DATA_NAME_SOURCE_HEADERS_ENABLE_DOC

See Also:

• Constant Field Values

CLOUDEVENTS_METADATA_SOURCE_CONFIG

public static final String CLOUDEVENTS_METADATA_SOURCE_CONFIG

See Also:

• Constant Field Values

CLOUDEVENTS_METADATA_SOURCE_DEFAULT

public static final String CLOUDEVENTS_METADATA_SOURCE_DEFAULT

See Also:

• Constant Field Values

CLOUDEVENTS_METADATA_SOURCE_DOC

private static final String CLOUDEVENTS_METADATA_SOURCE_DOC

See Also:

• Constant Field Values

CONFIG

private static final org.apache.kafka.common.config.ConfigDef CONFIG

Constructor Details

CloudEventsConverterConfig

public CloudEventsConverterConfig(Map<String,?> props)

Method Details

configDef

public static org.apache.kafka.common.config.ConfigDef configDef()

cloudeventsSerializerType

public SerializerType cloudeventsSerializerType()

Return which serializer type is used to serialize CloudEvents values.

Returns:

serializer type

cloudeventsDataSerializerTypeConfig

public SerializerType cloudeventsDataSerializerTypeConfig()

Return which serializer type is used to serialize the data field of CloudEvents values.

Returns:

serializer type

extensionAttributesEnable

public boolean extensionAttributesEnable()

Return whether to include extension attributes in a cloud event.

Returns:

whether to enable extension attributes

schemaNameAdjustmentMode

public CommonConnectorConfig.SchemaNameAdjustmentMode schemaNameAdjustmentMode()

Return which adjustment mode is used to build message schema names.

Returns:

schema name adjustment mode

schemaCloudEventsName

public String schemaCloudEventsName()

Return CloudEvents schema name under which the schema is registered in a Schema Registry

Returns:

CloudEvents schema name

metadataSource

public CloudEventsConverterConfig.MetadataSource metadataSource()

Return from where to retrieve metadata

Returns:

metadata source