Class JsonSerializerConfig.PropertyNames

Configuration property names specific to JsonSerializer<T>.

Inheritance

object

JsonSerializerConfig.PropertyNames

Inherited Members

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 static class JsonSerializerConfig.PropertyNames

Fields

AutoRegisterSchemas

Specifies whether or not the JSON serializer should attempt to auto-register unrecognized schemas with Confluent Schema Registry.

default: true

Declaration

public const string AutoRegisterSchemas = "json.serializer.auto.register.schemas"

Field Value

Type	Description
string

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 const string BufferBytes = "json.serializer.buffer.bytes"

Field Value

Type	Description
string

LatestCompatibilityStrict

Specifies whether or not the JSON serializer should check the compatibility with the latest schema of the subject if use.latest.version is set to true.

default: false

Declaration

public const string LatestCompatibilityStrict = "json.serializer.latest.compatibility.strict"

Field Value

Type	Description
string

NormalizeSchemas

Specifies whether to normalize schemas, which will transform schemas to have a consistent format, including ordering properties and references.

default: false

Declaration

public const string NormalizeSchemas = "json.serializer.normalize.schemas"

Field Value

Type	Description
string

SchemaIdStrategy

The schema id name strategy to use to serialize the ID/GUID. Possible values: SchemaIdSerializerStrategy

Declaration

public const string SchemaIdStrategy = "json.serializer.schema.id.strategy"

Field Value

Type	Description
string

SubjectNameStrategy

The subject name strategy to use for schema registration / lookup. Possible values: SubjectNameStrategy

Declaration

public const string SubjectNameStrategy = "json.serializer.subject.name.strategy"

Field Value

Type	Description
string

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 const string UseLatestVersion = "json.serializer.use.latest.version"

Field Value

Type	Description
string

UseLatestWithMetadata

Declaration

public const string UseLatestWithMetadata = "json.serializer.use.latest.with.metadata"

Field Value

Type	Description
string

UseSchemaId

Specifies the schema ID to use for serialization. WARNING: There is no check that the given schema is backwards compatible with the schema of the object being serialized.

Declaration

public const string UseSchemaId = "json.serializer.use.schema.id"

Field Value

Type	Description
string

Validate

Specifies whether to validate payloads against the schema.

default: true

Declaration

public const string Validate = "json.serializer.validate"

Field Value

Type	Description
string