Class KafkaSchemaRegistryConnection

Represents the metadata of a Kafka (e.g. Confluent) Schema Registry Connection.

Inheritance

object

Connection

KafkaSchemaRegistryConnection

Inherited Members

Connection.Id

Connection.DisplayName

Connection.Description

Connection.CompartmentId

Connection.FreeformTags

Connection.DefinedTags

Connection.SystemTags

Connection.LifecycleState

Connection.LifecycleDetails

Connection.TimeCreated

Connection.TimeUpdated

Connection.Locks

Connection.VaultId

Connection.KeyId

Connection.IngressIps

Connection.NsgIds

Connection.SubnetId

Connection.RoutingMethod

Connection.DoesUseSecretIds

Connection.SubscriptionId

Connection.ClusterPlacementGroupId

Connection.SecurityAttributes

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.GoldengateService.Models

Assembly: OCI.DotNetSDK.Goldengate.dll

Syntax

public class KafkaSchemaRegistryConnection : Connection

Properties

AuthenticationType

Declaration

[Required(ErrorMessage = "AuthenticationType is required.")]
[JsonProperty(PropertyName = "authenticationType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public KafkaSchemaRegistryConnection.AuthenticationTypeEnum? AuthenticationType { get; set; }

Property Value

Type	Description
KafkaSchemaRegistryConnection.AuthenticationTypeEnum?	Used authentication mechanism to access Schema Registry.

Remarks

Required

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.

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.

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.

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(ResponseEnumConverter))]
public KafkaSchemaRegistryConnection.TechnologyTypeEnum? TechnologyType { get; set; }

Property Value

Type	Description
KafkaSchemaRegistryConnection.TechnologyTypeEnum?	The Kafka (e.g. Confluent) Schema Registry technology type.

Remarks

Required

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.