statefun-kinesis-io/src/main/java/org/apache/flink/statefun/sdk/kinesis/ingress/KinesisIngressDeserializer.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.kinesis.ingress;

import java.io.Serializable;

/**
 * Describes how to deserialize {@link IngressRecord}s consumed from AWS Kinesis into data types
 * that are processed by the system.
 *
 * @param <T> The type created by the ingress deserializer.
 */
public interface KinesisIngressDeserializer<T> extends Serializable {

  /**
   * Deserialize an input value from a {@link IngressRecord} consumed from AWS Kinesis.
   *
   * @param ingressRecord the {@link IngressRecord} consumed from AWS Kinesis.
   * @return the deserialized data object.
   */
  T deserialize(IngressRecord ingressRecord);
}