software.amazon.kinesis.connectors.flink.table

Class KinesisOptions

java.lang.Object

software.amazon.kinesis.connectors.flink.table.KinesisOptions

@Internal
public class KinesisOptions
extends Object

Options for Kinesis tables supported by the CREATE TABLE ... WITH ... clause of the Flink SQL dialect and the Flink Table API.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AWS_PROPERTIES_PREFIX Prefix for properties defined in AWSConfigConstants that are delegated to FlinkKinesisConsumer and FlinkKinesisProducer.
static String	CONSUMER_PREFIX Prefix for properties defined in ConsumerConfigConstants that are delegated to FlinkKinesisConsumer.
static String[]	NON_VALIDATED_PREFIXES Prefixes of properties that are validated by downstream components and should not be validated by the Table API infrastructure.
static String	PRODUCER_PREFIX Prefix for properties defined in KinesisProducerConfiguration that are delegated to FlinkKinesisConsumer.
static org.apache.flink.configuration.ConfigOption<String>	SINK_PARTITIONER
static org.apache.flink.configuration.ConfigOption<String>	SINK_PARTITIONER_FIELD_DELIMITER
static String	SINK_PARTITIONER_VALUE_FIXED
static String	SINK_PARTITIONER_VALUE_RANDOM
static org.apache.flink.configuration.ConfigOption<String>	STREAM
static Set<String>	TABLE_LEVEL_OPTIONS Options handled and validated by the table-level layer.

Method Summary

Modifier and Type	Method and Description
static Properties	getConsumerProperties(Map<String,String> tableOptions) Derive properties to be passed to the FlinkKinesisConsumer.
static KinesisPartitioner<org.apache.flink.table.data.RowData>	getKinesisPartitioner(org.apache.flink.configuration.ReadableConfig tableOptions, org.apache.flink.table.catalog.CatalogTable targetTable, ClassLoader classLoader) Constructs the kinesis partitioner for a targetTable based on the currently set tableOptions.
static Properties	getProducerProperties(Map<String,String> tableOptions) Derive properties to be passed to the FlinkKinesisProducer.

Methods inherited from class java.lang.Object

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

Field Detail

AWS_PROPERTIES_PREFIX

public static final String AWS_PROPERTIES_PREFIX

Prefix for properties defined in AWSConfigConstants that are delegated to FlinkKinesisConsumer and FlinkKinesisProducer.

See Also:

Constant Field Values

CONSUMER_PREFIX

public static final String CONSUMER_PREFIX

Prefix for properties defined in ConsumerConfigConstants that are delegated to FlinkKinesisConsumer.

See Also:

Constant Field Values

PRODUCER_PREFIX

public static final String PRODUCER_PREFIX

Prefix for properties defined in KinesisProducerConfiguration that are delegated to FlinkKinesisConsumer.

See Also:

Constant Field Values

NON_VALIDATED_PREFIXES

public static final String[] NON_VALIDATED_PREFIXES

Prefixes of properties that are validated by downstream components and should not be validated by the Table API infrastructure.

STREAM

public static final org.apache.flink.configuration.ConfigOption<String> STREAM

SINK_PARTITIONER

public static final org.apache.flink.configuration.ConfigOption<String> SINK_PARTITIONER

SINK_PARTITIONER_FIELD_DELIMITER

public static final org.apache.flink.configuration.ConfigOption<String> SINK_PARTITIONER_FIELD_DELIMITER

SINK_PARTITIONER_VALUE_FIXED

public static final String SINK_PARTITIONER_VALUE_FIXED

See Also:

Constant Field Values

SINK_PARTITIONER_VALUE_RANDOM

public static final String SINK_PARTITIONER_VALUE_RANDOM

See Also:

Constant Field Values

TABLE_LEVEL_OPTIONS

public static final Set<String> TABLE_LEVEL_OPTIONS

Options handled and validated by the table-level layer.

Method Detail

getConsumerProperties

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

Derive properties to be passed to the FlinkKinesisConsumer.

getProducerProperties

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

Derive properties to be passed to the FlinkKinesisProducer.

getKinesisPartitioner

public static KinesisPartitioner<org.apache.flink.table.data.RowData> getKinesisPartitioner(org.apache.flink.configuration.ReadableConfig tableOptions,
                                                                                            org.apache.flink.table.catalog.CatalogTable targetTable,
                                                                                            ClassLoader classLoader)

Constructs the kinesis partitioner for a targetTable based on the currently set tableOptions.

The following rules are applied with decreasing precedence order.

• If targetTable is partitioned, return a RowDataKinesisPartitioner.
• If the partitioner type is not set, return a RandomKinesisPartitioner.
• If a specific partitioner type alias is used, instantiate the corresponding type
• Interpret the partitioner type as a classname of a user-defined partitioner.

Parameters:

tableOptions - A read-only set of config options that determines the partitioner type.

targetTable - A catalog version of the table backing the partitioner.

classLoader - A ClassLoader to use for loading user-defined partitioner classes.