Table of Contents

Class KafkaJsonDeserializerConfigurationBuilder

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

Constructors

KafkaJsonDeserializerConfigurationBuilder()

public KafkaJsonDeserializerConfigurationBuilder()

Methods

Build()

public KafkaJsonDeserializerConfiguration Build()

Returns

KafkaJsonDeserializerConfiguration

The KafkaJsonDeserializerConfiguration.

DisableLatestVersionUsage()

Disables the usage of the latest subject version for deserialization.

public KafkaJsonDeserializerConfigurationBuilder DisableLatestVersionUsage()

Returns

KafkaJsonDeserializerConfigurationBuilder

The KafkaJsonDeserializerConfigurationBuilder so that additional calls can be chained.

DisableValidation()

Disables the validation of the payload against the schema.

public KafkaJsonDeserializerConfigurationBuilder DisableValidation()

Returns

KafkaJsonDeserializerConfigurationBuilder

The KafkaJsonDeserializerConfigurationBuilder 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 KafkaJsonDeserializerConfigurationBuilder DisableValidationBeforeDomainRules()

Returns

KafkaJsonDeserializerConfigurationBuilder

The KafkaJsonDeserializerConfigurationBuilder so that additional calls can be chained.

DisableValidationRulesFailFast()

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

public KafkaJsonDeserializerConfigurationBuilder DisableValidationRulesFailFast()

Returns

KafkaJsonDeserializerConfigurationBuilder

The KafkaJsonDeserializerConfigurationBuilder so that additional calls can be chained.

EnableValidation()

Enables the validation of the payload against the schema. The payload is validated by default.

public KafkaJsonDeserializerConfigurationBuilder EnableValidation()

Returns

KafkaJsonDeserializerConfigurationBuilder

The KafkaJsonDeserializerConfigurationBuilder 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 KafkaJsonDeserializerConfigurationBuilder EnableValidationBeforeDomainRules()

Returns

KafkaJsonDeserializerConfigurationBuilder

The KafkaJsonDeserializerConfigurationBuilder 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 KafkaJsonDeserializerConfigurationBuilder EnableValidationRulesFailFast()

Returns

KafkaJsonDeserializerConfigurationBuilder

The KafkaJsonDeserializerConfigurationBuilder so that additional calls can be chained.

UseLatestVersion()

Specifies that the latest subject version must be used for deserialization. Note that there is no check that the latest schema is backwards compatible with the schema of the message being deserialized.

public KafkaJsonDeserializerConfigurationBuilder UseLatestVersion()

Returns

KafkaJsonDeserializerConfigurationBuilder

The KafkaJsonDeserializerConfigurationBuilder so that additional calls can be chained.

WithSchemaIdStrategy(SchemaIdDeserializerStrategy?)

Sets the schema ID strategy. The default is Confluent.SchemaRegistry.SchemaIdDeserializerStrategy.Dual.

public KafkaJsonDeserializerConfigurationBuilder WithSchemaIdStrategy(SchemaIdDeserializerStrategy? schemaIdStrategy)

Parameters

schemaIdStrategy SchemaIdDeserializerStrategy?

The schema ID strategy.

Returns

KafkaJsonDeserializerConfigurationBuilder

The KafkaJsonDeserializerConfigurationBuilder so that additional calls can be chained.

WithSubjectNameStrategy(SubjectNameStrategy?)

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

public KafkaJsonDeserializerConfigurationBuilder WithSubjectNameStrategy(SubjectNameStrategy? subjectNameStrategy)

Parameters

subjectNameStrategy SubjectNameStrategy?

The subject name strategy.

Returns

KafkaJsonDeserializerConfigurationBuilder

The KafkaJsonDeserializerConfigurationBuilder 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 deserialization. Note that there is no check that the latest schema is backwards compatible with the schema of the message being deserialized.

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

Parameters

useLatestWithMetadata IReadOnlyDictionary<string, string>

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

Returns

KafkaJsonDeserializerConfigurationBuilder

The KafkaJsonDeserializerConfigurationBuilder 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 KafkaJsonDeserializerConfigurationBuilder WithValidationRulesExecution(ValidationRulesExecution? validationRulesExecution)

Parameters

validationRulesExecution ValidationRulesExecution?

A value specifying when the inline validation rules run.

Returns

KafkaJsonDeserializerConfigurationBuilder

The KafkaJsonDeserializerConfigurationBuilder so that additional calls can be chained.