ConnectionFromOAuth2Details

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

Bases: ConnectionDetails

The connection details for a OAuth connection.

Attributes:

GRANT_TYPE_CLIENT_CREDENTIALS

A constant which can be used with the grant_type property of a ConnectionFromOAuth2Details.

MODEL_TYPE_AMAZON_S3_CONNECTION

A constant which can be used with the model_type property of a ConnectionDetails.

MODEL_TYPE_BICC_CONNECTION

A constant which can be used with the model_type property of a ConnectionDetails.

MODEL_TYPE_BIP_CONNECTION

A constant which can be used with the model_type property of a ConnectionDetails.

MODEL_TYPE_GENERIC_JDBC_CONNECTION

A constant which can be used with the model_type property of a ConnectionDetails.

MODEL_TYPE_HDFS_CONNECTION

A constant which can be used with the model_type property of a ConnectionDetails.

MODEL_TYPE_LAKE_CONNECTION

A constant which can be used with the model_type property of a ConnectionDetails.

MODEL_TYPE_MYSQL_CONNECTION

A constant which can be used with the model_type property of a ConnectionDetails.

MODEL_TYPE_MYSQL_HEATWAVE_CONNECTION

A constant which can be used with the model_type property of a ConnectionDetails.

MODEL_TYPE_OAUTH2_CONNECTION

A constant which can be used with the model_type property of a ConnectionDetails.

MODEL_TYPE_ORACLEDB_CONNECTION

A constant which can be used with the model_type property of a ConnectionDetails.

MODEL_TYPE_ORACLE_ADWC_CONNECTION

A constant which can be used with the model_type property of a ConnectionDetails.

MODEL_TYPE_ORACLE_ATP_CONNECTION

A constant which can be used with the model_type property of a ConnectionDetails.

MODEL_TYPE_ORACLE_EBS_CONNECTION

A constant which can be used with the model_type property of a ConnectionDetails.

MODEL_TYPE_ORACLE_OBJECT_STORAGE_CONNECTION

A constant which can be used with the model_type property of a ConnectionDetails.

MODEL_TYPE_ORACLE_PEOPLESOFT_CONNECTION

A constant which can be used with the model_type property of a ConnectionDetails.

MODEL_TYPE_ORACLE_SIEBEL_CONNECTION

A constant which can be used with the model_type property of a ConnectionDetails.

MODEL_TYPE_REST_BASIC_AUTH_CONNECTION

A constant which can be used with the model_type property of a ConnectionDetails.

MODEL_TYPE_REST_NO_AUTH_CONNECTION

A constant which can be used with the model_type property of a ConnectionDetails.

access_token_url

[Required] Gets the access_token_url of this ConnectionFromOAuth2Details.

client_id

Gets the client_id of this ConnectionFromOAuth2Details.

client_secret

Gets the client_secret of this ConnectionFromOAuth2Details.

connection_properties

Gets the connection_properties of this ConnectionDetails.

description

Gets the description of this ConnectionDetails.

grant_type

Gets the grant_type of this ConnectionFromOAuth2Details.

identifier

Gets the identifier of this ConnectionDetails.

is_default

Gets the is_default of this ConnectionDetails.

key

Gets the key of this ConnectionDetails.

metadata

Gets the metadata of this ConnectionDetails.

model_type

[Required] Gets the model_type of this ConnectionDetails.

model_version

Gets the model_version of this ConnectionDetails.

name

Gets the name of this ConnectionDetails.

object_status

Gets the object_status of this ConnectionDetails.

object_version

Gets the object_version of this ConnectionDetails.

parent_ref

Gets the parent_ref of this ConnectionDetails.

primary_schema

Gets the primary_schema of this ConnectionDetails.

scope

Gets the scope of this ConnectionFromOAuth2Details.

Methods:

__init__(**kwargs)

Initializes a new ConnectionFromOAuth2Details 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 ConnectionFromOAuth2Details. This constant has a value of “CLIENT_CREDENTIALS”

MODEL_TYPE_AMAZON_S3_CONNECTION = 'AMAZON_S3_CONNECTION'

A constant which can be used with the model_type property of a ConnectionDetails. 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 ConnectionDetails. 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 ConnectionDetails. 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 ConnectionDetails. 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 ConnectionDetails. 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 ConnectionDetails. 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 ConnectionDetails. 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 ConnectionDetails. 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 ConnectionDetails. 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 ConnectionDetails. 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 ConnectionDetails. 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 ConnectionDetails. 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 ConnectionDetails. 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 ConnectionDetails. 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 ConnectionDetails. 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 ConnectionDetails. 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 ConnectionDetails. 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 ConnectionDetails. This constant has a value of “REST_NO_AUTH_CONNECTION”

__init__(**kwargs)

Initializes a new ConnectionFromOAuth2Details 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 ConnectionFromOAuth2Details. 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 ConnectionFromOAuth2Details.

  • model_version (str) – The value to assign to the model_version property of this ConnectionFromOAuth2Details.

  • parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this ConnectionFromOAuth2Details.

  • name (str) – The value to assign to the name property of this ConnectionFromOAuth2Details.

  • description (str) – The value to assign to the description property of this ConnectionFromOAuth2Details.

  • object_version (int) – The value to assign to the object_version property of this ConnectionFromOAuth2Details.

  • object_status (int) – The value to assign to the object_status property of this ConnectionFromOAuth2Details.

  • identifier (str) – The value to assign to the identifier property of this ConnectionFromOAuth2Details.

  • primary_schema (oci.data_integration.models.Schema) – The value to assign to the primary_schema property of this ConnectionFromOAuth2Details.

  • connection_properties (list[oci.data_integration.models.ConnectionProperty]) – The value to assign to the connection_properties property of this ConnectionFromOAuth2Details.

  • is_default (bool) – The value to assign to the is_default property of this ConnectionFromOAuth2Details.

  • metadata (oci.data_integration.models.ObjectMetadata) – The value to assign to the metadata property of this ConnectionFromOAuth2Details.

  • access_token_url (str) – The value to assign to the access_token_url property of this ConnectionFromOAuth2Details.

  • client_id (str) – The value to assign to the client_id property of this ConnectionFromOAuth2Details.

  • client_secret (oci.data_integration.models.SensitiveAttribute) – The value to assign to the client_secret property of this ConnectionFromOAuth2Details.

  • scope (str) – The value to assign to the scope property of this ConnectionFromOAuth2Details.

  • grant_type (str) – The value to assign to the grant_type property of this ConnectionFromOAuth2Details. Allowed values for this property are: “CLIENT_CREDENTIALS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

property access_token_url

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

Returns

The access_token_url of this ConnectionFromOAuth2Details.

Return type

str

property client_id

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

Returns

The client_id of this ConnectionFromOAuth2Details.

Return type

str

property client_secret

Gets the client_secret of this ConnectionFromOAuth2Details.

Returns

The client_secret of this ConnectionFromOAuth2Details.

Return type

oci.data_integration.models.SensitiveAttribute

property connection_properties

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

Returns

The connection_properties of this ConnectionDetails.

Return type

list[oci.data_integration.models.ConnectionProperty]

property description

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

Returns

The description of this ConnectionDetails.

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.

property grant_type

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

Allowed values for this property are: “CLIENT_CREDENTIALS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The grant_type of this ConnectionFromOAuth2Details.

Return type

str

property identifier

Gets the identifier of this ConnectionDetails. 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 ConnectionDetails.

Return type

str

property is_default

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

Returns

The is_default of this ConnectionDetails.

Return type

bool

property key

Gets the key of this ConnectionDetails. 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 ConnectionDetails.

Return type

str

property metadata

Gets the metadata of this ConnectionDetails.

Returns

The metadata of this ConnectionDetails.

Return type

oci.data_integration.models.ObjectMetadata

property model_type

[Required] Gets the model_type of this ConnectionDetails. 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 ConnectionDetails.

Return type

str

property model_version

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

Returns

The model_version of this ConnectionDetails.

Return type

str

property name

Gets the name of this ConnectionDetails. 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 ConnectionDetails.

Return type

str

property object_status

Gets the object_status of this ConnectionDetails. 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 ConnectionDetails.

Return type

int

property object_version

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

Returns

The object_version of this ConnectionDetails.

Return type

int

property parent_ref

Gets the parent_ref of this ConnectionDetails.

Returns

The parent_ref of this ConnectionDetails.

Return type

oci.data_integration.models.ParentReference

property primary_schema

Gets the primary_schema of this ConnectionDetails.

Returns

The primary_schema of this ConnectionDetails.

Return type

oci.data_integration.models.Schema

property scope

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

Returns

The scope of this ConnectionFromOAuth2Details.

Return type

str