Package com.oracle.bmc.goldengate.model

Class CreateKafkaConnectionDetails

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.goldengate.model.CreateConnectionDetails

com.oracle.bmc.goldengate.model.CreateKafkaConnectionDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200407")
public final class CreateKafkaConnectionDetails
extends CreateConnectionDetails

The information about a new Kafka Connection.
Note: Objects should always be created or deserialized using the CreateKafkaConnectionDetails.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the CreateKafkaConnectionDetails.Builder, which maintain a set of all explicitly set fields called CreateKafkaConnectionDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateKafkaConnectionDetails.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor

Description

CreateKafkaConnectionDetails(String displayName, String description, String compartmentId, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, List<AddResourceLockDetails> locks, String vaultId, String keyId, List<String> nsgIds, String subnetId, RoutingMethod routingMethod, Boolean doesUseSecretIds, String subscriptionId, String clusterPlacementGroupId, Map<String,Map<String,Object>> securityAttributes, KafkaConnection.TechnologyType technologyType, String streamPoolId, String clusterId, List<KafkaBootstrapServer> bootstrapServers, KafkaConnection.SecurityProtocol securityProtocol, String username, String password, String passwordSecretId, String trustStore, String trustStoreSecretId, String trustStorePassword, String trustStorePasswordSecretId, String keyStore, String keyStoreSecretId, String keyStorePassword, String keyStorePasswordSecretId, String sslKeyPassword, String sslKeyPasswordSecretId, String consumerProperties, String producerProperties, Boolean shouldUseResourcePrincipal)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static CreateKafkaConnectionDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<KafkaBootstrapServer>	getBootstrapServers()	Kafka bootstrap.
String	getClusterId()	The OCID of the Kafka cluster being referenced from OCI Streaming with Apache Kafka.
String	getConsumerProperties()	The base64 encoded content of the consumer.properties file.
String	getKeyStore()	The base64 encoded content of the KeyStore file.
String	getKeyStorePassword()	The KeyStore password.
String	getKeyStorePasswordSecretId()	The OCID of the Secret where the kafka KeyStore password is stored.
String	getKeyStoreSecretId()	The OCID of the Secret where the content of the KeyStore file is stored.
String	getPassword()	The password Oracle GoldenGate uses to connect the associated system of the given technology.
String	getPasswordSecretId()	The OCID of the Secret where the password is stored.
String	getProducerProperties()	The base64 encoded content of the producer.properties file.
KafkaConnection.SecurityProtocol	getSecurityProtocol()	Security Type for Kafka.
Boolean	getShouldUseResourcePrincipal()	Specifies that the user intends to authenticate to the instance using a resource principal.
String	getSslKeyPassword()	The password for the cert inside of the KeyStore.
String	getSslKeyPasswordSecretId()	The OCID of the Secret where the kafka Ssl Key password is stored.
String	getStreamPoolId()	The OCID of the stream pool being referenced.
KafkaConnection.TechnologyType	getTechnologyType()	The Kafka technology type.
String	getTrustStore()	The base64 encoded content of the TrustStore file.
String	getTrustStorePassword()	The TrustStore password.
String	getTrustStorePasswordSecretId()	The OCID of the Secret where the kafka TrustStore password is stored.
String	getTrustStoreSecretId()	The OCID of the Secret where the content of the TrustStore file is stored.
String	getUsername()	The username Oracle GoldenGate uses to connect the associated system of the given technology.
int	hashCode()
CreateKafkaConnectionDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.goldengate.model.CreateConnectionDetails

getClusterPlacementGroupId, getCompartmentId, getDefinedTags, getDescription, getDisplayName, getDoesUseSecretIds, getFreeformTags, getKeyId, getLocks, getNsgIds, getRoutingMethod, getSecurityAttributes, getSubnetId, getSubscriptionId, getVaultId

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateKafkaConnectionDetails

@Deprecated
public CreateKafkaConnectionDetails(String displayName,
                                    String description,
                                    String compartmentId,
                                    Map<String,String> freeformTags,
                                    Map<String,Map<String,Object>> definedTags,
                                    List<AddResourceLockDetails> locks,
                                    String vaultId,
                                    String keyId,
                                    List<String> nsgIds,
                                    String subnetId,
                                    RoutingMethod routingMethod,
                                    Boolean doesUseSecretIds,
                                    String subscriptionId,
                                    String clusterPlacementGroupId,
                                    Map<String,Map<String,Object>> securityAttributes,
                                    KafkaConnection.TechnologyType technologyType,
                                    String streamPoolId,
                                    String clusterId,
                                    List<KafkaBootstrapServer> bootstrapServers,
                                    KafkaConnection.SecurityProtocol securityProtocol,
                                    String username,
                                    String password,
                                    String passwordSecretId,
                                    String trustStore,
                                    String trustStoreSecretId,
                                    String trustStorePassword,
                                    String trustStorePasswordSecretId,
                                    String keyStore,
                                    String keyStoreSecretId,
                                    String keyStorePassword,
                                    String keyStorePasswordSecretId,
                                    String sslKeyPassword,
                                    String sslKeyPasswordSecretId,
                                    String consumerProperties,
                                    String producerProperties,
                                    Boolean shouldUseResourcePrincipal)

Deprecated.

Method Detail

builder

public static CreateKafkaConnectionDetails.Builder builder()

Create a new builder.

toBuilder

public CreateKafkaConnectionDetails.Builder toBuilder()

getTechnologyType

public KafkaConnection.TechnologyType getTechnologyType()

The Kafka technology type.

Returns:

the value

getStreamPoolId

public String getStreamPoolId()

The OCID of the stream pool being referenced.

Returns:

the value

getClusterId

public String getClusterId()

The OCID of the Kafka cluster being referenced from OCI Streaming with Apache Kafka.

Returns:

the value

getBootstrapServers

public List<KafkaBootstrapServer> getBootstrapServers()

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”

Returns:

the value

getSecurityProtocol

public KafkaConnection.SecurityProtocol getSecurityProtocol()

Security Type for Kafka.

Returns:

the value

getUsername

public String getUsername()

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.

Returns:

the value

getPassword

public String getPassword()

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. Deprecated: This field is deprecated and replaced by “passwordSecretId”. This field will be removed after February 15 2026.

Returns:

the value

getPasswordSecretId

public String getPasswordSecretId()

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.

Returns:

the value

getTrustStore

public String getTrustStore()

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.

Returns:

the value

getTrustStoreSecretId

public String getTrustStoreSecretId()

The OCID of the Secret where the content of the TrustStore file is stored.

Note: When provided, ‘trustStore’ field must not be provided.

Returns:

the value

getTrustStorePassword

public String getTrustStorePassword()

The TrustStore password.

Deprecated: This field is deprecated and replaced by “trustStorePasswordSecretId”. This field will be removed after February 15 2026.

Returns:

the value

getTrustStorePasswordSecretId

public String getTrustStorePasswordSecretId()

The OCID of the Secret where the kafka TrustStore password is stored.

Note: When provided, ‘trustStorePassword’ field must not be provided.

Returns:

the value

getKeyStore

public String getKeyStore()

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.

Returns:

the value

getKeyStoreSecretId

public String getKeyStoreSecretId()

The OCID of the Secret where the content of the KeyStore file is stored.

Note: When provided, ‘keyStore’ field must not be provided.

Returns:

the value

getKeyStorePassword

public String getKeyStorePassword()

The KeyStore password.

Deprecated: This field is deprecated and replaced by “keyStorePasswordSecretId”. This field will be removed after February 15 2026.

Returns:

the value

getKeyStorePasswordSecretId

public String getKeyStorePasswordSecretId()

The OCID of the Secret where the kafka KeyStore password is stored.

Note: When provided, ‘keyStorePassword’ field must not be provided.

Returns:

the value

getSslKeyPassword

public String getSslKeyPassword()

The password for the cert inside of 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.

Returns:

the value

getSslKeyPasswordSecretId

public String getSslKeyPasswordSecretId()

The OCID of the Secret where the kafka Ssl Key password is stored.

Note: When provided, ‘sslKeyPassword’ field must not be provided.

Returns:

the value

getConsumerProperties

public String getConsumerProperties()

The base64 encoded content of the consumer.properties file.

Returns:

the value

getProducerProperties

public String getProducerProperties()

The base64 encoded content of the producer.properties file.

Returns:

the value

getShouldUseResourcePrincipal

public Boolean getShouldUseResourcePrincipal()

Specifies that the user intends to authenticate to the instance using a resource principal.

Applicable only for OCI Streaming connections. Only available from 23.9.0.0.0 GoldenGate versions. Note: When specified, ‘username’/‘password’/‘passwordSecretId’ fields must not be provided. Default: false

Returns:

the value

toString

public String toString()

Overrides:

toString in class CreateConnectionDetails

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class CreateConnectionDetails

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class CreateConnectionDetails

hashCode

public int hashCode()

Overrides:

hashCode in class CreateConnectionDetails