Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Connection

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

Properties

Optional createdById

createdById: undefined | string

OCID of the user who created the connection.

Optional customPropertyMembers

customPropertyMembers: Array<CustomPropertyGetUsage>

The list of customized properties along with the values for this object

Optional dataAssetKey

dataAssetKey: undefined | string

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 of this object from the source system.

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 properties

properties: undefined | object

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: {@code {"properties": { "default": { "username": "user1"}}}}

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 timeStatusUpdated

timeStatusUpdated: Date

Time that the connections status was last updated. An RFC3339 formatted datetime string.

Optional timeUpdated

timeUpdated: Date

The last time that any change was made to the connection. An RFC3339 formatted datetime string.

Optional typeKey

typeKey: undefined | string

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

Optional updatedById

updatedById: undefined | string

OCID of the user who modified the connection.

Optional uri

uri: undefined | string

URI to the connection instance in the API.

Functions

getDeserializedJsonObj

getJsonObj