Class AvroSerializerConfig
AvroSerializer<T> configuration properties.
Inherited Members
Namespace: Confluent.SchemaRegistry.Serdes
Assembly: Confluent.SchemaRegistry.Serdes.Avro.dll
Syntax
public class AvroSerializerConfig : SerdeConfig, IEnumerable<KeyValuePair<string, string>>, IEnumerableConstructors
AvroSerializerConfig()
Initialize a new AvroSerializerConfig.
Declaration
public AvroSerializerConfig()AvroSerializerConfig(IEnumerable<KeyValuePair<string, string>>)
Initialize a new AvroSerializerConfig from the provided key/value pair collection.
Declaration
public AvroSerializerConfig(IEnumerable<KeyValuePair<string, string>> config)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<KeyValuePair<string, string>> | config |
Properties
AutoRegisterSchemas
Specifies whether or not the Avro serializer should attempt to auto-register unrecognized schemas with Confluent Schema Registry.
default: true
Declaration
public bool? AutoRegisterSchemas { get; set; }Property Value
| Type | Description |
|---|---|
| bool? |
BufferBytes
Specifies the initial size (in bytes) of the buffer used for Avro message serialization. Use a value high enough to avoid resizing the buffer, but small enough to avoid excessive memory use. Inspect the size of the byte array returned by the Serialize method to estimate an appropriate value. Note: each call to serialize creates a new buffer.
default: 1024
Declaration
public int? BufferBytes { get; set; }Property Value
| Type | Description |
|---|---|
| int? |
NormalizeSchemas
Specifies whether to normalize schemas, which will transform schemas to have a consistent format, including ordering properties and references.
default: false
Declaration
public bool? NormalizeSchemas { get; set; }Property Value
| Type | Description |
|---|---|
| bool? |
SchemaIdStrategy
Schema id strategy.
default: SchemaIdSerializerStrategy.Prefix
Declaration
public SchemaIdSerializerStrategy? SchemaIdStrategy { get; set; }Property Value
| Type | Description |
|---|---|
| SchemaIdSerializerStrategy? |
SubjectNameStrategy
Subject name strategy.
default: SubjectNameStrategy.Topic
Declaration
public SubjectNameStrategy? SubjectNameStrategy { get; set; }Property Value
| Type | Description |
|---|---|
| SubjectNameStrategy? |
UseLatestVersion
Specifies whether or not the Avro serializer should use the latest subject version for serialization. WARNING: There is no check that the latest schema is backwards compatible with the schema of the object being serialized.
default: false
Declaration
public bool? UseLatestVersion { get; set; }Property Value
| Type | Description |
|---|---|
| bool? |
UseLatestWithMetadata
Specifies whether or not the Avro serializer should use the latest subject version with the given metadata for serialization. WARNING: There is no check that the latest schema is backwards compatible with the schema of the object being serialized.
Declaration
public IDictionary<string, string> UseLatestWithMetadata { get; set; }Property Value
| Type | Description |
|---|---|
| IDictionary<string, string> |
UseSchemaId
Specifies the schema ID to be used for serialization. WARNING: There is no check that the latest schema is backwards compatible with the schema of the object being serialized.
Declaration
public int? UseSchemaId { get; set; }Property Value
| Type | Description |
|---|---|
| int? |