statefun-kafka-io/src/main/java/org/apache/flink/statefun/sdk/kafka/KafkaEgressSerializer.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.flink.statefun.sdk.kafka;

import java.io.Serializable;
import org.apache.kafka.clients.producer.ProducerRecord;

/**
 * A {@link KafkaEgressSerializer} defines how to serialize values of type {@code T} into {@link
 * ProducerRecord ProducerRecords}.
 *
 * @param <OutT> the type of values being serialized
 */
public interface KafkaEgressSerializer<OutT> extends Serializable {

  /**
   * Serializes given element and returns it as a {@link ProducerRecord}.
   *
   * @param t element to be serialized
   * @return Kafka {@link ProducerRecord}
   */
  ProducerRecord<byte[], byte[]> serialize(OutT t);
}