Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ConnectionSummary

Summary representation of a connection to a data asset.

Properties

Optional dataAssetKey

dataAssetKey: undefined | string

The unique key of the parent data asset.

Optional description

description: undefined | string

A description of the connection.

Optional displayName

displayName: undefined | string

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional externalKey

externalKey: undefined | string

Unique external key for this object as defined in the source systems.

Optional isDefault

isDefault: undefined | false | true

Indicates whether this connection is the default connection.

key

key: string

Unique connection key that is immutable.

Optional lifecycleState

lifecycleState: model.LifecycleState

The current state of the connection.

Optional timeCreated

timeCreated: Date

The date and time the connection was created, in the format defined by RFC3339. Example: {@code 2019-03-25T21:10:29.600Z}

Optional typeKey

typeKey: undefined | string

The key of the object type. Type key's can be found via the '/types' endpoint.

Optional uri

uri: undefined | string

URI to the connection instance in the API.

Functions

getDeserializedJsonObj

getJsonObj