Class SchemaRegistryConfig

CachedSchemaRegistryClient configuration properties.

Inheritance

object

SchemaRegistryConfig

Implements

IEnumerable<KeyValuePair<string, string>>

IEnumerable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Confluent.SchemaRegistry

Assembly: Confluent.SchemaRegistry.dll

Syntax

public class SchemaRegistryConfig : IEnumerable<KeyValuePair<string, string>>, IEnumerable

Fields

properties

The configuration properties.

Declaration

protected Dictionary<string, string> properties

Field Value

Type	Description
Dictionary<string, string>

Properties

BasicAuthCredentialsSource

Specifies the configuration property(ies) that provide the basic authentication credentials.

Declaration

public AuthCredentialsSource? BasicAuthCredentialsSource { get; set; }

Property Value

Type	Description
AuthCredentialsSource?

BasicAuthUserInfo

Basic auth credentials in the form {username}:{password}.

Declaration

public string BasicAuthUserInfo { get; set; }

Property Value

Type	Description
string

BearerAuthClientId

Specifies the client ID for the bearer authentication credentials.

Declaration

public string BearerAuthClientId { get; set; }

Property Value

Type	Description
string

BearerAuthClientSecret

Specifies the client secret for the bearer authentication credentials.

Declaration

public string BearerAuthClientSecret { get; set; }

Property Value

Type	Description
string

BearerAuthCredentialsSource

Specifies the configuration property(ies) that provide the bearer authentication credentials.

Declaration

public BearerAuthCredentialsSource? BearerAuthCredentialsSource { get; set; }

Property Value

Type	Description
BearerAuthCredentialsSource?

BearerAuthIdentityPoolId

Specifies the identity pool for the bearer authentication credentials.

Declaration

public string BearerAuthIdentityPoolId { get; set; }

Property Value

Type	Description
string

BearerAuthLogicalCluster

Specifies the logical cluster for the bearer authentication credentials.

Declaration

public string BearerAuthLogicalCluster { get; set; }

Property Value

Type	Description
string

BearerAuthScope

Specifies the scope for the bearer authentication credentials.

Declaration

public string BearerAuthScope { get; set; }

Property Value

Type	Description
string

BearerAuthToken

Specifies the bearer authentication token.

Declaration

public string BearerAuthToken { get; set; }

Property Value

Type	Description
string

BearerAuthTokenEndpointUrl

Specifies the token endpoint for the bearer authentication credentials.

Declaration

public string BearerAuthTokenEndpointUrl { get; set; }

Property Value

Type	Description
string

EnableSslCertificateVerification

Enable/Disable SSL server certificate verification. Only use in contained test/dev environments.

default: '' importance: low

Declaration

public bool? EnableSslCertificateVerification { get; set; }

Property Value

Type	Description
bool?

KeySubjectNameStrategy

Key subject name strategy.

default: SubjectNameStrategy.Topic

Declaration

[Obsolete("Subject name strategies should now be configured using the serializer's configuration. In the future, this configuration property will be removed from SchemaRegistryConfig")]
public SubjectNameStrategy? KeySubjectNameStrategy { get; set; }

Property Value

Type	Description
SubjectNameStrategy?

LatestCacheTtlSecs

Specifies the TTL for caches holding latest schemas, or -1 for no TTL.

default: -1

Declaration

public int? LatestCacheTtlSecs { get; set; }

Property Value

Type	Description
int?

MaxCachedSchemas

Specifies the maximum number of schemas CachedSchemaRegistryClient should cache locally.

default: 1000

Declaration

public int? MaxCachedSchemas { get; set; }

Property Value

Type	Description
int?

MaxRetries

Specifies the maximum number of retries for a request.

default: 3

Declaration

public int? MaxRetries { get; set; }

Property Value

Type	Description
int?

RequestTimeoutMs

Specifies the timeout for requests to Confluent Schema Registry.

default: 30000

Declaration

public int? RequestTimeoutMs { get; set; }

Property Value

Type	Description
int?

RetriesMaxWaitMs

Specifies the time to wait for any retry.

default: 20000

Declaration

public int? RetriesMaxWaitMs { get; set; }

Property Value

Type	Description
int?

RetriesWaitMs

Specifies the time to wait for the first retry.

default: 1000

Declaration

public int? RetriesWaitMs { get; set; }

Property Value

Type	Description
int?

SslCaLocation

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

default: '' importance: low

Declaration

public string SslCaLocation { get; set; }

Property Value

Type	Description
string

SslKeystoreLocation

Path to client's keystore (PKCS#12) used for authentication.

default: '' importance: low

Declaration

public string SslKeystoreLocation { get; set; }

Property Value

Type	Description
string

SslKeystorePassword

Client's keystore (PKCS#12) password.

default: '' importance: low

Declaration

public string SslKeystorePassword { get; set; }

Property Value

Type	Description
string

Url

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

Declaration

public string Url { get; set; }

Property Value

Type	Description
string

ValueSubjectNameStrategy

Value subject name strategy.

default: SubjectNameStrategy.Topic

Declaration

[Obsolete("Subject name strategies should now be configured using the serializer's configuration. In the future, this configuration property will be removed from SchemaRegistryConfig")]
public SubjectNameStrategy? ValueSubjectNameStrategy { get; set; }

Property Value

Type	Description
SubjectNameStrategy?

Methods

Get(string)

Gets a configuration property value given a key. Returns null if the property has not been set.

Declaration

public string Get(string key)

Parameters

Type	Name	Description
string	key	The configuration property to get.

Returns

Type	Description
string	The configuration property value.

GetBool(string)

Gets a configuration property bool? value given a key.

Declaration

protected bool? GetBool(string key)

Parameters

Type	Name	Description
string	key	The configuration property to get.

Returns

Type	Description
bool?	The configuration property value.

GetEnumerator()

Returns an enumerator that iterates through the property collection.

Declaration

public IEnumerator<KeyValuePair<string, string>> GetEnumerator()

Returns

Type	Description
IEnumerator<KeyValuePair<string, string>>	An enumerator that iterates through the property collection.

GetInt(string)

Gets a configuration property int? value given a key.

Declaration

protected int? GetInt(string key)

Parameters

Type	Name	Description
string	key	The configuration property to get.

Returns

Type	Description
int?	The configuration property value.

Set(string, string)

Set a configuration property using a string key / value pair.

Declaration

public void Set(string key, string val)

Parameters

Type	Name	Description
string	key	The configuration property name.
string	val	The property value.

SetObject(string, object)

Set a configuration property using a key / value pair (null checked).

Declaration

protected void SetObject(string name, object val)

Parameters

Type	Name	Description
string	name
object	val

Implements

IEnumerable<T>

IEnumerable