org.apache.flink.streaming.connectors.kafka

Class KafkaJsonTableSource.Builder<T extends KafkaJsonTableSource,B extends KafkaJsonTableSource.Builder>

java.lang.Object

org.apache.flink.streaming.connectors.kafka.KafkaTableSource.Builder<T,B>

org.apache.flink.streaming.connectors.kafka.KafkaJsonTableSource.Builder<T,B>

Type Parameters:

T - Type of the KafkaJsonTableSource produced by the builder.

B - Type of the KafkaJsonTableSource.Builder subclass.

Direct Known Subclasses:

Kafka010JsonTableSource.Builder, Kafka011JsonTableSource.Builder, Kafka08JsonTableSource.Builder, Kafka09JsonTableSource.Builder

Enclosing class:

KafkaJsonTableSource

protected abstract static class KafkaJsonTableSource.Builder<T extends KafkaJsonTableSource,B extends KafkaJsonTableSource.Builder>
extends KafkaTableSource.Builder<T,B>

Abstract builder for a KafkaJsonTableSource to be extended by builders of subclasses of KafkaJsonTableSource.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder()

Method Summary

Modifier and Type	Method and Description
protected void	configureTableSource(T source) Configures a TableSource with optional parameters.
B	failOnMissingField(boolean failOnMissingField) Sets flag whether to fail if a field is missing or not.
B	forJsonSchema(org.apache.flink.table.api.TableSchema jsonSchema) Sets the schema of the JSON-encoded Kafka messages.
protected org.apache.flink.table.api.TableSchema	getJsonSchema() Returns the configured JSON schema.
B	withTableToJsonMapping(Map<String,String> tableToJsonMapping) Sets a mapping from schema fields to fields of the JSON schema.

Methods inherited from class org.apache.flink.streaming.connectors.kafka.KafkaTableSource.Builder

build, builder, forTopic, fromEarliest, fromGroupOffsets, fromLatest, fromSpecificOffsets, getKafkaProps, getTableSchema, getTopic, supportsKafkaTimestamps, withKafkaProperties, withKafkaTimestampAsRowtimeAttribute, withProctimeAttribute, withRowtimeAttribute, withSchema

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

protected Builder()

Method Detail

forJsonSchema

public B forJsonSchema(org.apache.flink.table.api.TableSchema jsonSchema)

Sets the schema of the JSON-encoded Kafka messages. If not set, the JSON messages are decoded with the table schema.

Parameters:

jsonSchema - The schema of the JSON-encoded Kafka messages.

Returns:

The builder.

withTableToJsonMapping

public B withTableToJsonMapping(Map<String,String> tableToJsonMapping)

Sets a mapping from schema fields to fields of the JSON schema.

A field mapping is required if the fields of produced tables should be named different than the fields of the JSON records. The key of the provided Map refers to the field of the table schema, the value to the field in the JSON schema.

Parameters:

tableToJsonMapping - A mapping from table schema fields to JSON schema fields.

Returns:

The builder.

failOnMissingField

public B failOnMissingField(boolean failOnMissingField)

Sets flag whether to fail if a field is missing or not.

Parameters:

failOnMissingField - If set to true, the TableSource fails if a missing fields. If set to false, a missing field is set to null.

Returns:

The builder.

getJsonSchema

protected org.apache.flink.table.api.TableSchema getJsonSchema()

Returns the configured JSON schema. If no JSON schema was configured, the table schema is returned.

Returns:

The JSON schema for the TableSource.

configureTableSource

protected void configureTableSource(T source)

Description copied from class: KafkaTableSource.Builder

Configures a TableSource with optional parameters.

Overrides:

configureTableSource in class KafkaTableSource.Builder<T extends KafkaJsonTableSource,B extends KafkaJsonTableSource.Builder>

Parameters:

source - The TableSource to configure.