/** * GoldenGate API * Use the Oracle Cloud Infrastructure GoldenGate APIs to perform data replication operations. * OpenAPI spec version: 20200407 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ import * as model from "../model"; /** * Represents the metadata of a Kafka Connection. * */ export interface KafkaConnection extends model.Connection { /** * The Kafka technology type. * */ "technologyType": KafkaConnection.TechnologyType; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream pool being referenced. * */ "streamPoolId"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Kafka cluster * being referenced from OCI Streaming with Apache Kafka. * */ "clusterId"?: string; /** * 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: {@code \"server1.example.com:9092,server2.example.com:9092\"} * */ "bootstrapServers"?: Array; /** * Kafka security protocol. * */ "securityProtocol"?: KafkaConnection.SecurityProtocol; /** * 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. * */ "username"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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. * */ "passwordSecretId"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the TrustStore file is stored. * Note: When provided, 'trustStore' field must not be provided. * */ "trustStoreSecretId"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka TrustStore password is stored. * Note: When provided, 'trustStorePassword' field must not be provided. * */ "trustStorePasswordSecretId"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the KeyStore file is stored. * Note: When provided, 'keyStore' field must not be provided. * */ "keyStoreSecretId"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka KeyStore password is stored. * Note: When provided, 'keyStorePassword' field must not be provided. * */ "keyStorePasswordSecretId"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka Ssl Key password is stored. * Note: When provided, 'sslKeyPassword' field must not be provided. * */ "sslKeyPasswordSecretId"?: string; /** * The base64 encoded content of the consumer.properties file. * */ "consumerProperties"?: string; /** * The base64 encoded content of the producer.properties file. * */ "producerProperties"?: string; /** * 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 * */ "shouldUseResourcePrincipal"?: boolean; "connectionType": string; } export declare namespace KafkaConnection { enum TechnologyType { ApacheKafka = "APACHE_KAFKA", AzureEventHubs = "AZURE_EVENT_HUBS", ConfluentKafka = "CONFLUENT_KAFKA", MicrosoftFabricEventstream = "MICROSOFT_FABRIC_EVENTSTREAM", OciStreaming = "OCI_STREAMING", OciStreamingWithApacheKafka = "OCI_STREAMING_WITH_APACHE_KAFKA", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum SecurityProtocol { Ssl = "SSL", SaslSsl = "SASL_SSL", Plaintext = "PLAINTEXT", SaslPlaintext = "SASL_PLAINTEXT", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } function getJsonObj(obj: KafkaConnection, isParentJsonObj?: boolean): object; const connectionType = "KAFKA"; function getDeserializedJsonObj(obj: KafkaConnection, isParentJsonObj?: boolean): object; }