Package com.oracle.bmc.goldengate.model

Class 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).

    • Method Detail

      • 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

      • 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

      • 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​(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