Class KafkaSchemaRegistryConfigurationBuilder

Builds the KafkaSchemaRegistryConfiguration.

Inheritance

object

KafkaSchemaRegistryConfigurationBuilder

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Silverback.Messaging.Configuration.Kafka.SchemaRegistry

Assembly: Silverback.Integration.Kafka.SchemaRegistry.dll

Syntax

public class KafkaSchemaRegistryConfigurationBuilder

Constructors

KafkaSchemaRegistryConfigurationBuilder()

Builds the KafkaSchemaRegistryConfiguration.

Declaration

public KafkaSchemaRegistryConfigurationBuilder()

Methods

Build()

Builds the KafkaSchemaRegistryConfiguration instance.

Declaration

public KafkaSchemaRegistryConfiguration Build()

Returns

Type	Description
KafkaSchemaRegistryConfiguration	The KafkaSchemaRegistryConfiguration.

DisableSslCertificateVerification()

Disables the SSL certificate validation.

Declaration

public KafkaSchemaRegistryConfigurationBuilder DisableSslCertificateVerification()

Returns

Type	Description
KafkaSchemaRegistryConfigurationBuilder	The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

EnableSslCertificateVerification()

Enables the SSL certificate validation.

Declaration

public KafkaSchemaRegistryConfigurationBuilder EnableSslCertificateVerification()

Returns

Type	Description
KafkaSchemaRegistryConfigurationBuilder	The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithBasicAuthCredentialsSource(AuthCredentialsSource?)

Sets 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 KafkaSchemaRegistryConfigurationBuilder WithBasicAuthCredentialsSource(AuthCredentialsSource? basicAuthCredentialsSource)

Parameters

Type	Name	Description
AuthCredentialsSource?	basicAuthCredentialsSource	The source of the basic authentication credentials.

Returns

Type	Description
KafkaSchemaRegistryConfigurationBuilder	The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithBasicAuthUserInfo(string?)

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

Declaration

public KafkaSchemaRegistryConfigurationBuilder WithBasicAuthUserInfo(string? basicAuthUserInfo)

Parameters

Type	Name	Description
string	basicAuthUserInfo	The basic authentication credentials in the form {username}:{password}.

Returns

Type	Description
KafkaSchemaRegistryConfigurationBuilder	The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithLatestCacheTtlSecs(int?)

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

Declaration

public KafkaSchemaRegistryConfigurationBuilder WithLatestCacheTtlSecs(int? latestCacheTtlSecs)

Parameters

Type	Name	Description
int?	latestCacheTtlSecs	The TTL in seconds for caches holding latest schemas, or -1 for no TTL.

Returns

Type	Description
KafkaSchemaRegistryConfigurationBuilder	The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithMaxCachedSchemas(int?)

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

Declaration

public KafkaSchemaRegistryConfigurationBuilder WithMaxCachedSchemas(int? maxCachedSchemas)

Parameters

Type	Name	Description
int?	maxCachedSchemas	The maximum number of schemas that are cached by the schema registry client.

Returns

Type	Description
KafkaSchemaRegistryConfigurationBuilder	The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithMaxRetries(int?)

Sets the maximum number of retries for a request.

Declaration

public KafkaSchemaRegistryConfigurationBuilder WithMaxRetries(int? maxRetries)

Parameters

Type	Name	Description
int?	maxRetries	The maximum number of retries for a request.

Returns

Type	Description
KafkaSchemaRegistryConfigurationBuilder	The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithRequestTimeoutMs(int?)

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

Declaration

public KafkaSchemaRegistryConfigurationBuilder WithRequestTimeoutMs(int? requestTimeoutMs)

Parameters

Type	Name	Description
int?	requestTimeoutMs	The timeout in milliseconds for the requests to the Confluent schema registry.

Returns

Type	Description
KafkaSchemaRegistryConfigurationBuilder	The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithRetriesMaxWaitMs(int?)

Sets the time to wait for any retry in milliseconds.

Declaration

public KafkaSchemaRegistryConfigurationBuilder WithRetriesMaxWaitMs(int? retriesMaxWaitMs)

Parameters

Type	Name	Description
int?	retriesMaxWaitMs	The time to wait for any retry in milliseconds.

Returns

Type	Description
KafkaSchemaRegistryConfigurationBuilder	The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithRetriesWaitMs(int?)

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

Declaration

public KafkaSchemaRegistryConfigurationBuilder WithRetriesWaitMs(int? retriesWaitMs)

Parameters

Type	Name	Description
int?	retriesWaitMs	The time to wait for the first retry in milliseconds.

Returns

Type	Description
KafkaSchemaRegistryConfigurationBuilder	The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithSslCaLocation(string?)

Sets the file or directory path to the CA certificate(s) for verifying the registry's key.

Declaration

public KafkaSchemaRegistryConfigurationBuilder WithSslCaLocation(string? sslCaLocation)

Parameters

Type	Name	Description
string	sslCaLocation	The file or directory path to the CA certificate(s) for verifying the registry's key.

Returns

Type	Description
KafkaSchemaRegistryConfigurationBuilder	The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithSslKeystoreLocation(string?)

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

Declaration

public KafkaSchemaRegistryConfigurationBuilder WithSslKeystoreLocation(string? sslKeystoreLocation)

Parameters

Type	Name	Description
string	sslKeystoreLocation	The path to the client's keystore (PKCS#12) used for the authentication.

Returns

Type	Description
KafkaSchemaRegistryConfigurationBuilder	The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithSslKeystorePassword(string?)

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

Declaration

public KafkaSchemaRegistryConfigurationBuilder WithSslKeystorePassword(string? sslKeystorePassword)

Parameters

Type	Name	Description
string	sslKeystorePassword	The client's keystore (PKCS#12) password.

Returns

Type	Description
KafkaSchemaRegistryConfigurationBuilder	The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithUrl(string?)

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

Declaration

public KafkaSchemaRegistryConfigurationBuilder WithUrl(string? url)

Parameters

Type	Name	Description
string	url	The comma-separated list of URLs for schema registry instances.

Returns

Type	Description
KafkaSchemaRegistryConfigurationBuilder	The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.