Connection

class oci.data_integration.models.Connection(**kwargs)

Bases: object

The connection for a data asset.

Attributes

MODEL_TYPE_AMAZON_S3_CONNECTION	A constant which can be used with the model_type property of a Connection.
MODEL_TYPE_BICC_CONNECTION	A constant which can be used with the model_type property of a Connection.
MODEL_TYPE_BIP_CONNECTION	A constant which can be used with the model_type property of a Connection.
MODEL_TYPE_GENERIC_JDBC_CONNECTION	A constant which can be used with the model_type property of a Connection.
MODEL_TYPE_HDFS_CONNECTION	A constant which can be used with the model_type property of a Connection.
MODEL_TYPE_LAKE_CONNECTION	A constant which can be used with the model_type property of a Connection.
MODEL_TYPE_MYSQL_CONNECTION	A constant which can be used with the model_type property of a Connection.
MODEL_TYPE_MYSQL_HEATWAVE_CONNECTION	A constant which can be used with the model_type property of a Connection.
MODEL_TYPE_OAUTH2_CONNECTION	A constant which can be used with the model_type property of a Connection.
MODEL_TYPE_ORACLEDB_CONNECTION	A constant which can be used with the model_type property of a Connection.
MODEL_TYPE_ORACLE_ADWC_CONNECTION	A constant which can be used with the model_type property of a Connection.
MODEL_TYPE_ORACLE_ATP_CONNECTION	A constant which can be used with the model_type property of a Connection.
MODEL_TYPE_ORACLE_EBS_CONNECTION	A constant which can be used with the model_type property of a Connection.
MODEL_TYPE_ORACLE_OBJECT_STORAGE_CONNECTION	A constant which can be used with the model_type property of a Connection.
MODEL_TYPE_ORACLE_PEOPLESOFT_CONNECTION	A constant which can be used with the model_type property of a Connection.
MODEL_TYPE_ORACLE_SIEBEL_CONNECTION	A constant which can be used with the model_type property of a Connection.
MODEL_TYPE_REST_BASIC_AUTH_CONNECTION	A constant which can be used with the model_type property of a Connection.
MODEL_TYPE_REST_NO_AUTH_CONNECTION	A constant which can be used with the model_type property of a Connection.
connection_properties	Gets the connection_properties of this Connection.
description	Gets the description of this Connection.
identifier	Gets the identifier of this Connection.
is_default	Gets the is_default of this Connection.
key	Gets the key of this Connection.
key_map	Gets the key_map of this Connection.
metadata	Gets the metadata of this Connection.
model_type	[Required] Gets the model_type of this Connection.
model_version	Gets the model_version of this Connection.
name	Gets the name of this Connection.
object_status	Gets the object_status of this Connection.
object_version	Gets the object_version of this Connection.
parent_ref	Gets the parent_ref of this Connection.
primary_schema	Gets the primary_schema of this Connection.

Methods

__init__(**kwargs)	Initializes a new Connection 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.

MODEL_TYPE_AMAZON_S3_CONNECTION = 'AMAZON_S3_CONNECTION'

A constant which can be used with the model_type property of a Connection. This constant has a value of “AMAZON_S3_CONNECTION”

MODEL_TYPE_BICC_CONNECTION = 'BICC_CONNECTION'

A constant which can be used with the model_type property of a Connection. This constant has a value of “BICC_CONNECTION”

MODEL_TYPE_BIP_CONNECTION = 'BIP_CONNECTION'

A constant which can be used with the model_type property of a Connection. This constant has a value of “BIP_CONNECTION”

MODEL_TYPE_GENERIC_JDBC_CONNECTION = 'GENERIC_JDBC_CONNECTION'

A constant which can be used with the model_type property of a Connection. This constant has a value of “GENERIC_JDBC_CONNECTION”

MODEL_TYPE_HDFS_CONNECTION = 'HDFS_CONNECTION'

A constant which can be used with the model_type property of a Connection. This constant has a value of “HDFS_CONNECTION”

MODEL_TYPE_LAKE_CONNECTION = 'LAKE_CONNECTION'

A constant which can be used with the model_type property of a Connection. This constant has a value of “LAKE_CONNECTION”

MODEL_TYPE_MYSQL_CONNECTION = 'MYSQL_CONNECTION'

A constant which can be used with the model_type property of a Connection. This constant has a value of “MYSQL_CONNECTION”

MODEL_TYPE_MYSQL_HEATWAVE_CONNECTION = 'MYSQL_HEATWAVE_CONNECTION'

A constant which can be used with the model_type property of a Connection. This constant has a value of “MYSQL_HEATWAVE_CONNECTION”

MODEL_TYPE_OAUTH2_CONNECTION = 'OAUTH2_CONNECTION'

A constant which can be used with the model_type property of a Connection. This constant has a value of “OAUTH2_CONNECTION”

MODEL_TYPE_ORACLEDB_CONNECTION = 'ORACLEDB_CONNECTION'

A constant which can be used with the model_type property of a Connection. This constant has a value of “ORACLEDB_CONNECTION”

MODEL_TYPE_ORACLE_ADWC_CONNECTION = 'ORACLE_ADWC_CONNECTION'

A constant which can be used with the model_type property of a Connection. This constant has a value of “ORACLE_ADWC_CONNECTION”

MODEL_TYPE_ORACLE_ATP_CONNECTION = 'ORACLE_ATP_CONNECTION'

A constant which can be used with the model_type property of a Connection. This constant has a value of “ORACLE_ATP_CONNECTION”

MODEL_TYPE_ORACLE_EBS_CONNECTION = 'ORACLE_EBS_CONNECTION'

A constant which can be used with the model_type property of a Connection. This constant has a value of “ORACLE_EBS_CONNECTION”

MODEL_TYPE_ORACLE_OBJECT_STORAGE_CONNECTION = 'ORACLE_OBJECT_STORAGE_CONNECTION'

A constant which can be used with the model_type property of a Connection. This constant has a value of “ORACLE_OBJECT_STORAGE_CONNECTION”

MODEL_TYPE_ORACLE_PEOPLESOFT_CONNECTION = 'ORACLE_PEOPLESOFT_CONNECTION'

A constant which can be used with the model_type property of a Connection. This constant has a value of “ORACLE_PEOPLESOFT_CONNECTION”

MODEL_TYPE_ORACLE_SIEBEL_CONNECTION = 'ORACLE_SIEBEL_CONNECTION'

A constant which can be used with the model_type property of a Connection. This constant has a value of “ORACLE_SIEBEL_CONNECTION”

MODEL_TYPE_REST_BASIC_AUTH_CONNECTION = 'REST_BASIC_AUTH_CONNECTION'

A constant which can be used with the model_type property of a Connection. This constant has a value of “REST_BASIC_AUTH_CONNECTION”

MODEL_TYPE_REST_NO_AUTH_CONNECTION = 'REST_NO_AUTH_CONNECTION'

A constant which can be used with the model_type property of a Connection. This constant has a value of “REST_NO_AUTH_CONNECTION”

__init__(**kwargs)

Initializes a new Connection object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

• ConnectionFromAmazonS3
• ConnectionFromBIP
• ConnectionFromMySQL
• ConnectionFromOAuth2
• ConnectionFromJdbc
• ConnectionFromBICC
• ConnectionFromMySqlHeatWave
• ConnectionFromRestBasicAuth
• ConnectionFromObjectStorage
• ConnectionFromAdwc
• ConnectionFromAtp
• ConnectionFromOracle
• ConnectionFromOraclePeopleSoft
• ConnectionFromHdfs
• ConnectionFromOracleEbs
• ConnectionFromOracleSiebel
• ConnectionFromRestNoAuth
• ConnectionFromLake

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

• model_type (str) – The value to assign to the model_type property of this Connection. Allowed values for this property are: “ORACLE_ADWC_CONNECTION”, “ORACLE_ATP_CONNECTION”, “ORACLE_OBJECT_STORAGE_CONNECTION”, “ORACLEDB_CONNECTION”, “MYSQL_CONNECTION”, “GENERIC_JDBC_CONNECTION”, “BICC_CONNECTION”, “AMAZON_S3_CONNECTION”, “BIP_CONNECTION”, “LAKE_CONNECTION”, “ORACLE_PEOPLESOFT_CONNECTION”, “ORACLE_EBS_CONNECTION”, “ORACLE_SIEBEL_CONNECTION”, “HDFS_CONNECTION”, “MYSQL_HEATWAVE_CONNECTION”, “REST_NO_AUTH_CONNECTION”, “REST_BASIC_AUTH_CONNECTION”, “OAUTH2_CONNECTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
• key (str) – The value to assign to the key property of this Connection.
• model_version (str) – The value to assign to the model_version property of this Connection.
• parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this Connection.
• name (str) – The value to assign to the name property of this Connection.
• description (str) – The value to assign to the description property of this Connection.
• object_version (int) – The value to assign to the object_version property of this Connection.
• object_status (int) – The value to assign to the object_status property of this Connection.
• identifier (str) – The value to assign to the identifier property of this Connection.
• primary_schema (oci.data_integration.models.Schema) – The value to assign to the primary_schema property of this Connection.
• connection_properties (list[oci.data_integration.models.ConnectionProperty]) – The value to assign to the connection_properties property of this Connection.
• is_default (bool) – The value to assign to the is_default property of this Connection.
• metadata (oci.data_integration.models.ObjectMetadata) – The value to assign to the metadata property of this Connection.
• key_map (dict(str, str)) – The value to assign to the key_map property of this Connection.

connection_properties

Gets the connection_properties of this Connection. The properties for the connection.

Returns:The connection_properties of this Connection. Return type:list[oci.data_integration.models.ConnectionProperty]

description

Gets the description of this Connection. User-defined description for the connection.

Returns:The description of this Connection. Return type: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.

identifier

Gets the identifier of this Connection. Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.

Returns:The identifier of this Connection. Return type:str

is_default

Gets the is_default of this Connection. The default property for the connection.

Returns:The is_default of this Connection. Return type:bool

key

Gets the key of this Connection. Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create.

Returns:The key of this Connection. Return type:str

key_map

Gets the key_map of this Connection. A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key.

Returns:The key_map of this Connection. Return type:dict(str, str)

metadata

Gets the metadata of this Connection.

Returns:The metadata of this Connection. Return type:oci.data_integration.models.ObjectMetadata

model_type

[Required] Gets the model_type of this Connection. The type of the connection.

Allowed values for this property are: “ORACLE_ADWC_CONNECTION”, “ORACLE_ATP_CONNECTION”, “ORACLE_OBJECT_STORAGE_CONNECTION”, “ORACLEDB_CONNECTION”, “MYSQL_CONNECTION”, “GENERIC_JDBC_CONNECTION”, “BICC_CONNECTION”, “AMAZON_S3_CONNECTION”, “BIP_CONNECTION”, “LAKE_CONNECTION”, “ORACLE_PEOPLESOFT_CONNECTION”, “ORACLE_EBS_CONNECTION”, “ORACLE_SIEBEL_CONNECTION”, “HDFS_CONNECTION”, “MYSQL_HEATWAVE_CONNECTION”, “REST_NO_AUTH_CONNECTION”, “REST_BASIC_AUTH_CONNECTION”, “OAUTH2_CONNECTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The model_type of this Connection. Return type:str

model_version

Gets the model_version of this Connection. The model version of an object.

Returns:The model_version of this Connection. Return type:str

name

Gets the name of this Connection. Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Returns:The name of this Connection. Return type:str

object_status

Gets the object_status of this Connection. The status of an object that can be set to value 1 for shallow references across objects, other values reserved.

Returns:The object_status of this Connection. Return type:int

object_version

Gets the object_version of this Connection. The version of the object that is used to track changes in the object instance.

Returns:The object_version of this Connection. Return type:int

parent_ref

Gets the parent_ref of this Connection.

Returns:The parent_ref of this Connection. Return type:oci.data_integration.models.ParentReference

primary_schema

Gets the primary_schema of this Connection.

Returns:The primary_schema of this Connection. Return type:oci.data_integration.models.Schema