Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Entity

Data entity details. A representation of data with a set of attributes, normally representing a single business entity. Synonymous with 'table' or 'view' in a database, or a single logical file structure that one or many files may match.

Properties

Optional businessName

businessName: undefined | string

Optional user friendly business name of the data entity. If set, this supplements the harvested display name of the object.

Optional createdById

createdById: undefined | string

OCID of the user who created this object in the data catalog.

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

Detailed description of a data entity.

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 in the source system.

Optional folderKey

folderKey: undefined | string

Key of the associated folder.

Optional folderName

folderName: undefined | string

Name of the associated folder. This name is harvested from the source data asset when the parent folder for the entiy is harvested.

Optional harvestStatus

harvestStatus: model.HarvestStatus

Status of the object as updated by the harvest process.

Optional isLogical

isLogical: undefined | false | true

Property that identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects.

Optional isPartition

isPartition: undefined | false | true

Property that identifies if an object is a sub object of a physical or materialized parent object.

key

key: string

Unique data entity key that is immutable.

Optional lastJobKey

lastJobKey: undefined | string

Key of the last harvest process to update this object.

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 entity.

Optional objectRelationships

objectRelationships: Array<ObjectRelationship>

List of objects and their relationships to this entity.

Optional objectStorageUrl

objectStorageUrl: undefined | string

URL of the data entity in the object store.

Optional path

path: undefined | string

Full path of the data entity.

Optional patternKey

patternKey: undefined | string

Key of the associated pattern if this is a logical entity.

Optional properties

properties: undefined | object

A map of maps that contains the properties which are specific to the entity type. Each entity 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 entities have required properties within the "default" category. Example: {@code {"properties": { "default": { "key1": "value1"}}}}

Optional realizedExpression

realizedExpression: undefined | string

The expression realized after resolving qualifiers . Used in deriving this logical entity

Optional timeCreated

timeCreated: Date

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

Optional timeExternal

timeExternal: Date

Last modified timestamp of this object in the external system.

Optional timeHarvested

timeHarvested: Date

The date and time the entity was harvested, in the format defined by RFC3339.

Optional timeStatusUpdated

timeStatusUpdated: Date

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

Optional timeUpdated

timeUpdated: Date

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

Optional typeKey

typeKey: undefined | string

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

Optional updatedById

updatedById: undefined | string

OCID of the user who updated this object in the data catalog.

Optional uri

uri: undefined | string

URI to the data entity instance in the API.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Entity): object

getJsonObj

  • getJsonObj(obj: Entity): object