software.amazon.kinesis.connectors.flink.serialization

Class KinesisDeserializationSchemaWrapper<T>

java.lang.Object

software.amazon.kinesis.connectors.flink.serialization.KinesisDeserializationSchemaWrapper<T>

Type Parameters:

T - The type created by the deserialization schema.

All Implemented Interfaces:

Serializable, org.apache.flink.api.java.typeutils.ResultTypeQueryable<T>, KinesisDeserializationSchema<T>

@Internal
public class KinesisDeserializationSchemaWrapper<T>
extends Object
implements KinesisDeserializationSchema<T>

A simple wrapper for using the DeserializationSchema with the KinesisDeserializationSchema interface.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
KinesisDeserializationSchemaWrapper(org.apache.flink.api.common.serialization.DeserializationSchema<T> deserializationSchema)

Method Summary

Modifier and Type	Method and Description
T	deserialize(byte[] recordValue, String partitionKey, String seqNum, long approxArrivalTimestamp, String stream, String shardId) Deserializes a Kinesis record's bytes.
org.apache.flink.api.common.typeinfo.TypeInformation<T>	getProducedType()
void	open(org.apache.flink.api.common.serialization.DeserializationSchema.InitializationContext context) Initialization method for the schema.

Methods inherited from class java.lang.Object

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

Constructor Detail

KinesisDeserializationSchemaWrapper

public KinesisDeserializationSchemaWrapper(org.apache.flink.api.common.serialization.DeserializationSchema<T> deserializationSchema)

Method Detail

open

public void open(org.apache.flink.api.common.serialization.DeserializationSchema.InitializationContext context)
          throws Exception

Description copied from interface: KinesisDeserializationSchema

Initialization method for the schema. It is called before the actual working methods KinesisDeserializationSchema.deserialize(byte[], java.lang.String, java.lang.String, long, java.lang.String, java.lang.String) and thus suitable for one time setup work.

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

Specified by:

open in interface KinesisDeserializationSchema<T>

Parameters:

context - Contextual information that can be used during initialization.

Throws:

Exception

deserialize

public T deserialize(byte[] recordValue,
                     String partitionKey,
                     String seqNum,
                     long approxArrivalTimestamp,
                     String stream,
                     String shardId)
              throws IOException

Description copied from interface: KinesisDeserializationSchema

Deserializes a Kinesis record's bytes. If the record cannot be deserialized, null may be returned. This informs the Flink Kinesis Consumer to process the Kinesis record without producing any output for it, i.e. effectively "skipping" the record.

Specified by:

deserialize in interface KinesisDeserializationSchema<T>

Parameters:

recordValue - the record's value as a byte array

partitionKey - the record's partition key at the time of writing

seqNum - the sequence number of this record in the Kinesis shard

approxArrivalTimestamp - the server-side timestamp of when Kinesis received and stored the record

stream - the name of the Kinesis stream that this record was sent to

shardId - The identifier of the shard the record was sent to

Returns:

the deserialized message as an Java object (null if the message cannot be deserialized).

Throws:

IOException

getProducedType

public org.apache.flink.api.common.typeinfo.TypeInformation<T> getProducedType()

Specified by:

getProducedType in interface org.apache.flink.api.java.typeutils.ResultTypeQueryable<T>