CreateConnectionFromOAuth2¶

class oci.data_integration.models.CreateConnectionFromOAuth2(**kwargs)¶

Bases: oci.data_integration.models.create_connection_details.CreateConnectionDetails

The details to create a OAuth2 connection

Attributes

`GRANT_TYPE_CLIENT_CREDENTIALS`	A constant which can be used with the grant_type property of a CreateConnectionFromOAuth2.
`MODEL_TYPE_AMAZON_S3_CONNECTION`	str(object=’’) -> str
`MODEL_TYPE_BICC_CONNECTION`	str(object=’’) -> str
`MODEL_TYPE_BIP_CONNECTION`	str(object=’’) -> str
`MODEL_TYPE_GENERIC_JDBC_CONNECTION`	str(object=’’) -> str
`MODEL_TYPE_HDFS_CONNECTION`	str(object=’’) -> str
`MODEL_TYPE_LAKE_CONNECTION`	str(object=’’) -> str
`MODEL_TYPE_MYSQL_CONNECTION`	str(object=’’) -> str
`MODEL_TYPE_MYSQL_HEATWAVE_CONNECTION`	str(object=’’) -> str
`MODEL_TYPE_OAUTH2_CONNECTION`	str(object=’’) -> str
`MODEL_TYPE_ORACLEDB_CONNECTION`	str(object=’’) -> str
`MODEL_TYPE_ORACLE_ADWC_CONNECTION`	str(object=’’) -> str
`MODEL_TYPE_ORACLE_ATP_CONNECTION`	str(object=’’) -> str
`MODEL_TYPE_ORACLE_EBS_CONNECTION`	str(object=’’) -> str
`MODEL_TYPE_ORACLE_OBJECT_STORAGE_CONNECTION`	str(object=’’) -> str
`MODEL_TYPE_ORACLE_PEOPLESOFT_CONNECTION`	str(object=’’) -> str
`MODEL_TYPE_ORACLE_SIEBEL_CONNECTION`	str(object=’’) -> str
`MODEL_TYPE_REST_BASIC_AUTH_CONNECTION`	str(object=’’) -> str
`MODEL_TYPE_REST_NO_AUTH_CONNECTION`	str(object=’’) -> str
`access_token_url`	[Required] Gets the access_token_url of this CreateConnectionFromOAuth2.
`client_id`	Gets the client_id of this CreateConnectionFromOAuth2.
`client_secret`	Gets the client_secret of this CreateConnectionFromOAuth2.
`connection_properties`	Gets the connection_properties of this CreateConnectionDetails.
`description`	Gets the description of this CreateConnectionDetails.
`grant_type`	Gets the grant_type of this CreateConnectionFromOAuth2.
`identifier`	[Required] Gets the identifier of this CreateConnectionDetails.
`key`	Gets the key of this CreateConnectionDetails.
`model_type`	Gets the model_type of this CreateConnectionDetails.
`model_version`	Gets the model_version of this CreateConnectionDetails.
`name`	[Required] Gets the name of this CreateConnectionDetails.
`object_status`	Gets the object_status of this CreateConnectionDetails.
`parent_ref`	Gets the parent_ref of this CreateConnectionDetails.
`registry_metadata`	Gets the registry_metadata of this CreateConnectionDetails.
`scope`	Gets the scope of this CreateConnectionFromOAuth2.

Methods

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

GRANT_TYPE_CLIENT_CREDENTIALS = 'CLIENT_CREDENTIALS'¶: A constant which can be used with the grant_type property of a CreateConnectionFromOAuth2. This constant has a value of “CLIENT_CREDENTIALS”

MODEL_TYPE_AMAZON_S3_CONNECTION = 'AMAZON_S3_CONNECTION'¶

MODEL_TYPE_BICC_CONNECTION = 'BICC_CONNECTION'¶

MODEL_TYPE_BIP_CONNECTION = 'BIP_CONNECTION'¶

MODEL_TYPE_GENERIC_JDBC_CONNECTION = 'GENERIC_JDBC_CONNECTION'¶

MODEL_TYPE_HDFS_CONNECTION = 'HDFS_CONNECTION'¶

MODEL_TYPE_LAKE_CONNECTION = 'LAKE_CONNECTION'¶

MODEL_TYPE_MYSQL_CONNECTION = 'MYSQL_CONNECTION'¶

MODEL_TYPE_MYSQL_HEATWAVE_CONNECTION = 'MYSQL_HEATWAVE_CONNECTION'¶

MODEL_TYPE_OAUTH2_CONNECTION = 'OAUTH2_CONNECTION'¶

MODEL_TYPE_ORACLEDB_CONNECTION = 'ORACLEDB_CONNECTION'¶

MODEL_TYPE_ORACLE_ADWC_CONNECTION = 'ORACLE_ADWC_CONNECTION'¶

MODEL_TYPE_ORACLE_ATP_CONNECTION = 'ORACLE_ATP_CONNECTION'¶

MODEL_TYPE_ORACLE_EBS_CONNECTION = 'ORACLE_EBS_CONNECTION'¶

MODEL_TYPE_ORACLE_OBJECT_STORAGE_CONNECTION = 'ORACLE_OBJECT_STORAGE_CONNECTION'¶

MODEL_TYPE_ORACLE_PEOPLESOFT_CONNECTION = 'ORACLE_PEOPLESOFT_CONNECTION'¶

MODEL_TYPE_ORACLE_SIEBEL_CONNECTION = 'ORACLE_SIEBEL_CONNECTION'¶

MODEL_TYPE_REST_BASIC_AUTH_CONNECTION = 'REST_BASIC_AUTH_CONNECTION'¶

MODEL_TYPE_REST_NO_AUTH_CONNECTION = 'REST_NO_AUTH_CONNECTION'¶

__init__(**kwargs)¶

Initializes a new CreateConnectionFromOAuth2 object with values from keyword arguments. The default value of the model_type attribute of this class is OAUTH2_CONNECTION and it should not be changed. 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 CreateConnectionFromOAuth2. 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”
key (str) – The value to assign to the key property of this CreateConnectionFromOAuth2.
model_version (str) – The value to assign to the model_version property of this CreateConnectionFromOAuth2.
parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this CreateConnectionFromOAuth2.
name (str) – The value to assign to the name property of this CreateConnectionFromOAuth2.
description (str) – The value to assign to the description property of this CreateConnectionFromOAuth2.
object_status (int) – The value to assign to the object_status property of this CreateConnectionFromOAuth2.
identifier (str) – The value to assign to the identifier property of this CreateConnectionFromOAuth2.
connection_properties (list[oci.data_integration.models.ConnectionProperty]) – The value to assign to the connection_properties property of this CreateConnectionFromOAuth2.
registry_metadata (oci.data_integration.models.RegistryMetadata) – The value to assign to the registry_metadata property of this CreateConnectionFromOAuth2.
access_token_url (str) – The value to assign to the access_token_url property of this CreateConnectionFromOAuth2.
client_id (str) – The value to assign to the client_id property of this CreateConnectionFromOAuth2.
client_secret (oci.data_integration.models.SensitiveAttribute) – The value to assign to the client_secret property of this CreateConnectionFromOAuth2.
scope (str) – The value to assign to the scope property of this CreateConnectionFromOAuth2.
grant_type (str) – The value to assign to the grant_type property of this CreateConnectionFromOAuth2. Allowed values for this property are: “CLIENT_CREDENTIALS”

access_token_url¶

[Required] Gets the access_token_url of this CreateConnectionFromOAuth2. Specifies the endpoint used to exchange authentication credentials for access tokens

Returns:	The access_token_url of this CreateConnectionFromOAuth2.
Return type:	str

client_id¶

Gets the client_id of this CreateConnectionFromOAuth2. Specifies the client ID key for specific application

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

client_secret¶

Gets the client_secret of this CreateConnectionFromOAuth2.

Returns:	The client_secret of this CreateConnectionFromOAuth2.
Return type:	oci.data_integration.models.SensitiveAttribute

connection_properties¶

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

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

description¶

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

Returns:	The description of this CreateConnectionDetails.
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.

grant_type¶

Gets the grant_type of this CreateConnectionFromOAuth2. Specifies the OAuth2 grant mechanism. Example CLIENT_CREDENTIALS, Implicit Flow etc.

Allowed values for this property are: “CLIENT_CREDENTIALS”

Returns:	The grant_type of this CreateConnectionFromOAuth2.
Return type:	str

identifier¶

[Required] Gets the identifier of this CreateConnectionDetails. 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 CreateConnectionDetails.
Return type:	str

key¶

Gets the key of this CreateConnectionDetails. 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 CreateConnectionDetails.
Return type:	str

model_type¶

Gets the model_type of this CreateConnectionDetails. 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”

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

model_version¶

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

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

name¶

[Required] Gets the name of this CreateConnectionDetails. 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 CreateConnectionDetails.
Return type:	str

object_status¶

Gets the object_status of this CreateConnectionDetails. 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 CreateConnectionDetails.
Return type:	int

parent_ref¶

Gets the parent_ref of this CreateConnectionDetails.

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

registry_metadata¶

Gets the registry_metadata of this CreateConnectionDetails.

Returns:	The registry_metadata of this CreateConnectionDetails.
Return type:	oci.data_integration.models.RegistryMetadata

scope¶

Gets the scope of this CreateConnectionFromOAuth2. Specifies the OAuth scopes that limit the permissions granted by an access token.

Returns:	The scope of this CreateConnectionFromOAuth2.
Return type:	str