Package com.oracle.bmc.goldengate.model

Class KafkaConnection

java.lang.Object

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

com.oracle.bmc.goldengate.model.Connection

com.oracle.bmc.goldengate.model.KafkaConnection

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

Represents the metadata of a Kafka Connection.
Note: Objects should always be created or deserialized using the KafkaConnection.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 KafkaConnection.Builder, which maintain a set of all explicitly set fields called KafkaConnection.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	KafkaConnection.Builder
static class	KafkaConnection.SecurityProtocol	Kafka security protocol.
static class	KafkaConnection.TechnologyType	The Kafka technology type.

Nested classes/interfaces inherited from class com.oracle.bmc.goldengate.model.Connection

Connection.LifecycleState

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

KafkaConnection(String id, String displayName, String description, String compartmentId, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags, Connection.LifecycleState lifecycleState, String lifecycleDetails, Date timeCreated, Date timeUpdated, List<ResourceLock> locks, String vaultId, String keyId, List<IngressIpDetails> ingressIps, List<String> nsgIds, String subnetId, RoutingMethod routingMethod, Boolean doesUseSecretIds, KafkaConnection.TechnologyType technologyType, String streamPoolId, List<KafkaBootstrapServer> bootstrapServers, KafkaConnection.SecurityProtocol securityProtocol, String username, String passwordSecretId, String trustStoreSecretId, String trustStorePasswordSecretId, String keyStoreSecretId, String keyStorePasswordSecretId, String sslKeyPasswordSecretId, String consumerProperties, String producerProperties)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static KafkaConnection.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<KafkaBootstrapServer>	getBootstrapServers()	Kafka bootstrap.
String	getConsumerProperties()	The base64 encoded content of the consumer.properties file.
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	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()	Kafka security protocol.
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	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()
KafkaConnection.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

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

getCompartmentId, getDefinedTags, getDescription, getDisplayName, getDoesUseSecretIds, getFreeformTags, getId, getIngressIps, getKeyId, getLifecycleDetails, getLifecycleState, getLocks, getNsgIds, getRoutingMethod, getSubnetId, getSystemTags, getTimeCreated, getTimeUpdated, 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

KafkaConnection

@Deprecated
public KafkaConnection(String id,
                       String displayName,
                       String description,
                       String compartmentId,
                       Map<String,String> freeformTags,
                       Map<String,Map<String,Object>> definedTags,
                       Map<String,Map<String,Object>> systemTags,
                       Connection.LifecycleState lifecycleState,
                       String lifecycleDetails,
                       Date timeCreated,
                       Date timeUpdated,
                       List<ResourceLock> locks,
                       String vaultId,
                       String keyId,
                       List<IngressIpDetails> ingressIps,
                       List<String> nsgIds,
                       String subnetId,
                       RoutingMethod routingMethod,
                       Boolean doesUseSecretIds,
                       KafkaConnection.TechnologyType technologyType,
                       String streamPoolId,
                       List<KafkaBootstrapServer> bootstrapServers,
                       KafkaConnection.SecurityProtocol securityProtocol,
                       String username,
                       String passwordSecretId,
                       String trustStoreSecretId,
                       String trustStorePasswordSecretId,
                       String keyStoreSecretId,
                       String keyStorePasswordSecretId,
                       String sslKeyPasswordSecretId,
                       String consumerProperties,
                       String producerProperties)

Deprecated.

Method Detail

builder

public static KafkaConnection.Builder builder()

Create a new builder.

toBuilder

public KafkaConnection.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

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()

Kafka security protocol.

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

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

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

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

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

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

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

toString

public String toString()

Overrides:

toString in class Connection

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class Connection

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class Connection

hashCode

public int hashCode()

Overrides:

hashCode in class Connection