org.apache.flink.streaming.connectors.kinesis.table

Class RowDataKinesisDeserializationSchema

java.lang.Object

org.apache.flink.streaming.connectors.kinesis.table.RowDataKinesisDeserializationSchema

All Implemented Interfaces:

Serializable, ResultTypeQueryable<RowData>, KinesisDeserializationSchema<RowData>

@Internal
public final class RowDataKinesisDeserializationSchema
extends Object
implements KinesisDeserializationSchema<RowData>

A KinesisDeserializationSchema adaptor for RowData records that delegates physical data deserialization to an inner DeserializationSchema and appends requested metadata to the end of the deserialized RowData record.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	RowDataKinesisDeserializationSchema.Metadata Internal type for enumerating available metadata.

Constructor Summary

Constructors

Constructor and Description
RowDataKinesisDeserializationSchema(DeserializationSchema<RowData> physicalDeserializer, TypeInformation<RowData> producedTypeInfo, List<RowDataKinesisDeserializationSchema.Metadata> requestedMetadataFields)

Method Summary

Modifier and Type	Method and Description
RowData	deserialize(byte[] recordValue, String partitionKey, String seqNum, long approxArrivalTimestamp, String stream, String shardId) Deserializes a Kinesis record's bytes.
TypeInformation<RowData>	getProducedType() Gets the data type (as a TypeInformation) produced by this function or input format.
void	open(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

RowDataKinesisDeserializationSchema

public RowDataKinesisDeserializationSchema(DeserializationSchema<RowData> physicalDeserializer,
                                           TypeInformation<RowData> producedTypeInfo,
                                           List<RowDataKinesisDeserializationSchema.Metadata> requestedMetadataFields)

Method Detail

open

public void open(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<RowData>

Parameters:

context - Contextual information that can be used during initialization.

Throws:

Exception

deserialize

public RowData 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<RowData>

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 TypeInformation<RowData> getProducedType()

Description copied from interface: ResultTypeQueryable

Gets the data type (as a TypeInformation) produced by this function or input format.

Specified by:

getProducedType in interface ResultTypeQueryable<RowData>

Returns:

The data type produced by this function or input format.