Table of Contents

Class KafkaAvroSerializerConfigurationBuilder

Namespace
Silverback.Messaging.Configuration.Kafka.SchemaRegistry
Assembly
Silverback.Integration.Kafka.SchemaRegistry.dll
public class KafkaAvroSerializerConfigurationBuilder
Inheritance
KafkaAvroSerializerConfigurationBuilder
Inherited Members

Constructors

KafkaAvroSerializerConfigurationBuilder()

public KafkaAvroSerializerConfigurationBuilder()

Methods

Build()

Builds the KafkaAvroSerializerConfiguration instance.

public KafkaAvroSerializerConfiguration Build()

Returns

KafkaAvroSerializerConfiguration

The KafkaAvroSerializerConfiguration.

DisableLatestVersionUsage()

Disables the usage of the latest subject version for serialization.

public KafkaAvroSerializerConfigurationBuilder DisableLatestVersionUsage()

Returns

KafkaAvroSerializerConfigurationBuilder

The KafkaAvroSerializerConfigurationBuilder so that additional calls can be chained.

DisableSchemaAutoRegistration()

Disables the automatic registration of the unrecognized schemas with the schema registry.

public KafkaAvroSerializerConfigurationBuilder DisableSchemaAutoRegistration()

Returns

KafkaAvroSerializerConfigurationBuilder

The KafkaAvroSerializerConfigurationBuilder so that additional calls can be chained.

DisableSchemaNormalization()

Disables the schema normalization.

public KafkaAvroSerializerConfigurationBuilder DisableSchemaNormalization()

Returns

KafkaAvroSerializerConfigurationBuilder

The KafkaAvroSerializerConfigurationBuilder so that additional calls can be chained.

DisableValidationRulesFailFast()

Disables the fail fast mode for the validation rules, reporting all the violations.

public KafkaAvroSerializerConfigurationBuilder DisableValidationRulesFailFast()

Returns

KafkaAvroSerializerConfigurationBuilder

The KafkaAvroSerializerConfigurationBuilder so that additional calls can be chained.

EnableSchemaAutoRegistration()

Enables the automatic registration of the unrecognized schemas with the schema registry. The schemas are registered automatically by default.

public KafkaAvroSerializerConfigurationBuilder EnableSchemaAutoRegistration()

Returns

KafkaAvroSerializerConfigurationBuilder

The KafkaAvroSerializerConfigurationBuilder so that additional calls can be chained.

EnableSchemaNormalization()

Enables the schema normalization, transforming the schemas to have a consistent format, including ordering properties and references.

public KafkaAvroSerializerConfigurationBuilder EnableSchemaNormalization()

Returns

KafkaAvroSerializerConfigurationBuilder

The KafkaAvroSerializerConfigurationBuilder so that additional calls can be chained.

EnableValidationRulesFailFast()

Enables the fail fast mode for the validation rules, stopping at the first failed rule and reporting only that violation.

public KafkaAvroSerializerConfigurationBuilder EnableValidationRulesFailFast()

Returns

KafkaAvroSerializerConfigurationBuilder

The KafkaAvroSerializerConfigurationBuilder so that additional calls can be chained.

UseLatestVersion()

Specifies that the latest subject version must be used for serialization. Note that there is no check that the latest schema is backwards compatible with the schema of the object being serialized.

public KafkaAvroSerializerConfigurationBuilder UseLatestVersion()

Returns

KafkaAvroSerializerConfigurationBuilder

The KafkaAvroSerializerConfigurationBuilder so that additional calls can be chained.

WithBufferBytes(int?)

Sets the initial size (in bytes) of the buffer used for the message serialization. Use a value high enough to avoid resizing the buffer, but small enough to avoid excessive memory use. Each message is serialized into a new buffer. The default is 1024.

public KafkaAvroSerializerConfigurationBuilder WithBufferBytes(int? bufferBytes)

Parameters

bufferBytes int?

The initial size (in bytes) of the buffer.

Returns

KafkaAvroSerializerConfigurationBuilder

The KafkaAvroSerializerConfigurationBuilder so that additional calls can be chained.

WithSchemaIdStrategy(SchemaIdSerializerStrategy?)

Sets the schema ID strategy. The default is Confluent.SchemaRegistry.SchemaIdSerializerStrategy.Prefix.

public KafkaAvroSerializerConfigurationBuilder WithSchemaIdStrategy(SchemaIdSerializerStrategy? schemaIdStrategy)

Parameters

schemaIdStrategy SchemaIdSerializerStrategy?

The schema ID strategy.

Returns

KafkaAvroSerializerConfigurationBuilder

The KafkaAvroSerializerConfigurationBuilder so that additional calls can be chained.

WithSubjectNameStrategy(SubjectNameStrategy?)

Sets the subject name strategy. The default is Confluent.SchemaRegistry.SubjectNameStrategy.Associated.

public KafkaAvroSerializerConfigurationBuilder WithSubjectNameStrategy(SubjectNameStrategy? subjectNameStrategy)

Parameters

subjectNameStrategy SubjectNameStrategy?

The subject name strategy.

Returns

KafkaAvroSerializerConfigurationBuilder

The KafkaAvroSerializerConfigurationBuilder so that additional calls can be chained.

WithUseLatestWithMetadata(IReadOnlyDictionary<string, string>?)

Sets the metadata to be used to select the latest subject version to be used for serialization. Note that there is no check that the latest schema is backwards compatible with the schema of the object being serialized.

public KafkaAvroSerializerConfigurationBuilder WithUseLatestWithMetadata(IReadOnlyDictionary<string, string>? useLatestWithMetadata)

Parameters

useLatestWithMetadata IReadOnlyDictionary<string, string>

The metadata to be used to select the latest subject version.

Returns

KafkaAvroSerializerConfigurationBuilder

The KafkaAvroSerializerConfigurationBuilder so that additional calls can be chained.

WithUseSchemaId(int?)

Sets the ID of the schema to be used for serialization. Note that there is no check that the schema is backwards compatible with the schema of the object being serialized.

public KafkaAvroSerializerConfigurationBuilder WithUseSchemaId(int? useSchemaId)

Parameters

useSchemaId int?

The ID of the schema to be used for serialization.

Returns

KafkaAvroSerializerConfigurationBuilder

The KafkaAvroSerializerConfigurationBuilder so that additional calls can be chained.

WithValidationRulesExecution(ValidationRulesExecution?)

Sets a value specifying when the inline validation rules run, relative to the domain rule transformations. The default is Confluent.SchemaRegistry.ValidationRulesExecution.Disabled.

public KafkaAvroSerializerConfigurationBuilder WithValidationRulesExecution(ValidationRulesExecution? validationRulesExecution)

Parameters

validationRulesExecution ValidationRulesExecution?

A value specifying when the inline validation rules run.

Returns

KafkaAvroSerializerConfigurationBuilder

The KafkaAvroSerializerConfigurationBuilder so that additional calls can be chained.