Table of Contents

Class KafkaProtobufDeserializerConfigurationBuilder

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

Constructors

KafkaProtobufDeserializerConfigurationBuilder()

public KafkaProtobufDeserializerConfigurationBuilder()

Methods

Build()

public KafkaProtobufDeserializerConfiguration Build()

Returns

KafkaProtobufDeserializerConfiguration

The KafkaProtobufDeserializerConfiguration.

DisableDeprecatedFormatUsage()

Disables the deprecated format, deserializing the message indexes with zig-zag encoding.

public KafkaProtobufDeserializerConfigurationBuilder DisableDeprecatedFormatUsage()

Returns

KafkaProtobufDeserializerConfigurationBuilder

The KafkaProtobufDeserializerConfigurationBuilder so that additional calls can be chained.

DisableLatestVersionUsage()

Disables the usage of the latest subject version for deserialization.

public KafkaProtobufDeserializerConfigurationBuilder DisableLatestVersionUsage()

Returns

KafkaProtobufDeserializerConfigurationBuilder

The KafkaProtobufDeserializerConfigurationBuilder so that additional calls can be chained.

DisableValidationRulesFailFast()

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

public KafkaProtobufDeserializerConfigurationBuilder DisableValidationRulesFailFast()

Returns

KafkaProtobufDeserializerConfigurationBuilder

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

Returns

KafkaProtobufDeserializerConfigurationBuilder

The KafkaProtobufDeserializerConfigurationBuilder so that additional calls can be chained.

UseDeprecatedFormat()

Specifies that the message indexes must be deserialized without zig-zag encoding (deprecated format).

public KafkaProtobufDeserializerConfigurationBuilder UseDeprecatedFormat()

Returns

KafkaProtobufDeserializerConfigurationBuilder

The KafkaProtobufDeserializerConfigurationBuilder 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 KafkaProtobufDeserializerConfigurationBuilder UseLatestVersion()

Returns

KafkaProtobufDeserializerConfigurationBuilder

The KafkaProtobufDeserializerConfigurationBuilder so that additional calls can be chained.

WithSchemaIdStrategy(SchemaIdDeserializerStrategy?)

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

public KafkaProtobufDeserializerConfigurationBuilder WithSchemaIdStrategy(SchemaIdDeserializerStrategy? schemaIdStrategy)

Parameters

schemaIdStrategy SchemaIdDeserializerStrategy?

The schema ID strategy.

Returns

KafkaProtobufDeserializerConfigurationBuilder

The KafkaProtobufDeserializerConfigurationBuilder so that additional calls can be chained.

WithSubjectNameStrategy(SubjectNameStrategy?)

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

public KafkaProtobufDeserializerConfigurationBuilder WithSubjectNameStrategy(SubjectNameStrategy? subjectNameStrategy)

Parameters

subjectNameStrategy SubjectNameStrategy?

The subject name strategy.

Returns

KafkaProtobufDeserializerConfigurationBuilder

The KafkaProtobufDeserializerConfigurationBuilder 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 KafkaProtobufDeserializerConfigurationBuilder WithUseLatestWithMetadata(IReadOnlyDictionary<string, string>? useLatestWithMetadata)

Parameters

useLatestWithMetadata IReadOnlyDictionary<string, string>

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

Returns

KafkaProtobufDeserializerConfigurationBuilder

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

Parameters

validationRulesExecution ValidationRulesExecution?

A value specifying when the inline validation rules run.

Returns

KafkaProtobufDeserializerConfigurationBuilder

The KafkaProtobufDeserializerConfigurationBuilder so that additional calls can be chained.