Table of Contents

Class KafkaProtobufSerializerConfigurationBuilder

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

Constructors

KafkaProtobufSerializerConfigurationBuilder()

public KafkaProtobufSerializerConfigurationBuilder()

Methods

Build()

public KafkaProtobufSerializerConfiguration Build()

Returns

KafkaProtobufSerializerConfiguration

The KafkaProtobufSerializerConfiguration.

DisableDeprecatedFormatUsage()

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

public KafkaProtobufSerializerConfigurationBuilder DisableDeprecatedFormatUsage()

Returns

KafkaProtobufSerializerConfigurationBuilder

The KafkaProtobufSerializerConfigurationBuilder so that additional calls can be chained.

DisableKnownTypesSkipping()

Disables the skipping of the known types when resolving the dependencies.

public KafkaProtobufSerializerConfigurationBuilder DisableKnownTypesSkipping()

Returns

KafkaProtobufSerializerConfigurationBuilder

The KafkaProtobufSerializerConfigurationBuilder so that additional calls can be chained.

DisableLatestVersionUsage()

Disables the usage of the latest subject version for serialization.

public KafkaProtobufSerializerConfigurationBuilder DisableLatestVersionUsage()

Returns

KafkaProtobufSerializerConfigurationBuilder

The KafkaProtobufSerializerConfigurationBuilder so that additional calls can be chained.

DisableSchemaAutoRegistration()

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

public KafkaProtobufSerializerConfigurationBuilder DisableSchemaAutoRegistration()

Returns

KafkaProtobufSerializerConfigurationBuilder

The KafkaProtobufSerializerConfigurationBuilder so that additional calls can be chained.

DisableSchemaNormalization()

Disables the schema normalization.

public KafkaProtobufSerializerConfigurationBuilder DisableSchemaNormalization()

Returns

KafkaProtobufSerializerConfigurationBuilder

The KafkaProtobufSerializerConfigurationBuilder so that additional calls can be chained.

DisableValidationRulesFailFast()

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

public KafkaProtobufSerializerConfigurationBuilder DisableValidationRulesFailFast()

Returns

KafkaProtobufSerializerConfigurationBuilder

The KafkaProtobufSerializerConfigurationBuilder 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 KafkaProtobufSerializerConfigurationBuilder EnableSchemaAutoRegistration()

Returns

KafkaProtobufSerializerConfigurationBuilder

The KafkaProtobufSerializerConfigurationBuilder 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 KafkaProtobufSerializerConfigurationBuilder EnableSchemaNormalization()

Returns

KafkaProtobufSerializerConfigurationBuilder

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

Returns

KafkaProtobufSerializerConfigurationBuilder

The KafkaProtobufSerializerConfigurationBuilder so that additional calls can be chained.

SkipKnownTypes()

Specifies that the known types must be skipped when resolving the dependencies. The known types are skipped by default.

public KafkaProtobufSerializerConfigurationBuilder SkipKnownTypes()

Returns

KafkaProtobufSerializerConfigurationBuilder

The KafkaProtobufSerializerConfigurationBuilder so that additional calls can be chained.

UseDeprecatedFormat()

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

public KafkaProtobufSerializerConfigurationBuilder UseDeprecatedFormat()

Returns

KafkaProtobufSerializerConfigurationBuilder

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

Returns

KafkaProtobufSerializerConfigurationBuilder

The KafkaProtobufSerializerConfigurationBuilder 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 KafkaProtobufSerializerConfigurationBuilder WithBufferBytes(int? bufferBytes)

Parameters

bufferBytes int?

The initial size (in bytes) of the buffer.

Returns

KafkaProtobufSerializerConfigurationBuilder

The KafkaProtobufSerializerConfigurationBuilder so that additional calls can be chained.

WithCustomReferenceSubjectNameStrategy(ICustomReferenceSubjectNameStrategy?)

Sets the custom reference subject name strategy resolver. It is used only if the WithReferenceSubjectNameStrategy(ReferenceSubjectNameStrategy?) is set to Confluent.SchemaRegistry.ReferenceSubjectNameStrategy.Custom.

public KafkaProtobufSerializerConfigurationBuilder WithCustomReferenceSubjectNameStrategy(ICustomReferenceSubjectNameStrategy? customReferenceSubjectNameStrategy)

Parameters

customReferenceSubjectNameStrategy ICustomReferenceSubjectNameStrategy

The custom reference subject name strategy resolver.

Returns

KafkaProtobufSerializerConfigurationBuilder

The KafkaProtobufSerializerConfigurationBuilder so that additional calls can be chained.

WithReferenceSubjectNameStrategy(ReferenceSubjectNameStrategy?)

Sets the reference subject name strategy. The default is Confluent.SchemaRegistry.ReferenceSubjectNameStrategy.ReferenceName.

public KafkaProtobufSerializerConfigurationBuilder WithReferenceSubjectNameStrategy(ReferenceSubjectNameStrategy? referenceSubjectNameStrategy)

Parameters

referenceSubjectNameStrategy ReferenceSubjectNameStrategy?

The reference subject name strategy.

Returns

KafkaProtobufSerializerConfigurationBuilder

The KafkaProtobufSerializerConfigurationBuilder so that additional calls can be chained.

WithSchemaIdStrategy(SchemaIdSerializerStrategy?)

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

public KafkaProtobufSerializerConfigurationBuilder WithSchemaIdStrategy(SchemaIdSerializerStrategy? schemaIdStrategy)

Parameters

schemaIdStrategy SchemaIdSerializerStrategy?

The schema ID strategy.

Returns

KafkaProtobufSerializerConfigurationBuilder

The KafkaProtobufSerializerConfigurationBuilder so that additional calls can be chained.

WithSubjectNameStrategy(SubjectNameStrategy?)

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

public KafkaProtobufSerializerConfigurationBuilder WithSubjectNameStrategy(SubjectNameStrategy? subjectNameStrategy)

Parameters

subjectNameStrategy SubjectNameStrategy?

The subject name strategy.

Returns

KafkaProtobufSerializerConfigurationBuilder

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

Parameters

useLatestWithMetadata IReadOnlyDictionary<string, string>

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

Returns

KafkaProtobufSerializerConfigurationBuilder

The KafkaProtobufSerializerConfigurationBuilder 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 KafkaProtobufSerializerConfigurationBuilder WithUseSchemaId(int? useSchemaId)

Parameters

useSchemaId int?

The ID of the schema to be used for serialization.

Returns

KafkaProtobufSerializerConfigurationBuilder

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

Parameters

validationRulesExecution ValidationRulesExecution?

A value specifying when the inline validation rules run.

Returns

KafkaProtobufSerializerConfigurationBuilder

The KafkaProtobufSerializerConfigurationBuilder so that additional calls can be chained.