Documentation
¶
Index ¶
- Constants
- type Deserializer
- func (s *Deserializer) Deserialize(topic string, payload []byte) (interface{}, error)
- func (s *Deserializer) DeserializeInto(topic string, payload []byte, msg interface{}) error
- func (s *Deserializer) DeserializeWithHeaders(topic string, headers []kafka.Header, payload []byte) (interface{}, error)
- func (s *Deserializer) DeserializeWithHeadersInto(topic string, headers []kafka.Header, payload []byte, msg interface{}) error
- type DeserializerConfig
- type Serde
- type Serializer
- type SerializerConfig
Constants ¶
const (
// SchemaType is the JSON Schema type
SchemaType = "JSON"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Deserializer ¶
type Deserializer struct {
serde.BaseDeserializer
*Serde
}
Deserializer represents a JSON Schema deserializer
func NewDeserializer ¶
func NewDeserializer(client schemaregistry.Client, serdeType serde.Type, conf *DeserializerConfig) (*Deserializer, error)
NewDeserializer creates a JSON deserializer for generic objects
func (*Deserializer) Deserialize ¶
func (s *Deserializer) Deserialize(topic string, payload []byte) (interface{}, error)
Deserialize implements deserialization of generic data from JSON
func (*Deserializer) DeserializeInto ¶
func (s *Deserializer) DeserializeInto(topic string, payload []byte, msg interface{}) error
DeserializeInto implements deserialization of generic data from JSON to the given object
func (*Deserializer) DeserializeWithHeaders ¶ added in v2.10.1
func (s *Deserializer) DeserializeWithHeaders(topic string, headers []kafka.Header, payload []byte) (interface{}, error)
DeserializeWithHeaders implements deserialization of generic data from JSON
func (*Deserializer) DeserializeWithHeadersInto ¶ added in v2.10.1
func (s *Deserializer) DeserializeWithHeadersInto(topic string, headers []kafka.Header, payload []byte, msg interface{}) error
DeserializeWithHeadersInto implements deserialization of generic data from JSON to the given object
type DeserializerConfig ¶
type DeserializerConfig struct {
serde.DeserializerConfig
EnableValidation bool
}
DeserializerConfig is used to pass multiple configuration options to the deserializers.
func NewDeserializerConfig ¶
func NewDeserializerConfig() *DeserializerConfig
NewDeserializerConfig returns a new configuration instance with sane defaults.
type Serde ¶ added in v2.5.0
type Serde struct {
// contains filtered or unexported fields
}
Serde represents a JSON Schema serde
func (*Serde) FieldTransform ¶ added in v2.5.0
func (s *Serde) FieldTransform(client schemaregistry.Client, ctx serde.RuleContext, fieldTransform serde.FieldTransform, msg interface{}) (interface{}, error)
FieldTransform transforms the field value using the rule
type Serializer ¶
type Serializer struct {
serde.BaseSerializer
*Serde
}
Serializer represents a JSON Schema serializer
func NewSerializer ¶
func NewSerializer(client schemaregistry.Client, serdeType serde.Type, conf *SerializerConfig) (*Serializer, error)
NewSerializer creates a JSON serializer for generic objects
func (*Serializer) Serialize ¶
func (s *Serializer) Serialize(topic string, msg interface{}) ([]byte, error)
Serialize implements serialization of generic data to JSON
func (*Serializer) SerializeWithHeaders ¶ added in v2.10.1
func (s *Serializer) SerializeWithHeaders(topic string, msg interface{}) ([]kafka.Header, []byte, error)
SerializeWithHeaders implements serialization of generic data to JSON
type SerializerConfig ¶
type SerializerConfig struct {
serde.SerializerConfig
// EnableValidation enables validation of the JSON against the schema.
EnableValidation bool
}
SerializerConfig is used to pass multiple configuration options to the serializers.
func NewSerializerConfig ¶
func NewSerializerConfig() *SerializerConfig
NewSerializerConfig returns a new configuration instance with sane defaults.