org.apache.flink.streaming.connectors.kafka.table

Class KafkaOptions

java.lang.Object

org.apache.flink.streaming.connectors.kafka.table.KafkaOptions

public class KafkaOptions
extends Object

Option utils for Kafka table source sink.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KafkaOptions.StartupOptions Kafka startup options.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTIES_PREFIX
static ConfigOption<String>	PROPS_BOOTSTRAP_SERVERS
static ConfigOption<String>	PROPS_GROUP_ID
static ConfigOption<String>	SCAN_STARTUP_MODE
static String	SCAN_STARTUP_MODE_VALUE_EARLIEST
static String	SCAN_STARTUP_MODE_VALUE_GROUP_OFFSETS
static String	SCAN_STARTUP_MODE_VALUE_LATEST
static String	SCAN_STARTUP_MODE_VALUE_SPECIFIC_OFFSETS
static String	SCAN_STARTUP_MODE_VALUE_TIMESTAMP
static ConfigOption<String>	SCAN_STARTUP_SPECIFIC_OFFSETS
static ConfigOption<Long>	SCAN_STARTUP_TIMESTAMP_MILLIS
static ConfigOption<String>	SINK_PARTITIONER
static String	SINK_PARTITIONER_VALUE_FIXED
static String	SINK_PARTITIONER_VALUE_ROUND_ROBIN
static ConfigOption<String>	TOPIC

Method Summary

Modifier and Type	Method and Description
static Optional<FlinkKafkaPartitioner<RowData>>	getFlinkKafkaPartitioner(ReadableConfig tableOptions, ClassLoader classLoader) The partitioner can be either "fixed", "round-robin" or a customized partitioner full class name.
static Properties	getKafkaProperties(Map<String,String> tableOptions)
static KafkaOptions.StartupOptions	getStartupOptions(ReadableConfig tableOptions, String topic)
static Map<Integer,Long>	parseSpecificOffsets(String specificOffsetsStr, String optionKey) Parses SpecificOffsets String to Map.
static void	validateTableOptions(ReadableConfig tableOptions)

Methods inherited from class java.lang.Object

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

Field Detail

TOPIC

public static final ConfigOption<String> TOPIC

PROPS_BOOTSTRAP_SERVERS

public static final ConfigOption<String> PROPS_BOOTSTRAP_SERVERS

PROPS_GROUP_ID

public static final ConfigOption<String> PROPS_GROUP_ID

SCAN_STARTUP_MODE

public static final ConfigOption<String> SCAN_STARTUP_MODE

SCAN_STARTUP_SPECIFIC_OFFSETS

public static final ConfigOption<String> SCAN_STARTUP_SPECIFIC_OFFSETS

SCAN_STARTUP_TIMESTAMP_MILLIS

public static final ConfigOption<Long> SCAN_STARTUP_TIMESTAMP_MILLIS

SINK_PARTITIONER

public static final ConfigOption<String> SINK_PARTITIONER

SCAN_STARTUP_MODE_VALUE_EARLIEST

public static final String SCAN_STARTUP_MODE_VALUE_EARLIEST

See Also:

Constant Field Values

SCAN_STARTUP_MODE_VALUE_LATEST

public static final String SCAN_STARTUP_MODE_VALUE_LATEST

See Also:

Constant Field Values

SCAN_STARTUP_MODE_VALUE_GROUP_OFFSETS

public static final String SCAN_STARTUP_MODE_VALUE_GROUP_OFFSETS

See Also:

Constant Field Values

SCAN_STARTUP_MODE_VALUE_SPECIFIC_OFFSETS

public static final String SCAN_STARTUP_MODE_VALUE_SPECIFIC_OFFSETS

See Also:

Constant Field Values

SCAN_STARTUP_MODE_VALUE_TIMESTAMP

public static final String SCAN_STARTUP_MODE_VALUE_TIMESTAMP

See Also:

Constant Field Values

SINK_PARTITIONER_VALUE_FIXED

public static final String SINK_PARTITIONER_VALUE_FIXED

See Also:

Constant Field Values

SINK_PARTITIONER_VALUE_ROUND_ROBIN

public static final String SINK_PARTITIONER_VALUE_ROUND_ROBIN

See Also:

Constant Field Values

PROPERTIES_PREFIX

public static final String PROPERTIES_PREFIX

See Also:

Constant Field Values

Method Detail

validateTableOptions

public static void validateTableOptions(ReadableConfig tableOptions)

getStartupOptions

public static KafkaOptions.StartupOptions getStartupOptions(ReadableConfig tableOptions,
                                                            String topic)

getKafkaProperties

public static Properties getKafkaProperties(Map<String,String> tableOptions)

getFlinkKafkaPartitioner

public static Optional<FlinkKafkaPartitioner<RowData>> getFlinkKafkaPartitioner(ReadableConfig tableOptions,
                                                                                ClassLoader classLoader)

The partitioner can be either "fixed", "round-robin" or a customized partitioner full class name.

parseSpecificOffsets

public static Map<Integer,Long> parseSpecificOffsets(String specificOffsetsStr,
                                                     String optionKey)

Parses SpecificOffsets String to Map.

SpecificOffsets String format was given as following:

     scan.startup.specific-offsets = partition:0,offset:42;partition:1,offset:300
 

Returns:

SpecificOffsets with Map format, key is partition, and value is offset