Class JsonSerializerConfig

JsonSerializer<T> configuration properties.

Inheritance

object

Config

SerdeConfig

JsonSerializerConfig

Implements

IEnumerable<KeyValuePair<string, string>>

IEnumerable

Inherited Members

SerdeConfig.GetDictionaryProperty(string)

SerdeConfig.SetDictionaryProperty(string, IDictionary<string, string>)

Config.Set(string, string)

Config.Get(string)

Config.GetInt(string)

Config.GetBool(string)

Config.GetDouble(string)

Config.GetEnum(Type, string)

Config.SetObject(string, object)

Config.properties

Config.GetEnumerator()

Config.CancellationDelayMaxMs

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Confluent.SchemaRegistry.Serdes

Assembly: Confluent.SchemaRegistry.Serdes.Json.dll

Syntax

public class JsonSerializerConfig : SerdeConfig, IEnumerable<KeyValuePair<string, string>>, IEnumerable

Constructors

JsonSerializerConfig()

Initialize a new JsonSerializerConfig.

Declaration

public JsonSerializerConfig()

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

Initialize a new JsonSerializerConfig from the provided key/value pair collection.

Declaration

public JsonSerializerConfig(IEnumerable<KeyValuePair<string, string>> config)

Parameters

Type	Name	Description
IEnumerable<KeyValuePair<string, string>>	config

Properties

AutoRegisterSchemas

Specifies whether or not the JSON 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 JSON 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?

LatestCompatibilityStrict

Specifies whether or not the JSON serializer should check the backwards compatibility with the latest schema of the subject.

default: false

Declaration

public bool? LatestCompatibilityStrict { get; set; }

Property Value

Type	Description
bool?

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?

SubjectNameStrategy

Subject name strategy.

default: SubjectNameStrategy.Topic

Declaration

public SubjectNameStrategy? SubjectNameStrategy { get; set; }

Property Value

Type	Description
SubjectNameStrategy?

UseLatestVersion

Specifies whether or not the JSON serializer should use the latest subject version for serialization. WARNING: There is no check that the latest schema is compatible with the schema of the object being serialized by default. Use the LatestCompatibilityStrict config property to enable this.

default: false

Declaration

public bool? UseLatestVersion { get; set; }

Property Value

Type	Description
bool?

UseLatestWithMetadata

Specifies whether or not the JSON serializer should use the latest schema 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?

Validate

Specifies whether or not the JSON serializer should attempt to validate the payload against the schema.

default: true

Declaration

public bool? Validate { get; set; }

Property Value

Type	Description
bool?

Implements

IEnumerable<T>

IEnumerable