org.apache.flink.connector.kafka.sink

类 KafkaRecordSerializationSchemaBuilder<IN>

java.lang.Object

org.apache.flink.connector.kafka.sink.KafkaRecordSerializationSchemaBuilder<IN>

类型参数:

IN - type of records to be serialized

@PublicEvolving
public class KafkaRecordSerializationSchemaBuilder<IN>
extends Object

Builder to construct KafkaRecordSerializationSchema.

This class should give a first entrypoint when trying to serialize elements to ProducerRecord. The following examples show some of the possibilities.

Simple key-value serialization:
 
 KafkaRecordSerializationSchema.builder()
     .setTopic("topic)
     .setKeySerializationSchema(new SimpleStringSchema())
     .setValueSerializationSchema(new SimpleStringSchema())
     .build()
 

Using Kafka's serialization stack:
 
 KafkaRecordSerializationSchema.builder()
     .setTopic("topic)
     .setKeySerializer(StringSerializer.class)
     .setKafkaValueSerializer(StringSerializer.class)
     .build()
 

With custom partitioner:
 
 KafkaRecordSerializationSchema.builder()
     .setTopic("topic)
     .setPartitioner(MY_FLINK_PARTITIONER)
     .setValueSerializationSchema(StringSerializer.class)
     .build()
 

The different serialization methods for key and value are mutually exclusive thus i.e. it is not possible to use setKeySerializationSchema(SerializationSchema) and setKafkaKeySerializer(Class) on the same builder instance.

It is necessary to configure exactly one serialization method for the value and a topic.

另请参阅:

KafkaRecordSerializationSchema.builder()

构造器概要

构造器

构造器和说明
KafkaRecordSerializationSchemaBuilder()

方法概要

限定符和类型	方法和说明
KafkaRecordSerializationSchema<IN>	build() Constructs the KafkaRecordSerializationSchemaBuilder with the configured properties.
<T extends IN> KafkaRecordSerializationSchemaBuilder<T>	setKafkaKeySerializer(Class<? extends org.apache.kafka.common.serialization.Serializer<? super T>> keySerializer) Sets Kafka's Serializer to serialize incoming elements to the key of the ProducerRecord.
<T extends IN,S extends org.apache.kafka.common.serialization.Serializer<? super T>> KafkaRecordSerializationSchemaBuilder<T>	setKafkaKeySerializer(Class<S> keySerializer, Map<String,String> configuration) Sets a configurable Kafka Serializer and pass a configuration to serialize incoming elements to the key of the ProducerRecord.
<T extends IN> KafkaRecordSerializationSchemaBuilder<T>	setKafkaValueSerializer(Class<? extends org.apache.kafka.common.serialization.Serializer<? super T>> valueSerializer) Sets Kafka's Serializer to serialize incoming elements to the value of the ProducerRecord.
<T extends IN,S extends org.apache.kafka.common.serialization.Serializer<? super T>> KafkaRecordSerializationSchemaBuilder<T>	setKafkaValueSerializer(Class<S> valueSerializer, Map<String,String> configuration) Sets a configurable Kafka Serializer and pass a configuration to serialize incoming elements to the value of the ProducerRecord.
<T extends IN> KafkaRecordSerializationSchemaBuilder<T>	setKeySerializationSchema(org.apache.flink.api.common.serialization.SerializationSchema<? super T> keySerializationSchema) Sets a SerializationSchema which is used to serialize the incoming element to the key of the ProducerRecord.
<T extends IN> KafkaRecordSerializationSchemaBuilder<T>	setPartitioner(FlinkKafkaPartitioner<? super T> partitioner) Sets a custom partitioner determining the target partition of the target topic.
KafkaRecordSerializationSchemaBuilder<IN>	setTopic(String topic) Sets a fixed topic which used as destination for all records.
<T extends IN> KafkaRecordSerializationSchemaBuilder<T>	setTopicSelector(TopicSelector<? super T> topicSelector) Sets a topic selector which computes the target topic for every incoming record.
<T extends IN> KafkaRecordSerializationSchemaBuilder<T>	setValueSerializationSchema(org.apache.flink.api.common.serialization.SerializationSchema<T> valueSerializationSchema) Sets a SerializationSchema which is used to serialize the incoming element to the value of the ProducerRecord.

从类继承的方法 java.lang.Object

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

构造器详细资料

KafkaRecordSerializationSchemaBuilder

public KafkaRecordSerializationSchemaBuilder()

方法详细资料

setPartitioner

public <T extends IN> KafkaRecordSerializationSchemaBuilder<T> setPartitioner(FlinkKafkaPartitioner<? super T> partitioner)

Sets a custom partitioner determining the target partition of the target topic.

参数:

partitioner -

返回:

this

setTopic

public KafkaRecordSerializationSchemaBuilder<IN> setTopic(String topic)

Sets a fixed topic which used as destination for all records.

参数:

topic -

返回:

this

setTopicSelector

public <T extends IN> KafkaRecordSerializationSchemaBuilder<T> setTopicSelector(TopicSelector<? super T> topicSelector)

Sets a topic selector which computes the target topic for every incoming record.

参数:

topicSelector -

返回:

this

setKeySerializationSchema

public <T extends IN> KafkaRecordSerializationSchemaBuilder<T> setKeySerializationSchema(org.apache.flink.api.common.serialization.SerializationSchema<? super T> keySerializationSchema)

Sets a SerializationSchema which is used to serialize the incoming element to the key of the ProducerRecord.

参数:

keySerializationSchema -

返回:

this

setKafkaKeySerializer

public <T extends IN> KafkaRecordSerializationSchemaBuilder<T> setKafkaKeySerializer(Class<? extends org.apache.kafka.common.serialization.Serializer<? super T>> keySerializer)

Sets Kafka's Serializer to serialize incoming elements to the key of the ProducerRecord.

参数:

keySerializer -

返回:

this

setKafkaKeySerializer

public <T extends IN,S extends org.apache.kafka.common.serialization.Serializer<? super T>> KafkaRecordSerializationSchemaBuilder<T> setKafkaKeySerializer(Class<S> keySerializer,
                                                                                                                                                           Map<String,String> configuration)

Sets a configurable Kafka Serializer and pass a configuration to serialize incoming elements to the key of the ProducerRecord.

类型参数:

S - type of the used serializer class

参数:

keySerializer -

configuration -

返回:

this

setValueSerializationSchema

public <T extends IN> KafkaRecordSerializationSchemaBuilder<T> setValueSerializationSchema(org.apache.flink.api.common.serialization.SerializationSchema<T> valueSerializationSchema)

Sets a SerializationSchema which is used to serialize the incoming element to the value of the ProducerRecord.

参数:

valueSerializationSchema -

返回:

this

setKafkaValueSerializer

public <T extends IN> KafkaRecordSerializationSchemaBuilder<T> setKafkaValueSerializer(Class<? extends org.apache.kafka.common.serialization.Serializer<? super T>> valueSerializer)

Sets Kafka's Serializer to serialize incoming elements to the value of the ProducerRecord.

参数:

valueSerializer -

返回:

this

setKafkaValueSerializer

public <T extends IN,S extends org.apache.kafka.common.serialization.Serializer<? super T>> KafkaRecordSerializationSchemaBuilder<T> setKafkaValueSerializer(Class<S> valueSerializer,
                                                                                                                                                             Map<String,String> configuration)

Sets a configurable Kafka Serializer and pass a configuration to serialize incoming elements to the value of the ProducerRecord.

类型参数:

S - type of the used serializer class

参数:

valueSerializer -

configuration -

返回:

this

build

public KafkaRecordSerializationSchema<IN> build()

Constructs the KafkaRecordSerializationSchemaBuilder with the configured properties.

返回:

KafkaRecordSerializationSchema