CreateAzureDataLakeStorageConnectionDetails¶

class oci.golden_gate.models.CreateAzureDataLakeStorageConnectionDetails(**kwargs)¶

Bases: oci.golden_gate.models.create_connection_details.CreateConnectionDetails

The information about a new Azure Data Lake Storage 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
`account_key`	Gets the account_key of this CreateAzureDataLakeStorageConnectionDetails.
`account_name`	[Required] Gets the account_name of this CreateAzureDataLakeStorageConnectionDetails.
`authentication_type`	[Required] Gets the authentication_type of this CreateAzureDataLakeStorageConnectionDetails.
`azure_tenant_id`	Gets the azure_tenant_id of this CreateAzureDataLakeStorageConnectionDetails.
`client_id`	Gets the client_id of this CreateAzureDataLakeStorageConnectionDetails.
`client_secret`	Gets the client_secret of this CreateAzureDataLakeStorageConnectionDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateConnectionDetails.
`connection_type`	[Required] Gets the connection_type of this CreateConnectionDetails.
`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.
`endpoint`	Gets the endpoint of this CreateAzureDataLakeStorageConnectionDetails.
`freeform_tags`	Gets the freeform_tags of this CreateConnectionDetails.
`key_id`	Gets the key_id of this CreateConnectionDetails.
`locks`	Gets the locks of this CreateConnectionDetails.
`nsg_ids`	Gets the nsg_ids of this CreateConnectionDetails.
`routing_method`	Gets the routing_method of this CreateConnectionDetails.
`sas_token`	Gets the sas_token of this CreateAzureDataLakeStorageConnectionDetails.
`subnet_id`	Gets the subnet_id of this CreateConnectionDetails.
`technology_type`	[Required] Gets the technology_type of this CreateAzureDataLakeStorageConnectionDetails.
`vault_id`	Gets the vault_id of this CreateConnectionDetails.

Methods

`__init__`(**kwargs)	Initializes a new CreateAzureDataLakeStorageConnectionDetails 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 CreateAzureDataLakeStorageConnectionDetails object with values from keyword arguments. The default value of the connection_type attribute of this class is AZURE_DATA_LAKE_STORAGE 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 CreateAzureDataLakeStorageConnectionDetails. 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 CreateAzureDataLakeStorageConnectionDetails.
description (str) – The value to assign to the description property of this CreateAzureDataLakeStorageConnectionDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateAzureDataLakeStorageConnectionDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateAzureDataLakeStorageConnectionDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateAzureDataLakeStorageConnectionDetails.
locks (list[oci.golden_gate.models.AddResourceLockDetails]) – The value to assign to the locks property of this CreateAzureDataLakeStorageConnectionDetails.
vault_id (str) – The value to assign to the vault_id property of this CreateAzureDataLakeStorageConnectionDetails.
key_id (str) – The value to assign to the key_id property of this CreateAzureDataLakeStorageConnectionDetails.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this CreateAzureDataLakeStorageConnectionDetails.
subnet_id (str) – The value to assign to the subnet_id property of this CreateAzureDataLakeStorageConnectionDetails.
routing_method (str) – The value to assign to the routing_method property of this CreateAzureDataLakeStorageConnectionDetails. 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 CreateAzureDataLakeStorageConnectionDetails.
authentication_type (str) – The value to assign to the authentication_type property of this CreateAzureDataLakeStorageConnectionDetails.
account_name (str) – The value to assign to the account_name property of this CreateAzureDataLakeStorageConnectionDetails.
account_key (str) – The value to assign to the account_key property of this CreateAzureDataLakeStorageConnectionDetails.
sas_token (str) – The value to assign to the sas_token property of this CreateAzureDataLakeStorageConnectionDetails.
azure_tenant_id (str) – The value to assign to the azure_tenant_id property of this CreateAzureDataLakeStorageConnectionDetails.
client_id (str) – The value to assign to the client_id property of this CreateAzureDataLakeStorageConnectionDetails.
client_secret (str) – The value to assign to the client_secret property of this CreateAzureDataLakeStorageConnectionDetails.
endpoint (str) – The value to assign to the endpoint property of this CreateAzureDataLakeStorageConnectionDetails.

account_key¶

Gets the account_key of this CreateAzureDataLakeStorageConnectionDetails. Azure storage account key. This property is required when ‘authenticationType’ is set to ‘SHARED_KEY’. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ==

Returns:	The account_key of this CreateAzureDataLakeStorageConnectionDetails.
Return type:	str

account_name¶

[Required] Gets the account_name of this CreateAzureDataLakeStorageConnectionDetails. Sets the Azure storage account name.

Returns:	The account_name of this CreateAzureDataLakeStorageConnectionDetails.
Return type:	str

authentication_type¶

[Required] Gets the authentication_type of this CreateAzureDataLakeStorageConnectionDetails. Used authentication mechanism to access Azure Data Lake Storage.

Returns:	The authentication_type of this CreateAzureDataLakeStorageConnectionDetails.
Return type:	str

azure_tenant_id¶

Gets the azure_tenant_id of this CreateAzureDataLakeStorageConnectionDetails. Azure tenant ID of the application. This property is required when ‘authenticationType’ is set to ‘AZURE_ACTIVE_DIRECTORY’. e.g.: 14593954-d337-4a61-a364-9f758c64f97f

Returns:	The azure_tenant_id of this CreateAzureDataLakeStorageConnectionDetails.
Return type:	str

client_id¶

Gets the client_id of this CreateAzureDataLakeStorageConnectionDetails. Azure client ID of the application. This property is required when ‘authenticationType’ is set to ‘AZURE_ACTIVE_DIRECTORY’. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d

Returns:	The client_id of this CreateAzureDataLakeStorageConnectionDetails.
Return type:	str

client_secret¶

Gets the client_secret of this CreateAzureDataLakeStorageConnectionDetails. Azure client secret (aka application password) for authentication. This property is required when ‘authenticationType’ is set to ‘AZURE_ACTIVE_DIRECTORY’. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1

Returns:	The client_secret of this CreateAzureDataLakeStorageConnectionDetails.
Return type:	str

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

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

endpoint¶

Gets the endpoint of this CreateAzureDataLakeStorageConnectionDetails. Azure Storage service endpoint. e.g: https://test.blob.core.windows.net

Returns:	The endpoint of this CreateAzureDataLakeStorageConnectionDetails.
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

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]

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

sas_token¶

Gets the sas_token of this CreateAzureDataLakeStorageConnectionDetails. Credential that uses a shared access signature (SAS) to authenticate to an Azure Service. This property is required when ‘authenticationType’ is set to ‘SHARED_ACCESS_SIGNATURE’. e.g.: ?sv=2020-06-08&ss=bfqt&srt=sco&sp=rwdlacupyx&se=2020-09-10T20:27:28Z&st=2022-08-05T12:27:28Z&spr=https&sig=C1IgHsiLBmTSStYkXXGLTP8it0xBrArcgCqOsZbXwIQ%3D

Returns:	The sas_token of this CreateAzureDataLakeStorageConnectionDetails.
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 CreateAzureDataLakeStorageConnectionDetails. The Azure Data Lake Storage technology type.

Returns:	The technology_type of this CreateAzureDataLakeStorageConnectionDetails.
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