Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace DataAsset

Data asset representation. A physical store, or stream, of data known to the data catalog and containing one or many data entities, possibly in an organized structure of folders. A data asset is often synonymous with a 'System', such as a database, or may be a file container or a message stream.

Properties

Optional catalogId

catalogId: undefined | string

The data catalog's OCID.

Optional createdById

createdById: undefined | string

OCID of the user who created the data asset.

Optional customPropertyMembers

customPropertyMembers: Array<CustomPropertyGetUsage>

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

Optional dataSelectorPatterns

dataSelectorPatterns: Array<PatternSummary>

The list of data selector patterns used in the harvest for this data asset to derive logical entities.

Optional description

description: undefined | string

Detailed description of the data asset.

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

External URI that can be used to reference the object. Format will differ based on the type of object.

key

key: string

Unique data asset key that is immutable.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, see service documentation for details.

Optional lifecycleState

lifecycleState: model.LifecycleState

The current state of the data asset.

Optional properties

properties: undefined | object

A map of maps that contains the properties which are specific to the asset type. Each data asset 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 data assets have required properties within the "default" category. Example: {@code {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}}

Optional timeCreated

timeCreated: Date

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

Optional timeHarvested

timeHarvested: Date

The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.

Optional timeUpdated

timeUpdated: Date

The last time that any change was made to the data asset. 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 last modified the data asset.

Optional uri

uri: undefined | string

URI to the data asset instance in the API.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: DataAsset): object

getJsonObj