Table of Contents

Class KafkaSchemaRegistryConfigurationBuilder

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

Constructors

KafkaSchemaRegistryConfigurationBuilder()

public KafkaSchemaRegistryConfigurationBuilder()

Methods

Build()

Builds the KafkaSchemaRegistryConfiguration instance.

public KafkaSchemaRegistryConfiguration Build()

Returns

KafkaSchemaRegistryConfiguration

The KafkaSchemaRegistryConfiguration.

DisableSslCertificateVerification()

Disables the SSL certificate validation.

public KafkaSchemaRegistryConfigurationBuilder DisableSslCertificateVerification()

Returns

KafkaSchemaRegistryConfigurationBuilder

The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

EnableSslCertificateVerification()

Enables the SSL certificate validation.

public KafkaSchemaRegistryConfigurationBuilder EnableSslCertificateVerification()

Returns

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.

public KafkaSchemaRegistryConfigurationBuilder WithBasicAuthCredentialsSource(AuthCredentialsSource? basicAuthCredentialsSource)

Parameters

basicAuthCredentialsSource AuthCredentialsSource?

The source of the basic authentication credentials.

Returns

KafkaSchemaRegistryConfigurationBuilder

The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithBasicAuthUserInfo(string?)

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

public KafkaSchemaRegistryConfigurationBuilder WithBasicAuthUserInfo(string? basicAuthUserInfo)

Parameters

basicAuthUserInfo string

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

Returns

KafkaSchemaRegistryConfigurationBuilder

The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithBearerAuthClientId(string?)

Sets the client ID for the bearer authentication credentials.

public KafkaSchemaRegistryConfigurationBuilder WithBearerAuthClientId(string? bearerAuthClientId)

Parameters

bearerAuthClientId string

The client ID for the bearer authentication credentials.

Returns

KafkaSchemaRegistryConfigurationBuilder

The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithBearerAuthClientSecret(string?)

Sets the client secret for the bearer authentication credentials.

public KafkaSchemaRegistryConfigurationBuilder WithBearerAuthClientSecret(string? bearerAuthClientSecret)

Parameters

bearerAuthClientSecret string

The client secret for the bearer authentication credentials.

Returns

KafkaSchemaRegistryConfigurationBuilder

The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithBearerAuthCredentialsSource(BearerAuthCredentialsSource?)

Sets the source of the bearer authentication credentials: a static token (see WithBearerAuthToken(string?)), an OAuth client (see WithBearerAuthClientId(string?) and WithBearerAuthClientSecret(string?)), the Azure Instance Metadata Service (IMDS) or a custom Confluent.SchemaRegistry.IAuthenticationHeaderValueProvider implementation.

public KafkaSchemaRegistryConfigurationBuilder WithBearerAuthCredentialsSource(BearerAuthCredentialsSource? bearerAuthCredentialsSource)

Parameters

bearerAuthCredentialsSource BearerAuthCredentialsSource?

The source of the bearer authentication credentials.

Returns

KafkaSchemaRegistryConfigurationBuilder

The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithBearerAuthIdentityPoolId(string?)

Sets the identity pool for the bearer authentication credentials.

public KafkaSchemaRegistryConfigurationBuilder WithBearerAuthIdentityPoolId(string? bearerAuthIdentityPoolId)

Parameters

bearerAuthIdentityPoolId string

The identity pool for the bearer authentication credentials.

Returns

KafkaSchemaRegistryConfigurationBuilder

The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithBearerAuthLogicalCluster(string?)

Sets the logical cluster for the bearer authentication credentials.

public KafkaSchemaRegistryConfigurationBuilder WithBearerAuthLogicalCluster(string? bearerAuthLogicalCluster)

Parameters

bearerAuthLogicalCluster string

The logical cluster for the bearer authentication credentials.

Returns

KafkaSchemaRegistryConfigurationBuilder

The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithBearerAuthScope(string?)

Sets the scope for the bearer authentication credentials.

public KafkaSchemaRegistryConfigurationBuilder WithBearerAuthScope(string? bearerAuthScope)

Parameters

bearerAuthScope string

The scope for the bearer authentication credentials.

Returns

KafkaSchemaRegistryConfigurationBuilder

The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithBearerAuthToken(string?)

Sets the bearer authentication token.

public KafkaSchemaRegistryConfigurationBuilder WithBearerAuthToken(string? bearerAuthToken)

Parameters

bearerAuthToken string

The bearer authentication token.

Returns

KafkaSchemaRegistryConfigurationBuilder

The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithBearerAuthTokenEndpointQuery(string?)

Sets the token query parameters for the bearer token endpoint. Currently valid only when using the Azure Instance Metadata Service (IMDS) for token retrieval.

public KafkaSchemaRegistryConfigurationBuilder WithBearerAuthTokenEndpointQuery(string? bearerAuthTokenEndpointQuery)

Parameters

bearerAuthTokenEndpointQuery string

The token query parameters for the bearer token endpoint.

Returns

KafkaSchemaRegistryConfigurationBuilder

The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithBearerAuthTokenEndpointUrl(string?)

Sets the token endpoint for the bearer authentication credentials.

public KafkaSchemaRegistryConfigurationBuilder WithBearerAuthTokenEndpointUrl(string? bearerAuthTokenEndpointUrl)

Parameters

bearerAuthTokenEndpointUrl string

The token endpoint for the bearer authentication credentials.

Returns

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.

public KafkaSchemaRegistryConfigurationBuilder WithLatestCacheTtlSecs(int? latestCacheTtlSecs)

Parameters

latestCacheTtlSecs int?

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

Returns

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.

public KafkaSchemaRegistryConfigurationBuilder WithMaxCachedSchemas(int? maxCachedSchemas)

Parameters

maxCachedSchemas int?

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

Returns

KafkaSchemaRegistryConfigurationBuilder

The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithMaxConnectionsPerServer(int?)

Sets the maximum number of connections per server.

public KafkaSchemaRegistryConfigurationBuilder WithMaxConnectionsPerServer(int? maxConnectionsPerServer)

Parameters

maxConnectionsPerServer int?

The maximum number of connections per server.

Returns

KafkaSchemaRegistryConfigurationBuilder

The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithMaxRetries(int?)

Sets the maximum number of retries for a request.

public KafkaSchemaRegistryConfigurationBuilder WithMaxRetries(int? maxRetries)

Parameters

maxRetries int?

The maximum number of retries for a request.

Returns

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.

public KafkaSchemaRegistryConfigurationBuilder WithRequestTimeoutMs(int? requestTimeoutMs)

Parameters

requestTimeoutMs int?

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

Returns

KafkaSchemaRegistryConfigurationBuilder

The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithRetriesMaxWaitMs(int?)

Sets the time to wait for any retry in milliseconds.

public KafkaSchemaRegistryConfigurationBuilder WithRetriesMaxWaitMs(int? retriesMaxWaitMs)

Parameters

retriesMaxWaitMs int?

The time to wait for any retry in milliseconds.

Returns

KafkaSchemaRegistryConfigurationBuilder

The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithRetriesWaitMs(int?)

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

public KafkaSchemaRegistryConfigurationBuilder WithRetriesWaitMs(int? retriesWaitMs)

Parameters

retriesWaitMs int?

The time to wait for the first retry in milliseconds.

Returns

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.

public KafkaSchemaRegistryConfigurationBuilder WithSslCaLocation(string? sslCaLocation)

Parameters

sslCaLocation string

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

Returns

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.

public KafkaSchemaRegistryConfigurationBuilder WithSslKeystoreLocation(string? sslKeystoreLocation)

Parameters

sslKeystoreLocation string

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

Returns

KafkaSchemaRegistryConfigurationBuilder

The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.

WithSslKeystorePassword(string?)

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

public KafkaSchemaRegistryConfigurationBuilder WithSslKeystorePassword(string? sslKeystorePassword)

Parameters

sslKeystorePassword string

The client's keystore (PKCS#12) password.

Returns

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.

public KafkaSchemaRegistryConfigurationBuilder WithUrl(string? url)

Parameters

url string

The comma-separated list of URLs for schema registry instances.

Returns

KafkaSchemaRegistryConfigurationBuilder

The KafkaSchemaRegistryConfigurationBuilder so that additional calls can be chained.