Table of Contents

Class AvroSharpSerializerConfig

Namespace
AvroSharp.Confluent
Assembly
AvroSharp.Confluent.dll

Settings of AvroSharpSerializer<T> and the serializers of AvroSharpGeneric, with the keys of Confluent's AvroSerializerConfig (avro.serializer.*), so existing configuration carries over.

public sealed class AvroSharpSerializerConfig : SerdeConfig, IEnumerable<KeyValuePair<string, string>>, IEnumerable
Inheritance
Config
SerdeConfig
AvroSharpSerializerConfig
Implements
Inherited Members
Config.GetEnumerator()
Config.CancellationDelayMaxMs

Constructors

AvroSharpSerializerConfig()

Creates empty settings: every value is the serializer's default.

AvroSharpSerializerConfig(IEnumerable<KeyValuePair<string, string>>)

Creates settings from key-value pairs, copied, as Confluent's config classes do: a dictionary, or a configuration section's pairs (see the guide). Pairs without a value are left out.

Properties

AutoRegisterSchemas

Gets or sets whether the serializer registers the schema when the subject lacks it (avro.serializer.auto.register.schemas). The default is true.

BufferBytes

Gets or sets the initial size of the buffer a message is written into (avro.serializer.buffer.bytes).

IdCompatibilityStrict

Gets or sets whether a type is written with the schema of use.schema.id only when that schema can read the type's (avro.serializer.id.compatibility.strict, Java's id.compatibility.strict). The default is true. Off, the value is written whenever the schemas resolve.

LatestCompatibilityStrict

Gets or sets whether a type is written with the subject's latest schema (use.latest.version, use.latest.with.metadata) only when that schema can read the type's (avro.serializer.latest.compatibility.strict, Java's latest.compatibility.strict). The default is true. Off, the value is written whenever the schemas resolve.

NormalizeSchemas

Gets or sets whether the registry normalizes schemas when they are registered or looked up (avro.serializer.normalize.schemas).

RemoveJavaProperties

Gets or sets whether the property avro.java.string is removed from the schema before it is registered or looked up (avro.serializer.remove.java.properties), as Java's avro.remove.java.properties does, so the same .avsc registers as one version from Java and .NET. The default is false.

SchemaIdStrategy

Gets or sets where the schema ID goes: the message prefix (the default) or a header (avro.serializer.schema.id.strategy).

SubjectNameStrategy

Gets or sets how the subject is named (avro.serializer.subject.name.strategy). The default is Confluent.SchemaRegistry.SubjectNameStrategy.Associated, as in Confluent's serde: the topic's association in the registry, or Confluent.SchemaRegistry.SubjectNameStrategy.Topic when it has none.

TombstoneBehavior

Gets or sets how tombstones are treated (avro.serializer.tombstone.behavior, AvroSharp's own key). The default is None, Confluent's behavior.

UseLatestVersion

Gets or sets whether the serializer writes with the subject's latest schema (avro.serializer.use.latest.version).

UseLatestWithMetadata

Gets or sets the metadata that selects the subject's latest schema to write with (avro.serializer.use.latest.with.metadata).

UseSchemaGuid

Gets or sets the GUID of the registered schema to write with (avro.serializer.use.schema.guid, Java's use.schema.guid): the GUID form of UseSchemaId. The schema must be registered under the subject, whose version of it the message carries.

UseSchemaId

Gets or sets the ID of the registered schema to write with, instead of looking it up (avro.serializer.use.schema.id).