Class KafkaSchemaRegistryConfiguration

Wraps the Confluent.SchemaRegistry.SchemaRegistryConfig adding the Silverback specific settings.

Inheritance
object
KafkaSchemaRegistryConfiguration
Inherited Members
Namespace: Silverback.Messaging.Configuration.Kafka.SchemaRegistry
Assembly: Silverback.Integration.Kafka.SchemaRegistry.dll
Syntax
public sealed record KafkaSchemaRegistryConfiguration : IValidatableSettings, IEquatable<KafkaSchemaRegistryConfiguration>

Constructors

KafkaSchemaRegistryConfiguration()

Wraps the Confluent.SchemaRegistry.SchemaRegistryConfig adding the Silverback specific settings.

Declaration
public KafkaSchemaRegistryConfiguration()

Properties

BasicAuthCredentialsSource

Gets the source of the basic authentication credentials. This specifies whether the credentials are specified in the BasicAuthUserInfo or they are inherited from the producer or consumer configuration.

Declaration
public AuthCredentialsSource? BasicAuthCredentialsSource { get; init; }
Property Value
Type Description
AuthCredentialsSource?

BasicAuthUserInfo

Gets the basic authentication credentials in the form {username}:{password}.

Declaration
public string? BasicAuthUserInfo { get; init; }
Property Value
Type Description
string

EnableSslCertificateVerification

Gets a value indicating whether the registry (server) certificate must be verified.

Declaration
public bool? EnableSslCertificateVerification { get; init; }
Property Value
Type Description
bool?

LatestCacheTtlSecs

Gets the TTL in seconds for caches holding latest schemas, or -1 for no TTL.

Declaration
public int? LatestCacheTtlSecs { get; init; }
Property Value
Type Description
int?

MaxCachedSchemas

Gets the maximum number of schemas that are cached by the schema registry client.

Declaration
public int? MaxCachedSchemas { get; init; }
Property Value
Type Description
int?

MaxRetries

Gets the maximum number of retries for a request.

Declaration
public int? MaxRetries { get; init; }
Property Value
Type Description
int?

RequestTimeoutMs

Gets the timeout in milliseconds for the requests to the Confluent schema registry.

Declaration
public int? RequestTimeoutMs { get; init; }
Property Value
Type Description
int?

RetriesMaxWaitMs

Gets the time to wait for any retry in milliseconds.

Declaration
public int? RetriesMaxWaitMs { get; init; }
Property Value
Type Description
int?

RetriesWaitMs

Gets the time to wait for the first retry in milliseconds.

Declaration
public int? RetriesWaitMs { get; init; }
Property Value
Type Description
int?

SslCaLocation

Gets the file or directory path to the CA certificate(s) for verifying the registry's key. Defaults: On Windows the system's CA certificates are automatically looked up in the Windows Root certificate store. On Mac OSX this configuration defaults to probe. It is recommended to install openssl using Homebrew, to provide CA certificates. On Linux install the distribution's ca-certificates package. If OpenSSL is statically linked or SslCaLocation is set to probe a list of standard paths will be probed and the first one found will be used as the default CA certificate location path. If OpenSSL is dynamically linked the OpenSSL library's default path will be used (see OPENSSLDIR in openssl version -a).

Declaration
public string? SslCaLocation { get; init; }
Property Value
Type Description
string

SslKeystoreLocation

Gets the path to the client's keystore (PKCS#12) used for the authentication.

Declaration
public string? SslKeystoreLocation { get; init; }
Property Value
Type Description
string

SslKeystorePassword

Gets the client's keystore (PKCS#12) password.

Declaration
public string? SslKeystorePassword { get; init; }
Property Value
Type Description
string

Url

Gets the comma-separated list of URLs for schema registry instances that are used to register or lookup schemas.

Declaration
public string? Url { get; init; }
Property Value
Type Description
string

Methods

Equals(KafkaSchemaRegistryConfiguration?)

Wraps the Confluent.SchemaRegistry.SchemaRegistryConfig adding the Silverback specific settings.

Declaration
public bool Equals(KafkaSchemaRegistryConfiguration? other)
Parameters
Type Name Description
KafkaSchemaRegistryConfiguration other
Returns
Type Description
bool

Equals(object?)

Wraps the Confluent.SchemaRegistry.SchemaRegistryConfig adding the Silverback specific settings.

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides

GetHashCode()

Wraps the Confluent.SchemaRegistry.SchemaRegistryConfig adding the Silverback specific settings.

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides

ToString()

Wraps the Confluent.SchemaRegistry.SchemaRegistryConfig adding the Silverback specific settings.

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Validate()

Throws a SilverbackConfigurationException if the configuration is not valid.

Declaration
public void Validate()

Operators

operator ==(KafkaSchemaRegistryConfiguration?, KafkaSchemaRegistryConfiguration?)

Wraps the Confluent.SchemaRegistry.SchemaRegistryConfig adding the Silverback specific settings.

Declaration
public static bool operator ==(KafkaSchemaRegistryConfiguration? left, KafkaSchemaRegistryConfiguration? right)
Parameters
Type Name Description
KafkaSchemaRegistryConfiguration left
KafkaSchemaRegistryConfiguration right
Returns
Type Description
bool

operator !=(KafkaSchemaRegistryConfiguration?, KafkaSchemaRegistryConfiguration?)

Wraps the Confluent.SchemaRegistry.SchemaRegistryConfig adding the Silverback specific settings.

Declaration
public static bool operator !=(KafkaSchemaRegistryConfiguration? left, KafkaSchemaRegistryConfiguration? right)
Parameters
Type Name Description
KafkaSchemaRegistryConfiguration left
KafkaSchemaRegistryConfiguration right
Returns
Type Description
bool

Implements