CreateConnectionDetails¶

class oci.data_catalog.models.CreateConnectionDetails(**kwargs)¶

Bases: object

Properties used in connection create operations.

Methods

__init__(**kwargs) Initializes a new CreateConnectionDetails object with values from keyword arguments.

Attributes

`custom_property_members`	Gets the custom_property_members of this CreateConnectionDetails.
`description`	Gets the description of this CreateConnectionDetails.
`display_name`	[Required] Gets the display_name of this CreateConnectionDetails.
`enc_properties`	Gets the enc_properties of this CreateConnectionDetails.
`is_default`	Gets the is_default of this CreateConnectionDetails.
`properties`	[Required] Gets the properties of this CreateConnectionDetails.
`type_key`	[Required] Gets the type_key of this CreateConnectionDetails.

__init__(**kwargs)¶

Initializes a new CreateConnectionDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

description (str) – The value to assign to the description property of this CreateConnectionDetails.
display_name (str) – The value to assign to the display_name property of this CreateConnectionDetails.
type_key (str) – The value to assign to the type_key property of this CreateConnectionDetails.
custom_property_members (list[oci.data_catalog.models.CustomPropertySetUsage]) – The value to assign to the custom_property_members property of this CreateConnectionDetails.
properties (dict(str, dict(str, str))) – The value to assign to the properties property of this CreateConnectionDetails.
enc_properties (dict(str, dict(str, str))) – The value to assign to the enc_properties property of this CreateConnectionDetails.
is_default (bool) – The value to assign to the is_default property of this CreateConnectionDetails.

custom_property_members¶

Gets the custom_property_members of this CreateConnectionDetails. The list of customized properties along with the values for this object

Returns:	The custom_property_members of this CreateConnectionDetails.
Return type:	list[oci.data_catalog.models.CustomPropertySetUsage]

description¶

Gets the description of this CreateConnectionDetails. A description of the connection.

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

display_name¶

[Required] Gets the display_name of this CreateConnectionDetails. A user-friendly display name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

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

enc_properties¶

Gets the enc_properties of this CreateConnectionDetails. A map of maps that contains the encrypted values for sensitive properties which are specific to the connection type. Each connection type definition defines it’s set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most connections have required properties within the “default” category. To determine the set of optional and required properties for a connection type, a query can be done on ‘/types?type=connection’ that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it’s properties, can be identified from this collection. Example: {“encProperties”: { “default”: { “password”: “example-password”}}}

Returns:	The enc_properties of this CreateConnectionDetails.
Return type:	dict(str, dict(str, str))

is_default¶

Gets the is_default of this CreateConnectionDetails. Indicates whether this connection is the default connection. The first connection of a data asset defaults to being the default, subsequent connections default to not being the default. If a default connection already exists, then trying to create a connection as the default will fail. In this case the default connection would need to be updated not to be the default and then the new connection can then be created as the default.

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

properties¶

[Required] Gets the properties of this CreateConnectionDetails. A map of maps that contains the properties which are specific to the connection type. Each connection type definition defines it’s set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most connections have required properties within the “default” category. To determine the set of optional and required properties for a connection type, a query can be done on ‘/types?type=connection’ that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it’s properties, can be identified from this collection. Example: {“properties”: { “default”: { “username”: “user1”}}}

Returns:	The properties of this CreateConnectionDetails.
Return type:	dict(str, dict(str, str))

type_key¶

[Required] Gets the type_key of this CreateConnectionDetails. The key of the object type. Type key’s can be found via the ‘/types’ endpoint.

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