org.apache.pulsar.client.impl.schema

Class KeyValueSchema<K,V>

java.lang.Object

org.apache.pulsar.client.impl.schema.KeyValueSchema<K,V>

All Implemented Interfaces:

Schema<KeyValue<K,V>>

public class KeyValueSchema<K,V>
extends Object
implements Schema<KeyValue<K,V>>

[Key, Value] pair schema definition

Field Summary

Fields

Modifier and Type	Field and Description
protected SchemaInfoProvider	schemaInfoProvider

Fields inherited from interface org.apache.pulsar.client.api.Schema

BOOL, BYTEBUFFER, BYTES, DATE, DOUBLE, FLOAT, INT16, INT32, INT64, INT8, STRING, TIME, TIMESTAMP

Method Summary

Modifier and Type	Method and Description
void	configureSchemaInfo(String topicName, String componentName, SchemaInfo schemaInfo)
KeyValue<K,V>	decode(byte[] bytes)
KeyValue<K,V>	decode(byte[] bytes, byte[] schemaVersion)
KeyValue<K,V>	decode(byte[] keyBytes, byte[] valueBytes, byte[] schemaVersion)
byte[]	encode(KeyValue<K,V> message)
SchemaInfo	getSchemaInfo()
static Schema<KeyValue<byte[],byte[]>>	kvBytes()
static <K,V> Schema<KeyValue<K,V>>	of(Class<K> key, Class<V> value, SchemaType type) Key Value Schema using passed in schema type, support JSON and AVRO currently.
static <K,V> Schema<KeyValue<K,V>>	of(Schema<K> keySchema, Schema<V> valueSchema)
static <K,V> Schema<KeyValue<K,V>>	of(Schema<K> keySchema, Schema<V> valueSchema, KeyValueEncodingType keyValueEncodingType)
boolean	requireFetchingSchemaInfo()
void	setSchemaInfoProvider(SchemaInfoProvider schemaInfoProvider)
boolean	supportSchemaVersioning()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pulsar.client.api.Schema

AUTO_CONSUME, AUTO_PRODUCE_BYTES, AUTO_PRODUCE_BYTES, AUTO, AVRO, AVRO, generic, getSchema, JSON, JSON, KeyValue, KeyValue, KeyValue, KeyValue, KV_BYTES, PROTOBUF, PROTOBUF, validate

Field Detail

schemaInfoProvider

protected SchemaInfoProvider schemaInfoProvider

Method Detail

of

public static <K,V> Schema<KeyValue<K,V>> of(Class<K> key,
                                             Class<V> value,
                                             SchemaType type)

Key Value Schema using passed in schema type, support JSON and AVRO currently.

of

public static <K,V> Schema<KeyValue<K,V>> of(Schema<K> keySchema,
                                             Schema<V> valueSchema)

of

public static <K,V> Schema<KeyValue<K,V>> of(Schema<K> keySchema,
                                             Schema<V> valueSchema,
                                             KeyValueEncodingType keyValueEncodingType)

kvBytes

public static Schema<KeyValue<byte[],byte[]>> kvBytes()

supportSchemaVersioning

public boolean supportSchemaVersioning()

Specified by:

supportSchemaVersioning in interface Schema<KeyValue<K,V>>

encode

public byte[] encode(KeyValue<K,V> message)

Specified by:

encode in interface Schema<KeyValue<K,V>>

decode

public KeyValue<K,V> decode(byte[] bytes)

Specified by:

decode in interface Schema<KeyValue<K,V>>

decode

public KeyValue<K,V> decode(byte[] bytes,
                            byte[] schemaVersion)

Specified by:

decode in interface Schema<KeyValue<K,V>>

decode

public KeyValue<K,V> decode(byte[] keyBytes,
                            byte[] valueBytes,
                            byte[] schemaVersion)

getSchemaInfo

public SchemaInfo getSchemaInfo()

Specified by:

getSchemaInfo in interface Schema<KeyValue<K,V>>

setSchemaInfoProvider

public void setSchemaInfoProvider(SchemaInfoProvider schemaInfoProvider)

Specified by:

setSchemaInfoProvider in interface Schema<KeyValue<K,V>>

requireFetchingSchemaInfo

public boolean requireFetchingSchemaInfo()

Specified by:

requireFetchingSchemaInfo in interface Schema<KeyValue<K,V>>

configureSchemaInfo

public void configureSchemaInfo(String topicName,
                                String componentName,
                                SchemaInfo schemaInfo)

Specified by:

configureSchemaInfo in interface Schema<KeyValue<K,V>>