Schema (Pulsar Client :: API 2.4.0 API)

所有已知子接口:

GenericSchema<T>
```
public interface Schema<T>
```
Message schema definition

字段概要

字段
限定符和类型	字段和说明
`static Schema<Boolean>`	`BOOL` Boolean Schema
`static Schema<ByteBuffer>`	`BYTEBUFFER` ByteBuffer Schema.
`static Schema<byte[]>`	`BYTES` Schema that doesn't perform any encoding on the message payloads.
`static Schema<Date>`	`DATE` Date Schema
`static Schema<Double>`	`DOUBLE` Double Schema
`static Schema<Float>`	`FLOAT` Float Schema
`static Schema<Short>`	`INT16` INT16 Schema
`static Schema<Integer>`	`INT32` INT32 Schema
`static Schema<Long>`	`INT64` INT64 Schema
`static Schema<Byte>`	`INT8` INT8 Schema
`static Schema<String>`	`STRING` Schema that can be used to encode/decode messages whose values are String.
`static Schema<Time>`	`TIME` Time Schema
`static Schema<Timestamp>`	`TIMESTAMP` Timestamp Schema

方法概要

所有方法静态方法实例方法抽象方法默认方法已过时的方法
限定符和类型	方法和说明
`static Schema<GenericRecord>`	`AUTO_CONSUME()` Create a schema instance that automatically deserialize messages based on the current topic schema.
`static Schema<byte[]>`	`AUTO_PRODUCE_BYTES()` Create a schema instance that accepts a serialized payload and validates it against the topic schema.
`static Schema<GenericRecord>`	`AUTO()` 已过时。
`static <T> Schema<T>`	`AVRO(Class<T> pojo)` Create a Avro schema type by default configuration of the class
`static <T> Schema<T>`	`AVRO(SchemaDefinition<T> schemaDefinition)` Create a Avro schema type with schema definition
`default T`	`decode(byte[] bytes)` Decode a byte array into an object using the schema definition and deserializer implementation
`default T`	`decode(byte[] bytes, byte[] schemaVersion)` Decode a byte array into an object using a given version.
`byte[]`	`encode(T message)` Encode an object representing the message content into a byte array.
`static GenericSchema<GenericRecord>`	`generic(SchemaInfo schemaInfo)` Returns a generic schema of existing schema info.
`static Schema<?>`	`getSchema(SchemaInfo schemaInfo)`
`SchemaInfo`	`getSchemaInfo()`
`static <T> Schema<T>`	`JSON(Class<T> pojo)` Create a JSON schema type by extracting the fields of the specified class.
`static <T> Schema<T>`	`JSON(SchemaDefinition schemaDefinition)` Create a JSON schema type with schema definition
`static <K,V> Schema<KeyValue<K,V>>`	`KeyValue(Class<K> key, Class<V> value)` Key Value Schema whose underneath key and value schemas are JSONSchema.
`static <K,V> Schema<KeyValue<K,V>>`	`KeyValue(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>>`	`KeyValue(Schema<K> key, Schema<V> value)` Key Value Schema using passed in key and value schemas.
`static <K,V> Schema<KeyValue<K,V>>`	`KeyValue(Schema<K> key, Schema<V> value, KeyValueEncodingType keyValueEncodingType)` Key Value Schema using passed in key, value and encoding type schemas.
`static Schema<KeyValue<byte[],byte[]>>`	`KV_BYTES()` Schema that can be used to encode/decode KeyValue.
`static <T extends com.google.protobuf.GeneratedMessageV3> Schema<T>`	`PROTOBUF(Class<T> clazz)` Create a Protobuf schema type by extracting the fields of the specified class.
`static <T extends com.google.protobuf.GeneratedMessageV3> Schema<T>`	`PROTOBUF(SchemaDefinition<T> schemaDefinition)` Create a Protobuf schema type with schema definition.
`default void`	`setSchemaInfoProvider(SchemaInfoProvider schemaInfoProvider)`
`default boolean`	`supportSchemaVersioning()` Returns whether this schema supports versioning.
`default void`	`validate(byte[] message)` Check if the message is a valid object for this schema.

- 字段详细资料
  - BYTES
```
static final Schema<byte[]> BYTES
```
    Schema that doesn't perform any encoding on the message payloads. Accepts a byte array and it passes it through.
  - BYTEBUFFER
```
static final Schema<ByteBuffer> BYTEBUFFER
```
    ByteBuffer Schema.
  - STRING
```
static final Schema<String> STRING
```
    Schema that can be used to encode/decode messages whose values are String. The payload is encoded with UTF-8.
  - INT8
```
static final Schema<Byte> INT8
```
    INT8 Schema
  - INT16
```
static final Schema<Short> INT16
```
    INT16 Schema
  - INT32
```
static final Schema<Integer> INT32
```
    INT32 Schema
  - INT64
```
static final Schema<Long> INT64
```
    INT64 Schema
  - BOOL
```
static final Schema<Boolean> BOOL
```
    Boolean Schema
  - FLOAT
```
static final Schema<Float> FLOAT
```
    Float Schema
  - DOUBLE
```
static final Schema<Double> DOUBLE
```
    Double Schema
  - DATE
```
static final Schema<Date> DATE
```
    Date Schema
  - TIME
```
static final Schema<Time> TIME
```
    Time Schema
  - TIMESTAMP
```
static final Schema<Timestamp> TIMESTAMP
```
    Timestamp Schema
- 方法详细资料
  - validate
```
default void validate(byte[] message)
```
    Check if the message is a valid object for this schema.
    The implementation can choose what its most efficient approach to validate the schema. If the implementation doesn't provide it, it will attempt to use decode(byte[]) to see if this schema can decode this message or not as a validation mechanism to verify the bytes.
    
    参数:
    
    message - the messages to verify
    
    抛出:
    
    SchemaSerializationException - if it is not a valid message
  - encode
```
byte[] encode(T message)
```
    Encode an object representing the message content into a byte array.
    
    参数:
    
    message - the message object
    
    返回:
    
    a byte array with the serialized content
    
    抛出:
    
    SchemaSerializationException - if the serialization fails
  - supportSchemaVersioning
```
default boolean supportSchemaVersioning()
```
    Returns whether this schema supports versioning.
    Most of the schema implementations don't really support schema versioning, or it just doesn't make any sense to support schema versionings (e.g. primitive schemas). Only schema returns GenericRecord should support schema versioning.
    If a schema implementation returns false, it should implement decode(byte[]); while a schema implementation returns true, it should implement decode(byte[], byte[]) instead.
    
    返回:
    
    true if this schema implementation supports schema versioning; otherwise returns false.
  - setSchemaInfoProvider
```
default void setSchemaInfoProvider(SchemaInfoProvider schemaInfoProvider)
```
  - decode
```
default T decode(byte[] bytes)
```
    Decode a byte array into an object using the schema definition and deserializer implementation
    
    参数:
    
    bytes - the byte array to decode
    
    返回:
    
    the deserialized object
  - decode
```
default T decode(byte[] bytes,
                 byte[] schemaVersion)
```
    Decode a byte array into an object using a given version.
    
    参数:
    
    bytes - the byte array to decode
    
    schemaVersion - the schema version to decode the object. null indicates using latest version.
    
    返回:
    
    the deserialized object
  - getSchemaInfo
```
SchemaInfo getSchemaInfo()
```
    返回:
    
    an object that represents the Schema associated metadata
  - PROTOBUF
```
static <T extends com.google.protobuf.GeneratedMessageV3> Schema<T> PROTOBUF(Class<T> clazz)
```
    Create a Protobuf schema type by extracting the fields of the specified class.
    
    参数:
    
    clazz - the Protobuf generated class to be used to extract the schema
    
    返回:
    
    a Schema instance
  - PROTOBUF
```
static <T extends com.google.protobuf.GeneratedMessageV3> Schema<T> PROTOBUF(SchemaDefinition<T> schemaDefinition)
```
    Create a Protobuf schema type with schema definition.
    
    参数:
    
    schemaDefinition - schemaDefinition the definition of the schema
    
    返回:
    
    a Schema instance
  - AVRO
```
static <T> Schema<T> AVRO(Class<T> pojo)
```
    Create a Avro schema type by default configuration of the class
    
    参数:
    
    pojo - the POJO class to be used to extract the Avro schema
    
    返回:
    
    a Schema instance
  - AVRO
```
static <T> Schema<T> AVRO(SchemaDefinition<T> schemaDefinition)
```
    Create a Avro schema type with schema definition
    
    参数:
    
    schemaDefinition - the definition of the schema
    
    返回:
    
    a Schema instance
  - JSON
```
static <T> Schema<T> JSON(Class<T> pojo)
```
    Create a JSON schema type by extracting the fields of the specified class.
    
    参数:
    
    pojo - the POJO class to be used to extract the JSON schema
    
    返回:
    
    a Schema instance
  - JSON
```
static <T> Schema<T> JSON(SchemaDefinition schemaDefinition)
```
    Create a JSON schema type with schema definition
    
    参数:
    
    schemaDefinition - the definition of the schema
    
    返回:
    
    a Schema instance
  - KeyValue
```
static <K,V> Schema<KeyValue<K,V>> KeyValue(Class<K> key,
                                            Class<V> value,
                                            SchemaType type)
```
    Key Value Schema using passed in schema type, support JSON and AVRO currently.
  - KV_BYTES
```
static Schema<KeyValue<byte[],byte[]>> KV_BYTES()
```
    Schema that can be used to encode/decode KeyValue.
  - KeyValue
```
static <K,V> Schema<KeyValue<K,V>> KeyValue(Class<K> key,
                                            Class<V> value)
```
    Key Value Schema whose underneath key and value schemas are JSONSchema.
  - KeyValue
```
static <K,V> Schema<KeyValue<K,V>> KeyValue(Schema<K> key,
                                            Schema<V> value)
```
    Key Value Schema using passed in key and value schemas.
  - KeyValue
```
static <K,V> Schema<KeyValue<K,V>> KeyValue(Schema<K> key,
                                            Schema<V> value,
                                            KeyValueEncodingType keyValueEncodingType)
```
    Key Value Schema using passed in key, value and encoding type schemas.
  - AUTO
```
@Deprecated
static Schema<GenericRecord> AUTO()
```
    已过时。
  - AUTO_CONSUME
```
static Schema<GenericRecord> AUTO_CONSUME()
```
    Create a schema instance that automatically deserialize messages based on the current topic schema.
    The messages values are deserialized into a GenericRecord object.
    Currently this is only supported with Avro and JSON schema types.
    
    返回:
    
    the auto schema instance
  - AUTO_PRODUCE_BYTES
```
static Schema<byte[]> AUTO_PRODUCE_BYTES()
```
    Create a schema instance that accepts a serialized payload and validates it against the topic schema.
    Currently this is only supported with Avro and JSON schema types.
    This method can be used when publishing a raw JSON payload, for which the format is known and a POJO class is not avaialable.
    
    返回:
    
    the auto schema instance
  - getSchema
```
static Schema<?> getSchema(SchemaInfo schemaInfo)
```
  - generic
```
static GenericSchema<GenericRecord> generic(SchemaInfo schemaInfo)
```
    Returns a generic schema of existing schema info.
    Only supports AVRO and JSON.
    
    参数:
    
    schemaInfo - schema info
    
    返回:
    
    a generic schema instance

接口 Schema<T>

字段概要

方法概要

字段详细资料

BYTES

BYTEBUFFER

STRING

INT8

INT16

INT32

INT64

BOOL

FLOAT

DOUBLE

DATE

TIME

TIMESTAMP

方法详细资料

validate

encode

supportSchemaVersioning

setSchemaInfoProvider

decode

decode

getSchemaInfo

PROTOBUF

PROTOBUF

AVRO

AVRO

JSON

JSON

KeyValue

KV_BYTES

KeyValue

KeyValue

KeyValue

AUTO

AUTO_CONSUME

AUTO_PRODUCE_BYTES

getSchema

generic