程序包 org.apache.pulsar.client.impl.schema

类 KeyValueSchemaImpl<K,V>

java.lang.Object

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

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

所有已实现的接口:

Cloneable, Schema<KeyValue<K,V>>, KeyValueSchema<K,V>

public class KeyValueSchemaImpl<K,V>
extends AbstractSchema<KeyValue<K,V>>
implements KeyValueSchema<K,V>

[Key, Value] pair schema definition.

字段概要

字段

修饰符和类型	字段	说明
protected SchemaInfoProvider	schemaInfoProvider

从接口继承的字段 org.apache.pulsar.client.api.Schema

BOOL, BYTEBUFFER, BYTES, DATE, DOUBLE, FLOAT, INSTANT, INT16, INT32, INT64, INT8, LOCAL_DATE, LOCAL_DATE_TIME, LOCAL_TIME, STRING, TIME, TIMESTAMP

方法概要

修饰符和类型	方法	说明
Schema<?>	atSchemaVersion(byte[] schemaVersion)	Return an instance of this schema at the given version.
Schema<KeyValue<K,V>>	clone()
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)
KeyValue<K,V>	decode(io.netty.buffer.ByteBuf byteBuf)	Decode a byteBuf into an object using the schema definition and deserializer implementation
KeyValue<K,V>	decode(io.netty.buffer.ByteBuf byteBuf, byte[] schemaVersion)	Decode a byteBuf into an object using a given version.
byte[]	encode(KeyValue<K,V> message)
void	fetchSchemaIfNeeded(String topicName, SchemaVersion schemaVersion)	It may happen that the schema is not loaded but we need it, for instance in order to call getSchemaInfo() We cannot call this method in getSchemaInfo.
Schema<K>	getKeySchema()	Get the Schema of the Key.
KeyValueEncodingType	getKeyValueEncodingType()	Get the KeyValueEncodingType.
SchemaInfo	getSchemaInfo()
Schema<V>	getValueSchema()	Get the Schema of the Value.
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()
String	toString()

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.apache.pulsar.client.api.Schema

decode, decode, getNativeSchema, validate

字段详细资料

schemaInfoProvider

protected SchemaInfoProvider schemaInfoProvider

方法详细资料

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()

指定者:

supportSchemaVersioning 在接口中 Schema<K>

encode

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

指定者:

encode 在接口中 Schema<K>

decode

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

指定者:

decode 在接口中 Schema<K>

decode

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

指定者:

decode 在接口中 Schema<K>

decode

public KeyValue<K,V> decode(io.netty.buffer.ByteBuf byteBuf)

从类复制的说明: AbstractSchema

Decode a byteBuf into an object using the schema definition and deserializer implementation

Do not modify reader/writer index of ByteBuf so, it can be reused to access correct data.

指定者:

decode 在类中 AbstractSchema<KeyValue<K,V>>

参数:

byteBuf - the byte buffer to decode

返回:

the deserialized object

decode

public KeyValue<K,V> decode(io.netty.buffer.ByteBuf byteBuf,
 byte[] schemaVersion)

从类复制的说明: AbstractSchema

Decode a byteBuf into an object using a given version.

覆盖:

decode 在类中 AbstractSchema<KeyValue<K,V>>

参数:

byteBuf - the byte array to decode

schemaVersion - the schema version to decode the object. null indicates using latest version.

返回:

the deserialized object

decode

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

getSchemaInfo

public SchemaInfo getSchemaInfo()

指定者:

getSchemaInfo 在接口中 Schema<K>

setSchemaInfoProvider

public void setSchemaInfoProvider(SchemaInfoProvider schemaInfoProvider)

指定者:

setSchemaInfoProvider 在接口中 Schema<K>

requireFetchingSchemaInfo

public boolean requireFetchingSchemaInfo()

指定者:

requireFetchingSchemaInfo 在接口中 Schema<K>

configureSchemaInfo

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

指定者:

configureSchemaInfo 在接口中 Schema<K>

clone

public Schema<KeyValue<K,V>> clone()

指定者:

clone 在接口中 Schema<K>

覆盖:

clone 在类中 AbstractSchema<KeyValue<K,V>>

toString

public String toString()

覆盖:

toString 在类中 Object

atSchemaVersion

public Schema<?> atSchemaVersion(byte[] schemaVersion)
                          throws SchemaSerializationException

从类复制的说明: AbstractSchema

Return an instance of this schema at the given version.

覆盖:

atSchemaVersion 在类中 AbstractSchema<KeyValue<K,V>>

参数:

schemaVersion - the version

返回:

the schema at that specific version

抛出:

SchemaSerializationException - in case of unknown schema version

getKeySchema

public Schema<K> getKeySchema()

Get the Schema of the Key.

指定者:

getKeySchema 在接口中 KeyValueSchema<K,V>

返回:

the Schema of the Key

getValueSchema

public Schema<V> getValueSchema()

Get the Schema of the Value.

指定者:

getValueSchema 在接口中 KeyValueSchema<K,V>

返回:

the Schema of the Value

getKeyValueEncodingType

public KeyValueEncodingType getKeyValueEncodingType()

Get the KeyValueEncodingType.

指定者:

getKeyValueEncodingType 在接口中 KeyValueSchema<K,V>

返回:

the KeyValueEncodingType

另请参阅:

• KeyValueEncodingType.INLINE
• KeyValueEncodingType.SEPARATED

fetchSchemaIfNeeded

public void fetchSchemaIfNeeded(String topicName,
 SchemaVersion schemaVersion)
                         throws SchemaSerializationException

It may happen that the schema is not loaded but we need it, for instance in order to call getSchemaInfo() We cannot call this method in getSchemaInfo.

抛出:

SchemaSerializationException

另请参阅:

• AutoConsumeSchema.fetchSchemaIfNeeded(SchemaVersion)