ConnectionSummary

class oci.data_catalog.models.ConnectionSummary(**kwargs)

Bases: object

Summary representation of a connection to a data asset.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a ConnectionSummary.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a ConnectionSummary.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a ConnectionSummary.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a ConnectionSummary.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a ConnectionSummary.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a ConnectionSummary.

LIFECYCLE_STATE_MOVING

A constant which can be used with the lifecycle_state property of a ConnectionSummary.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a ConnectionSummary.

data_asset_key

Gets the data_asset_key of this ConnectionSummary.

description

Gets the description of this ConnectionSummary.

display_name

Gets the display_name of this ConnectionSummary.

external_key

Gets the external_key of this ConnectionSummary.

is_default

Gets the is_default of this ConnectionSummary.

key

[Required] Gets the key of this ConnectionSummary.

lifecycle_state

Gets the lifecycle_state of this ConnectionSummary.

time_created

Gets the time_created of this ConnectionSummary.

type_key

Gets the type_key of this ConnectionSummary.

uri

Gets the uri of this ConnectionSummary.

Methods:

__init__(**kwargs)

Initializes a new ConnectionSummary object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a ConnectionSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a ConnectionSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a ConnectionSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a ConnectionSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a ConnectionSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a ConnectionSummary. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_MOVING = 'MOVING'

A constant which can be used with the lifecycle_state property of a ConnectionSummary. This constant has a value of “MOVING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a ConnectionSummary. This constant has a value of “UPDATING”

__init__(**kwargs)

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

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

  • display_name (str) – The value to assign to the display_name property of this ConnectionSummary.

  • data_asset_key (str) – The value to assign to the data_asset_key property of this ConnectionSummary.

  • type_key (str) – The value to assign to the type_key property of this ConnectionSummary.

  • uri (str) – The value to assign to the uri property of this ConnectionSummary.

  • external_key (str) – The value to assign to the external_key property of this ConnectionSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this ConnectionSummary. 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 ConnectionSummary.

  • time_created (datetime) – The value to assign to the time_created property of this ConnectionSummary.

property data_asset_key

Gets the data_asset_key of this ConnectionSummary. The unique key of the parent data asset.

Returns

The data_asset_key of this ConnectionSummary.

Return type

str

property description

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

Returns

The description of this ConnectionSummary.

Return type

str

property display_name

Gets the display_name of this ConnectionSummary. 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 ConnectionSummary.

Return type

str

property external_key

Gets the external_key of this ConnectionSummary. Unique external key for this object as defined in the source systems.

Returns

The external_key of this ConnectionSummary.

Return type

str

property is_default

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

Returns

The is_default of this ConnectionSummary.

Return type

bool

property key

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

Returns

The key of this ConnectionSummary.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this ConnectionSummary. 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 ConnectionSummary.

Return type

str

property time_created

Gets the time_created of this ConnectionSummary. 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 ConnectionSummary.

Return type

datetime

property type_key

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

Returns

The type_key of this ConnectionSummary.

Return type

str

property uri

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

Returns

The uri of this ConnectionSummary.

Return type

str