org.apache.flink.formats.avro.registry.confluent

Class ConfluentRegistryAvroDeserializationSchema<T>

java.lang.Object

org.apache.flink.formats.avro.AvroDeserializationSchema<T>

org.apache.flink.formats.avro.RegistryAvroDeserializationSchema<T>

org.apache.flink.formats.avro.registry.confluent.ConfluentRegistryAvroDeserializationSchema<T>

Type Parameters:

T - type of record it produces

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.serialization.DeserializationSchema<T>, org.apache.flink.api.java.typeutils.ResultTypeQueryable<T>

public class ConfluentRegistryAvroDeserializationSchema<T>
extends org.apache.flink.formats.avro.RegistryAvroDeserializationSchema<T>

Deserialization schema that deserializes from Avro binary format using SchemaCoder that uses Confluent Schema Registry.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.api.common.serialization.DeserializationSchema

org.apache.flink.api.common.serialization.DeserializationSchema.InitializationContext

Method Summary

Modifier and Type	Method and Description
static ConfluentRegistryAvroDeserializationSchema<org.apache.avro.generic.GenericRecord>	forGeneric(org.apache.avro.Schema schema, String url) Creates ConfluentRegistryAvroDeserializationSchema that produces GenericRecord using the provided reader schema and looks up the writer schema in the Confluent Schema Registry.
static ConfluentRegistryAvroDeserializationSchema<org.apache.avro.generic.GenericRecord>	forGeneric(org.apache.avro.Schema schema, String url, int identityMapCapacity) Creates ConfluentRegistryAvroDeserializationSchema that produces GenericRecord using the provided reader schema and looks up the writer schema in the Confluent Schema Registry.
static ConfluentRegistryAvroDeserializationSchema<org.apache.avro.generic.GenericRecord>	forGeneric(org.apache.avro.Schema schema, String url, int identityMapCapacity, Map<String,?> registryConfigs) Creates ConfluentRegistryAvroDeserializationSchema that produces GenericRecord using the provided reader schema and looks up the writer schema in the Confluent Schema Registry.
static ConfluentRegistryAvroDeserializationSchema<org.apache.avro.generic.GenericRecord>	forGeneric(org.apache.avro.Schema schema, String url, Map<String,?> registryConfigs) Creates ConfluentRegistryAvroDeserializationSchema that produces GenericRecord using the provided reader schema and looks up the writer schema in the Confluent Schema Registry.
static <T extends org.apache.avro.specific.SpecificRecord> ConfluentRegistryAvroDeserializationSchema<T>	forSpecific(Class<T> tClass, String url) Creates AvroDeserializationSchema that produces classes that were generated from Avro schema and looks up the writer schema in the Confluent Schema Registry.
static <T extends org.apache.avro.specific.SpecificRecord> ConfluentRegistryAvroDeserializationSchema<T>	forSpecific(Class<T> tClass, String url, int identityMapCapacity) Creates AvroDeserializationSchema that produces classes that were generated from Avro schema and looks up the writer schema in the Confluent Schema Registry.
static <T extends org.apache.avro.specific.SpecificRecord> ConfluentRegistryAvroDeserializationSchema<T>	forSpecific(Class<T> tClass, String url, int identityMapCapacity, Map<String,?> registryConfigs) Creates AvroDeserializationSchema that produces classes that were generated from Avro schema and looks up the writer schema in the Confluent Schema Registry.
static <T extends org.apache.avro.specific.SpecificRecord> ConfluentRegistryAvroDeserializationSchema<T>	forSpecific(Class<T> tClass, String url, Map<String,?> registryConfigs) Creates AvroDeserializationSchema that produces classes that were generated from Avro schema and looks up the writer schema in the Confluent Schema Registry.

Methods inherited from class org.apache.flink.formats.avro.RegistryAvroDeserializationSchema

deserialize, equals, hashCode

Methods inherited from class org.apache.flink.formats.avro.AvroDeserializationSchema

forGeneric, forGeneric, forSpecific, forSpecific, getProducedType, isEndOfStream

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.api.common.serialization.DeserializationSchema

deserialize, open

Method Detail

forGeneric

public static ConfluentRegistryAvroDeserializationSchema<org.apache.avro.generic.GenericRecord> forGeneric(org.apache.avro.Schema schema,
                                                                                                           String url)

Creates ConfluentRegistryAvroDeserializationSchema that produces GenericRecord using the provided reader schema and looks up the writer schema in the Confluent Schema Registry.

By default, this method supports up to 1000 cached schema versions.

Parameters:

schema - schema of produced records

url - url of schema registry to connect

Returns:

deserialized record in form of GenericRecord

forGeneric

public static ConfluentRegistryAvroDeserializationSchema<org.apache.avro.generic.GenericRecord> forGeneric(org.apache.avro.Schema schema,
                                                                                                           String url,
                                                                                                           int identityMapCapacity)

Creates ConfluentRegistryAvroDeserializationSchema that produces GenericRecord using the provided reader schema and looks up the writer schema in the Confluent Schema Registry.

Parameters:

schema - schema of produced records

url - url of schema registry to connect

identityMapCapacity - maximum number of cached schema versions

Returns:

deserialized record in form of GenericRecord

forGeneric

public static ConfluentRegistryAvroDeserializationSchema<org.apache.avro.generic.GenericRecord> forGeneric(org.apache.avro.Schema schema,
                                                                                                           String url,
                                                                                                           @Nullable
                                                                                                           Map<String,?> registryConfigs)

Creates ConfluentRegistryAvroDeserializationSchema that produces GenericRecord using the provided reader schema and looks up the writer schema in the Confluent Schema Registry.

By default, this method supports up to 1000 cached schema versions.

Parameters:

schema - schema of produced records

url - URL of schema registry to connect

registryConfigs - map with additional schema registry configs (for example SSL properties)

Returns:

deserialized record in form of GenericRecord

forGeneric

public static ConfluentRegistryAvroDeserializationSchema<org.apache.avro.generic.GenericRecord> forGeneric(org.apache.avro.Schema schema,
                                                                                                           String url,
                                                                                                           int identityMapCapacity,
                                                                                                           @Nullable
                                                                                                           Map<String,?> registryConfigs)

Creates ConfluentRegistryAvroDeserializationSchema that produces GenericRecord using the provided reader schema and looks up the writer schema in the Confluent Schema Registry.

Parameters:

schema - schema of produced records

url - URL of schema registry to connect

identityMapCapacity - maximum number of cached schema versions

registryConfigs - map with additional schema registry configs (for example SSL properties)

Returns:

deserialized record in form of GenericRecord

forSpecific

public static <T extends org.apache.avro.specific.SpecificRecord> ConfluentRegistryAvroDeserializationSchema<T> forSpecific(Class<T> tClass,
                                                                                                                            String url)

Creates AvroDeserializationSchema that produces classes that were generated from Avro schema and looks up the writer schema in the Confluent Schema Registry.

By default, this method supports up to 1000 cached schema versions.

Parameters:

tClass - class of record to be produced

url - url of schema registry to connect

Returns:

deserialized record

forSpecific

public static <T extends org.apache.avro.specific.SpecificRecord> ConfluentRegistryAvroDeserializationSchema<T> forSpecific(Class<T> tClass,
                                                                                                                            String url,
                                                                                                                            int identityMapCapacity)

Creates AvroDeserializationSchema that produces classes that were generated from Avro schema and looks up the writer schema in the Confluent Schema Registry.

Parameters:

tClass - class of record to be produced

url - url of schema registry to connect

identityMapCapacity - maximum number of cached schema versions

Returns:

deserialized record

forSpecific

public static <T extends org.apache.avro.specific.SpecificRecord> ConfluentRegistryAvroDeserializationSchema<T> forSpecific(Class<T> tClass,
                                                                                                                            String url,
                                                                                                                            @Nullable
                                                                                                                            Map<String,?> registryConfigs)

Creates AvroDeserializationSchema that produces classes that were generated from Avro schema and looks up the writer schema in the Confluent Schema Registry.

By default, this method supports up to 1000 cached schema versions.

Parameters:

tClass - class of record to be produced

url - URL of schema registry to connect

registryConfigs - map with additional schema registry configs (for example SSL properties)

Returns:

deserialized record

forSpecific

public static <T extends org.apache.avro.specific.SpecificRecord> ConfluentRegistryAvroDeserializationSchema<T> forSpecific(Class<T> tClass,
                                                                                                                            String url,
                                                                                                                            int identityMapCapacity,
                                                                                                                            @Nullable
                                                                                                                            Map<String,?> registryConfigs)

Creates AvroDeserializationSchema that produces classes that were generated from Avro schema and looks up the writer schema in the Confluent Schema Registry.

Parameters:

tClass - class of record to be produced

url - URL of schema registry to connect

identityMapCapacity - maximum number of cached schema versions

registryConfigs - map with additional schema registry configs (for example SSL properties)

Returns:

deserialized record