org.apache.flink.connector.kafka.sink

接口 KafkaRecordSerializationSchema<T>

类型参数:

T - the type of values being serialized

所有超级接口:

Serializable

@PublicEvolving
public interface KafkaRecordSerializationSchema<T>
extends Serializable

A serialization schema which defines how to convert a value of type T to ProducerRecord.

嵌套类概要

嵌套类

限定符和类型	接口和说明
static interface	KafkaRecordSerializationSchema.KafkaSinkContext Context providing information of the kafka record target location.

方法概要

限定符和类型	方法和说明
static <T> KafkaRecordSerializationSchemaBuilder<T>	builder() Creates a default schema builder to provide common building blocks i.e. key serialization, value serialization, partitioning.
default void	open(org.apache.flink.api.common.serialization.SerializationSchema.InitializationContext context, KafkaRecordSerializationSchema.KafkaSinkContext sinkContext) Initialization method for the schema.
org.apache.kafka.clients.producer.ProducerRecord<byte[],byte[]>	serialize(T element, KafkaRecordSerializationSchema.KafkaSinkContext context, Long timestamp) Serializes given element and returns it as a ProducerRecord.

方法详细资料

open

default void open(org.apache.flink.api.common.serialization.SerializationSchema.InitializationContext context,
                  KafkaRecordSerializationSchema.KafkaSinkContext sinkContext)
           throws Exception

Initialization method for the schema. It is called before the actual working methods serialize(Object, KafkaSinkContext, Long) and thus suitable for one time setup work.

The provided SerializationSchema.InitializationContext can be used to access additional features such as e.g. registering user metrics.

参数:

context - Contextual information that can be used during initialization.

sinkContext - runtime information i.e. partitions, subtaskId

抛出:

Exception

serialize

@Nullable
org.apache.kafka.clients.producer.ProducerRecord<byte[],byte[]> serialize(T element,
                                                                                    KafkaRecordSerializationSchema.KafkaSinkContext context,
                                                                                    Long timestamp)

Serializes given element and returns it as a ProducerRecord.

参数:

element - element to be serialized

context - context to possibly determine target partition

timestamp - timestamp

返回:

Kafka ProducerRecord or null if the given element cannot be serialized

builder

static <T> KafkaRecordSerializationSchemaBuilder<T> builder()

Creates a default schema builder to provide common building blocks i.e. key serialization, value serialization, partitioning.

类型参数:

T - type of incoming elements

返回:

KafkaRecordSerializationSchemaBuilder