Show / Hide Table of Contents

Class KafkaConnection

Represents the metadata of a Kafka Connection.

Inheritance
object
Connection
KafkaConnection
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
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 KafkaConnection : Connection

Properties

BootstrapServers

Declaration
[JsonProperty(PropertyName = "bootstrapServers")]
public List<KafkaBootstrapServer> BootstrapServers { get; set; }
Property Value
Type Description
List<KafkaBootstrapServer>

Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example: "server1.example.com:9092,server2.example.com:9092"

ConsumerProperties

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

The base64 encoded content of the consumer.properties file.

KeyStorePasswordSecretId

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

The OCID of the Secret where the kafka 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 where the content of the KeyStore file is stored. 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 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.

ProducerProperties

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

The base64 encoded content of the producer.properties file.

SecurityProtocol

Declaration
[JsonProperty(PropertyName = "securityProtocol")]
[JsonConverter(typeof(ResponseEnumConverter))]
public KafkaConnection.SecurityProtocolEnum? SecurityProtocol { get; set; }
Property Value
Type Description
KafkaConnection.SecurityProtocolEnum?

Kafka security protocol.

SslKeyPasswordSecretId

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

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

StreamPoolId

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

The OCID of the stream pool being referenced.

TechnologyType

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

The Kafka 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 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 where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided.

Username

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

The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.

In this article
Back to top