Class KafkaJsonSerializerConfigurationBuilder
- Namespace
- Silverback.Messaging.Configuration.Kafka.SchemaRegistry
- Assembly
- Silverback.Integration.Kafka.SchemaRegistry.dll
Builds the KafkaJsonSerializerConfiguration.
public class KafkaJsonSerializerConfigurationBuilder
- Inheritance
-
KafkaJsonSerializerConfigurationBuilder
- Inherited Members
Constructors
KafkaJsonSerializerConfigurationBuilder()
public KafkaJsonSerializerConfigurationBuilder()
Methods
Build()
Builds the KafkaJsonSerializerConfiguration instance.
public KafkaJsonSerializerConfiguration Build()
Returns
DisableLatestVersionUsage()
Disables the usage of the latest subject version for serialization.
public KafkaJsonSerializerConfigurationBuilder DisableLatestVersionUsage()
Returns
- KafkaJsonSerializerConfigurationBuilder
The KafkaJsonSerializerConfigurationBuilder so that additional calls can be chained.
DisableSchemaAutoRegistration()
Disables the automatic registration of the unrecognized schemas with the schema registry.
public KafkaJsonSerializerConfigurationBuilder DisableSchemaAutoRegistration()
Returns
- KafkaJsonSerializerConfigurationBuilder
The KafkaJsonSerializerConfigurationBuilder so that additional calls can be chained.
DisableSchemaNormalization()
Disables the schema normalization.
public KafkaJsonSerializerConfigurationBuilder DisableSchemaNormalization()
Returns
- KafkaJsonSerializerConfigurationBuilder
The KafkaJsonSerializerConfigurationBuilder so that additional calls can be chained.
DisableStrictLatestCompatibility()
Disables the check of the backwards compatibility with the latest schema of the subject.
public KafkaJsonSerializerConfigurationBuilder DisableStrictLatestCompatibility()
Returns
- KafkaJsonSerializerConfigurationBuilder
The KafkaJsonSerializerConfigurationBuilder so that additional calls can be chained.
DisableValidation()
Disables the validation of the payload against the schema.
public KafkaJsonSerializerConfigurationBuilder DisableValidation()
Returns
- KafkaJsonSerializerConfigurationBuilder
The KafkaJsonSerializerConfigurationBuilder so that additional calls can be chained.
DisableValidationBeforeDomainRules()
Disables the validation of the message against the schema before running the domain rules, validating it after.
public KafkaJsonSerializerConfigurationBuilder DisableValidationBeforeDomainRules()
Returns
- KafkaJsonSerializerConfigurationBuilder
The KafkaJsonSerializerConfigurationBuilder so that additional calls can be chained.
DisableValidationRulesFailFast()
Disables the fail fast mode for the validation rules, reporting all the violations.
public KafkaJsonSerializerConfigurationBuilder DisableValidationRulesFailFast()
Returns
- KafkaJsonSerializerConfigurationBuilder
The KafkaJsonSerializerConfigurationBuilder 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 KafkaJsonSerializerConfigurationBuilder EnableSchemaAutoRegistration()
Returns
- KafkaJsonSerializerConfigurationBuilder
The KafkaJsonSerializerConfigurationBuilder 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 KafkaJsonSerializerConfigurationBuilder EnableSchemaNormalization()
Returns
- KafkaJsonSerializerConfigurationBuilder
The KafkaJsonSerializerConfigurationBuilder so that additional calls can be chained.
EnableStrictLatestCompatibility()
Enables the check of the backwards compatibility with the latest schema of the subject.
public KafkaJsonSerializerConfigurationBuilder EnableStrictLatestCompatibility()
Returns
- KafkaJsonSerializerConfigurationBuilder
The KafkaJsonSerializerConfigurationBuilder so that additional calls can be chained.
EnableValidation()
Enables the validation of the payload against the schema. The payload is validated by default.
public KafkaJsonSerializerConfigurationBuilder EnableValidation()
Returns
- KafkaJsonSerializerConfigurationBuilder
The KafkaJsonSerializerConfigurationBuilder so that additional calls can be chained.
EnableValidationBeforeDomainRules()
Enables the validation of the message against the schema before running the domain rules instead of after.
public KafkaJsonSerializerConfigurationBuilder EnableValidationBeforeDomainRules()
Returns
- KafkaJsonSerializerConfigurationBuilder
The KafkaJsonSerializerConfigurationBuilder 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 KafkaJsonSerializerConfigurationBuilder EnableValidationRulesFailFast()
Returns
- KafkaJsonSerializerConfigurationBuilder
The KafkaJsonSerializerConfigurationBuilder so that additional calls can be chained.
UseLatestVersion()
Specifies that the latest subject version must be used for serialization. Note that by default there is no check that the latest schema is compatible with the schema of the object being serialized: use EnableStrictLatestCompatibility() to enable it.
public KafkaJsonSerializerConfigurationBuilder UseLatestVersion()
Returns
- KafkaJsonSerializerConfigurationBuilder
The KafkaJsonSerializerConfigurationBuilder 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 KafkaJsonSerializerConfigurationBuilder WithBufferBytes(int? bufferBytes)
Parameters
bufferBytesint?The initial size (in bytes) of the buffer.
Returns
- KafkaJsonSerializerConfigurationBuilder
The KafkaJsonSerializerConfigurationBuilder so that additional calls can be chained.
WithSchemaIdStrategy(SchemaIdSerializerStrategy?)
Sets the schema ID strategy. The default is Confluent.SchemaRegistry.SchemaIdSerializerStrategy.Prefix.
public KafkaJsonSerializerConfigurationBuilder WithSchemaIdStrategy(SchemaIdSerializerStrategy? schemaIdStrategy)
Parameters
schemaIdStrategySchemaIdSerializerStrategy?The schema ID strategy.
Returns
- KafkaJsonSerializerConfigurationBuilder
The KafkaJsonSerializerConfigurationBuilder so that additional calls can be chained.
WithSubjectNameStrategy(SubjectNameStrategy?)
Sets the subject name strategy. The default is Confluent.SchemaRegistry.SubjectNameStrategy.Associated.
public KafkaJsonSerializerConfigurationBuilder WithSubjectNameStrategy(SubjectNameStrategy? subjectNameStrategy)
Parameters
subjectNameStrategySubjectNameStrategy?The subject name strategy.
Returns
- KafkaJsonSerializerConfigurationBuilder
The KafkaJsonSerializerConfigurationBuilder 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 KafkaJsonSerializerConfigurationBuilder WithUseLatestWithMetadata(IReadOnlyDictionary<string, string>? useLatestWithMetadata)
Parameters
useLatestWithMetadataIReadOnlyDictionary<string, string>The metadata to be used to select the latest subject version.
Returns
- KafkaJsonSerializerConfigurationBuilder
The KafkaJsonSerializerConfigurationBuilder 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 KafkaJsonSerializerConfigurationBuilder WithUseSchemaId(int? useSchemaId)
Parameters
useSchemaIdint?The ID of the schema to be used for serialization.
Returns
- KafkaJsonSerializerConfigurationBuilder
The KafkaJsonSerializerConfigurationBuilder 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 KafkaJsonSerializerConfigurationBuilder WithValidationRulesExecution(ValidationRulesExecution? validationRulesExecution)
Parameters
validationRulesExecutionValidationRulesExecution?A value specifying when the inline validation rules run.
Returns
- KafkaJsonSerializerConfigurationBuilder
The KafkaJsonSerializerConfigurationBuilder so that additional calls can be chained.