Class UpdateKafkaSchemaRegistryConnectionDetails

The information to update Kafka (e.g. Confluent) Schema Registry Connection.

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

Properties

AuthenticationType

Declaration
[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.

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 password is stored. The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. If secretId is used plaintext field must not be provided. Note: When provided, 'password' field must not be provided.

PrivateIp

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

This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.
For deprecated connections created with this field in the past, either the private IP had to be specified in the connectionString or host field, or the host name had to be resolvable in the target VCN.

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.

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
[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'

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.