Class CreateKafkaSchemaRegistryConnectionDetails

The information about a new Kafka (e.g. Confluent) Schema Registry Connection.

Inheritance
object
CreateConnectionDetails
CreateKafkaSchemaRegistryConnectionDetails
Inherited Members
Namespace: Oci.GoldengateService.Models
Assembly: OCI.DotNetSDK.Goldengate.dll
Syntax
public class CreateKafkaSchemaRegistryConnectionDetails : CreateConnectionDetails

Properties

AuthenticationType

Declaration
[Required(ErrorMessage = "AuthenticationType is required.")]
[JsonProperty(PropertyName = "authenticationType")]
[JsonConverter(typeof(StringEnumConverter))]
public KafkaSchemaRegistryConnection.AuthenticationTypeEnum? AuthenticationType { get; set; }
Property Value
Type Description
KafkaSchemaRegistryConnection.AuthenticationTypeEnum?

Used authentication mechanism to access Schema Registry.
Remarks

Required

KeyStore

Declaration
[JsonProperty(PropertyName = "keyStore")]
public string KeyStore { get; set; }
Property Value
Type Description
string

The base64 encoded content of the KeyStore file. Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.

KeyStorePassword

Declaration
[JsonProperty(PropertyName = "keyStorePassword")]
public string KeyStorePassword { get; set; }
Property Value
Type Description
string

The KeyStore password. Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.

KeyStorePasswordSecretId

Declaration
[JsonProperty(PropertyName = "keyStorePasswordSecretId")]
public string KeyStorePasswordSecretId { get; set; }
Property Value
Type Description
string

The OCID of the Secret where the kafka Ssl KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.

KeyStoreSecretId

Declaration
[JsonProperty(PropertyName = "keyStoreSecretId")]
public string KeyStoreSecretId { get; set; }
Property Value
Type Description
string

The OCID of the Secret that stores the content of the KeyStore file. Note: When provided, 'keyStore' field must not be provided.

Password

Declaration
[JsonProperty(PropertyName = "password")]
public string Password { get; set; }
Property Value
Type Description
string

The password to access Schema Registry using basic authentication. This value is injected into 'schema.registry.basic.auth.user.info=user:password' configuration property. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.

PasswordSecretId

Declaration
[JsonProperty(PropertyName = "passwordSecretId")]
public string PasswordSecretId { get; set; }
Property Value
Type Description
string

The OCID of the Secret where the Kafka Schema Registry password is stored, The password to access Schema Registry using basic authentication. This value is injected into 'schema.registry.basic.auth.user.info=user:password' configuration property. Note: When provided, 'password' field must not be provided.

PrivateIp

Declaration
[JsonProperty(PropertyName = "privateIp")]
public string PrivateIp { get; set; }
Property Value
Type Description
string

Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.
The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

SslKeyPassword

Declaration
[JsonProperty(PropertyName = "sslKeyPassword")]
public string SslKeyPassword { get; set; }
Property Value
Type Description
string

The password for the cert inside the KeyStore. In case it differs from the KeyStore password, it should be provided. Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This field will be removed after February 15 2026.

SslKeyPasswordSecretId

Declaration
[JsonProperty(PropertyName = "sslKeyPasswordSecretId")]
public string SslKeyPasswordSecretId { get; set; }
Property Value
Type Description
string

The OCID of the Secret that stores the password for the cert inside the KeyStore. In case it differs from the KeyStore password, it should be provided. Note: When provided, 'sslKeyPassword' field must not be provided.

TechnologyType

Declaration
[Required(ErrorMessage = "TechnologyType is required.")]
[JsonProperty(PropertyName = "technologyType")]
[JsonConverter(typeof(StringEnumConverter))]
public KafkaSchemaRegistryConnection.TechnologyTypeEnum? TechnologyType { get; set; }
Property Value
Type Description
KafkaSchemaRegistryConnection.TechnologyTypeEnum?

The Kafka (e.g. Confluent) Schema Registry technology type.
Remarks

Required

TrustStore

Declaration
[JsonProperty(PropertyName = "trustStore")]
public string TrustStore { get; set; }
Property Value
Type Description
string

The base64 encoded content of the TrustStore file. Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.

TrustStorePassword

Declaration
[JsonProperty(PropertyName = "trustStorePassword")]
public string TrustStorePassword { get; set; }
Property Value
Type Description
string

The TrustStore password. Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.

TrustStorePasswordSecretId

Declaration
[JsonProperty(PropertyName = "trustStorePasswordSecretId")]
public string TrustStorePasswordSecretId { get; set; }
Property Value
Type Description
string

The OCID of the Secret where the kafka Ssl TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.

TrustStoreSecretId

Declaration
[JsonProperty(PropertyName = "trustStoreSecretId")]
public string TrustStoreSecretId { get; set; }
Property Value
Type Description
string

The OCID of the Secret that stores the content of the TrustStore file. Note: When provided, 'trustStore' field must not be provided.

Url

Declaration
[Required(ErrorMessage = "Url is required.")]
[JsonProperty(PropertyName = "url")]
public string Url { get; set; }
Property Value
Type Description
string

Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
Remarks

Required

Username

Declaration
[JsonProperty(PropertyName = "username")]
public string Username { get; set; }
Property Value
Type Description
string

The username to access Schema Registry using basic authentication. This value is injected into 'schema.registry.basic.auth.user.info=user:password' configuration property.