Connection¶

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

Bases: object

Detailed representation of a connection to a data asset, minus any sensitive properties.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Connection.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Connection.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Connection.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Connection.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Connection.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a Connection.
`LIFECYCLE_STATE_MOVING`	A constant which can be used with the lifecycle_state property of a Connection.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Connection.
`created_by_id`	Gets the created_by_id of this Connection.
`custom_property_members`	Gets the custom_property_members of this Connection.
`data_asset_key`	Gets the data_asset_key of this Connection.
`description`	Gets the description of this Connection.
`display_name`	Gets the display_name of this Connection.
`external_key`	Gets the external_key of this Connection.
`is_default`	Gets the is_default of this Connection.
`key`	[Required] Gets the key of this Connection.
`lifecycle_state`	Gets the lifecycle_state of this Connection.
`properties`	Gets the properties of this Connection.
`time_created`	Gets the time_created of this Connection.
`time_status_updated`	Gets the time_status_updated of this Connection.
`time_updated`	Gets the time_updated of this Connection.
`type_key`	Gets the type_key of this Connection.
`updated_by_id`	Gets the updated_by_id of this Connection.
`uri`	Gets the uri of this Connection.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Connection. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a Connection. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a Connection. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a Connection. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a Connection. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a Connection. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_MOVING = 'MOVING'¶: A constant which can be used with the lifecycle_state property of a Connection. This constant has a value of “MOVING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a Connection. This constant has a value of “UPDATING”

__init__(**kwargs)¶

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

Parameters:

key (str) – The value to assign to the key property of this Connection.
description (str) – The value to assign to the description property of this Connection.
display_name (str) – The value to assign to the display_name property of this Connection.
time_created (datetime) – The value to assign to the time_created property of this Connection.
time_updated (datetime) – The value to assign to the time_updated property of this Connection.
created_by_id (str) – The value to assign to the created_by_id property of this Connection.
updated_by_id (str) – The value to assign to the updated_by_id property of this Connection.
custom_property_members (list[oci.data_catalog.models.CustomPropertyGetUsage]) – The value to assign to the custom_property_members property of this Connection.
properties (dict(str, dict(str, str))) – The value to assign to the properties property of this Connection.
external_key (str) – The value to assign to the external_key property of this Connection.
time_status_updated (datetime) – The value to assign to the time_status_updated property of this Connection.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Connection. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_default (bool) – The value to assign to the is_default property of this Connection.
data_asset_key (str) – The value to assign to the data_asset_key property of this Connection.
type_key (str) – The value to assign to the type_key property of this Connection.
uri (str) – The value to assign to the uri property of this Connection.

created_by_id¶

Gets the created_by_id of this Connection. OCID of the user who created the connection.

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

custom_property_members¶

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

Returns:	The custom_property_members of this Connection.
Return type:	list[oci.data_catalog.models.CustomPropertyGetUsage]

data_asset_key¶

Gets the data_asset_key of this Connection. Unique key of the parent data asset.

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

description¶

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

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

display_name¶

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

external_key¶

Gets the external_key of this Connection. Unique external key of this object from the source system.

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

is_default¶

Gets the is_default of this Connection. Indicates whether this connection is the default connection.

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

key¶

[Required] Gets the key of this Connection. Unique connection key that is immutable.

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

lifecycle_state¶

Gets the lifecycle_state of this Connection. The current state of the connection.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

properties¶

Gets the properties of this Connection. 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. Example: {“properties”: { “default”: { “username”: “user1”}}}

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

time_created¶

Gets the time_created of this Connection. The date and time the connection was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

Returns:	The time_created of this Connection.
Return type:	datetime

time_status_updated¶

Gets the time_status_updated of this Connection. Time that the connections status was last updated. An RFC3339 formatted datetime string.

Returns:	The time_status_updated of this Connection.
Return type:	datetime

time_updated¶

Gets the time_updated of this Connection. The last time that any change was made to the connection. An RFC3339 formatted datetime string.

Returns:	The time_updated of this Connection.
Return type:	datetime

type_key¶

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

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

updated_by_id¶

Gets the updated_by_id of this Connection. OCID of the user who modified the connection.

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

uri¶

Gets the uri of this Connection. URI to the connection instance in the API.

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