CreateKafkaConnectionDetails

class oci.golden_gate.models.CreateKafkaConnectionDetails(**kwargs)

Bases: oci.golden_gate.models.create_connection_details.CreateConnectionDetails

The information about a new Kafka Connection.

Attributes

CONNECTION_TYPE_AMAZON_KINESIS str(object=’’) -> str
CONNECTION_TYPE_AMAZON_REDSHIFT str(object=’’) -> str
CONNECTION_TYPE_AMAZON_S3 str(object=’’) -> str
CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE str(object=’’) -> str
CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS str(object=’’) -> str
CONNECTION_TYPE_DB2 str(object=’’) -> str
CONNECTION_TYPE_ELASTICSEARCH str(object=’’) -> str
CONNECTION_TYPE_GENERIC str(object=’’) -> str
CONNECTION_TYPE_GOLDENGATE str(object=’’) -> str
CONNECTION_TYPE_GOOGLE_BIGQUERY str(object=’’) -> str
CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE str(object=’’) -> str
CONNECTION_TYPE_HDFS str(object=’’) -> str
CONNECTION_TYPE_JAVA_MESSAGE_SERVICE str(object=’’) -> str
CONNECTION_TYPE_KAFKA str(object=’’) -> str
CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY str(object=’’) -> str
CONNECTION_TYPE_MICROSOFT_SQLSERVER str(object=’’) -> str
CONNECTION_TYPE_MONGODB str(object=’’) -> str
CONNECTION_TYPE_MYSQL str(object=’’) -> str
CONNECTION_TYPE_OCI_OBJECT_STORAGE str(object=’’) -> str
CONNECTION_TYPE_ORACLE str(object=’’) -> str
CONNECTION_TYPE_ORACLE_NOSQL str(object=’’) -> str
CONNECTION_TYPE_POSTGRESQL str(object=’’) -> str
CONNECTION_TYPE_REDIS str(object=’’) -> str
CONNECTION_TYPE_SNOWFLAKE str(object=’’) -> str
ROUTING_METHOD_DEDICATED_ENDPOINT str(object=’’) -> str
ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT str(object=’’) -> str
ROUTING_METHOD_SHARED_SERVICE_ENDPOINT str(object=’’) -> str
bootstrap_servers Gets the bootstrap_servers of this CreateKafkaConnectionDetails.
compartment_id [Required] Gets the compartment_id of this CreateConnectionDetails.
connection_type [Required] Gets the connection_type of this CreateConnectionDetails.
consumer_properties Gets the consumer_properties of this CreateKafkaConnectionDetails.
defined_tags Gets the defined_tags of this CreateConnectionDetails.
description Gets the description of this CreateConnectionDetails.
display_name [Required] Gets the display_name of this CreateConnectionDetails.
freeform_tags Gets the freeform_tags of this CreateConnectionDetails.
key_id Gets the key_id of this CreateConnectionDetails.
key_store Gets the key_store of this CreateKafkaConnectionDetails.
key_store_password Gets the key_store_password of this CreateKafkaConnectionDetails.
locks Gets the locks of this CreateConnectionDetails.
nsg_ids Gets the nsg_ids of this CreateConnectionDetails.
password Gets the password of this CreateKafkaConnectionDetails.
producer_properties Gets the producer_properties of this CreateKafkaConnectionDetails.
routing_method Gets the routing_method of this CreateConnectionDetails.
security_protocol Gets the security_protocol of this CreateKafkaConnectionDetails.
ssl_key_password Gets the ssl_key_password of this CreateKafkaConnectionDetails.
stream_pool_id Gets the stream_pool_id of this CreateKafkaConnectionDetails.
subnet_id Gets the subnet_id of this CreateConnectionDetails.
technology_type [Required] Gets the technology_type of this CreateKafkaConnectionDetails.
trust_store Gets the trust_store of this CreateKafkaConnectionDetails.
trust_store_password Gets the trust_store_password of this CreateKafkaConnectionDetails.
username Gets the username of this CreateKafkaConnectionDetails.
vault_id Gets the vault_id of this CreateConnectionDetails.

Methods

__init__(**kwargs) Initializes a new CreateKafkaConnectionDetails object with values from keyword arguments.
get_subtype(object_dictionary) Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
CONNECTION_TYPE_AMAZON_KINESIS = 'AMAZON_KINESIS'
CONNECTION_TYPE_AMAZON_REDSHIFT = 'AMAZON_REDSHIFT'
CONNECTION_TYPE_AMAZON_S3 = 'AMAZON_S3'
CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE = 'AZURE_DATA_LAKE_STORAGE'
CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS = 'AZURE_SYNAPSE_ANALYTICS'
CONNECTION_TYPE_DB2 = 'DB2'
CONNECTION_TYPE_ELASTICSEARCH = 'ELASTICSEARCH'
CONNECTION_TYPE_GENERIC = 'GENERIC'
CONNECTION_TYPE_GOLDENGATE = 'GOLDENGATE'
CONNECTION_TYPE_GOOGLE_BIGQUERY = 'GOOGLE_BIGQUERY'
CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE = 'GOOGLE_CLOUD_STORAGE'
CONNECTION_TYPE_HDFS = 'HDFS'
CONNECTION_TYPE_JAVA_MESSAGE_SERVICE = 'JAVA_MESSAGE_SERVICE'
CONNECTION_TYPE_KAFKA = 'KAFKA'
CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY = 'KAFKA_SCHEMA_REGISTRY'
CONNECTION_TYPE_MICROSOFT_SQLSERVER = 'MICROSOFT_SQLSERVER'
CONNECTION_TYPE_MONGODB = 'MONGODB'
CONNECTION_TYPE_MYSQL = 'MYSQL'
CONNECTION_TYPE_OCI_OBJECT_STORAGE = 'OCI_OBJECT_STORAGE'
CONNECTION_TYPE_ORACLE = 'ORACLE'
CONNECTION_TYPE_ORACLE_NOSQL = 'ORACLE_NOSQL'
CONNECTION_TYPE_POSTGRESQL = 'POSTGRESQL'
CONNECTION_TYPE_REDIS = 'REDIS'
CONNECTION_TYPE_SNOWFLAKE = 'SNOWFLAKE'
ROUTING_METHOD_DEDICATED_ENDPOINT = 'DEDICATED_ENDPOINT'
ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT = 'SHARED_DEPLOYMENT_ENDPOINT'
ROUTING_METHOD_SHARED_SERVICE_ENDPOINT = 'SHARED_SERVICE_ENDPOINT'
__init__(**kwargs)

Initializes a new CreateKafkaConnectionDetails object with values from keyword arguments. The default value of the connection_type attribute of this class is KAFKA and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • connection_type (str) – The value to assign to the connection_type property of this CreateKafkaConnectionDetails. Allowed values for this property are: “GOLDENGATE”, “KAFKA”, “KAFKA_SCHEMA_REGISTRY”, “MYSQL”, “JAVA_MESSAGE_SERVICE”, “MICROSOFT_SQLSERVER”, “OCI_OBJECT_STORAGE”, “ORACLE”, “AZURE_DATA_LAKE_STORAGE”, “POSTGRESQL”, “AZURE_SYNAPSE_ANALYTICS”, “SNOWFLAKE”, “AMAZON_S3”, “HDFS”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”
  • display_name (str) – The value to assign to the display_name property of this CreateKafkaConnectionDetails.
  • description (str) – The value to assign to the description property of this CreateKafkaConnectionDetails.
  • compartment_id (str) – The value to assign to the compartment_id property of this CreateKafkaConnectionDetails.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateKafkaConnectionDetails.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateKafkaConnectionDetails.
  • locks (list[oci.golden_gate.models.AddResourceLockDetails]) – The value to assign to the locks property of this CreateKafkaConnectionDetails.
  • vault_id (str) – The value to assign to the vault_id property of this CreateKafkaConnectionDetails.
  • key_id (str) – The value to assign to the key_id property of this CreateKafkaConnectionDetails.
  • nsg_ids (list[str]) – The value to assign to the nsg_ids property of this CreateKafkaConnectionDetails.
  • subnet_id (str) – The value to assign to the subnet_id property of this CreateKafkaConnectionDetails.
  • routing_method (str) – The value to assign to the routing_method property of this CreateKafkaConnectionDetails. Allowed values for this property are: “SHARED_SERVICE_ENDPOINT”, “SHARED_DEPLOYMENT_ENDPOINT”, “DEDICATED_ENDPOINT”
  • technology_type (str) – The value to assign to the technology_type property of this CreateKafkaConnectionDetails.
  • stream_pool_id (str) – The value to assign to the stream_pool_id property of this CreateKafkaConnectionDetails.
  • bootstrap_servers (list[oci.golden_gate.models.KafkaBootstrapServer]) – The value to assign to the bootstrap_servers property of this CreateKafkaConnectionDetails.
  • security_protocol (str) – The value to assign to the security_protocol property of this CreateKafkaConnectionDetails.
  • username (str) – The value to assign to the username property of this CreateKafkaConnectionDetails.
  • password (str) – The value to assign to the password property of this CreateKafkaConnectionDetails.
  • trust_store (str) – The value to assign to the trust_store property of this CreateKafkaConnectionDetails.
  • trust_store_password (str) – The value to assign to the trust_store_password property of this CreateKafkaConnectionDetails.
  • key_store (str) – The value to assign to the key_store property of this CreateKafkaConnectionDetails.
  • key_store_password (str) – The value to assign to the key_store_password property of this CreateKafkaConnectionDetails.
  • ssl_key_password (str) – The value to assign to the ssl_key_password property of this CreateKafkaConnectionDetails.
  • consumer_properties (str) – The value to assign to the consumer_properties property of this CreateKafkaConnectionDetails.
  • producer_properties (str) – The value to assign to the producer_properties property of this CreateKafkaConnectionDetails.
bootstrap_servers

Gets the bootstrap_servers of this CreateKafkaConnectionDetails. 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 bootstrap_servers of this CreateKafkaConnectionDetails.
Return type:list[oci.golden_gate.models.KafkaBootstrapServer]
compartment_id

[Required] Gets the compartment_id of this CreateConnectionDetails. The OCID of the compartment being referenced.

Returns:The compartment_id of this CreateConnectionDetails.
Return type:str
connection_type

[Required] Gets the connection_type of this CreateConnectionDetails. The connection type.

Allowed values for this property are: “GOLDENGATE”, “KAFKA”, “KAFKA_SCHEMA_REGISTRY”, “MYSQL”, “JAVA_MESSAGE_SERVICE”, “MICROSOFT_SQLSERVER”, “OCI_OBJECT_STORAGE”, “ORACLE”, “AZURE_DATA_LAKE_STORAGE”, “POSTGRESQL”, “AZURE_SYNAPSE_ANALYTICS”, “SNOWFLAKE”, “AMAZON_S3”, “HDFS”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”

Returns:The connection_type of this CreateConnectionDetails.
Return type:str
consumer_properties

Gets the consumer_properties of this CreateKafkaConnectionDetails. The base64 encoded content of the consumer.properties file.

Returns:The consumer_properties of this CreateKafkaConnectionDetails.
Return type:str
defined_tags

Gets the defined_tags of this CreateConnectionDetails. Tags defined for this resource. Each key is predefined and scoped to a namespace.

Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:The defined_tags of this CreateConnectionDetails.
Return type:dict(str, dict(str, object))
description

Gets the description of this CreateConnectionDetails. Metadata about this specific object.

Returns:The description of this CreateConnectionDetails.
Return type:str
display_name

[Required] Gets the display_name of this CreateConnectionDetails. An object’s Display Name.

Returns:The display_name of this CreateConnectionDetails.
Return type:str
freeform_tags

Gets the freeform_tags of this CreateConnectionDetails. A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.

Example: {“bar-key”: “value”}

Returns:The freeform_tags of this CreateConnectionDetails.
Return type:dict(str, str)
static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

key_id

Gets the key_id of this CreateConnectionDetails. Refers to the customer’s master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.

Returns:The key_id of this CreateConnectionDetails.
Return type:str
key_store

Gets the key_store of this CreateKafkaConnectionDetails. The base64 encoded content of the KeyStore file.

Returns:The key_store of this CreateKafkaConnectionDetails.
Return type:str
key_store_password

Gets the key_store_password of this CreateKafkaConnectionDetails. The KeyStore password.

Returns:The key_store_password of this CreateKafkaConnectionDetails.
Return type:str
locks

Gets the locks of this CreateConnectionDetails. Locks associated with this resource.

Returns:The locks of this CreateConnectionDetails.
Return type:list[oci.golden_gate.models.AddResourceLockDetails]
nsg_ids

Gets the nsg_ids of this CreateConnectionDetails. An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

Returns:The nsg_ids of this CreateConnectionDetails.
Return type:list[str]
password

Gets the password of this CreateKafkaConnectionDetails. 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.

Returns:The password of this CreateKafkaConnectionDetails.
Return type:str
producer_properties

Gets the producer_properties of this CreateKafkaConnectionDetails. The base64 encoded content of the producer.properties file.

Returns:The producer_properties of this CreateKafkaConnectionDetails.
Return type:str
routing_method

Gets the routing_method of this CreateConnectionDetails. Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service’s network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment’s private endpoint through the deployment’s subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.

Allowed values for this property are: “SHARED_SERVICE_ENDPOINT”, “SHARED_DEPLOYMENT_ENDPOINT”, “DEDICATED_ENDPOINT”

Returns:The routing_method of this CreateConnectionDetails.
Return type:str
security_protocol

Gets the security_protocol of this CreateKafkaConnectionDetails. Security Type for Kafka.

Returns:The security_protocol of this CreateKafkaConnectionDetails.
Return type:str
ssl_key_password

Gets the ssl_key_password of this CreateKafkaConnectionDetails. The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided.

Returns:The ssl_key_password of this CreateKafkaConnectionDetails.
Return type:str
stream_pool_id

Gets the stream_pool_id of this CreateKafkaConnectionDetails. The OCID of the stream pool being referenced.

Returns:The stream_pool_id of this CreateKafkaConnectionDetails.
Return type:str
subnet_id

Gets the subnet_id of this CreateConnectionDetails. The OCID of the target subnet of the dedicated connection.

Returns:The subnet_id of this CreateConnectionDetails.
Return type:str
technology_type

[Required] Gets the technology_type of this CreateKafkaConnectionDetails. The Kafka technology type.

Returns:The technology_type of this CreateKafkaConnectionDetails.
Return type:str
trust_store

Gets the trust_store of this CreateKafkaConnectionDetails. The base64 encoded content of the TrustStore file.

Returns:The trust_store of this CreateKafkaConnectionDetails.
Return type:str
trust_store_password

Gets the trust_store_password of this CreateKafkaConnectionDetails. The TrustStore password.

Returns:The trust_store_password of this CreateKafkaConnectionDetails.
Return type:str
username

Gets the username of this CreateKafkaConnectionDetails. 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 username of this CreateKafkaConnectionDetails.
Return type:str
vault_id

Gets the vault_id of this CreateConnectionDetails. Refers to the customer’s vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.

Returns:The vault_id of this CreateConnectionDetails.
Return type:str