Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace FolderSummary

Summary of a folder. A generic term used in the data catalog for an external organization concept used for a collection of data entities or processes within a data asset. This term is an internal term which models multiple external types of folder, such as file directories, database schemas, and so on. Some data assets, such as Object Store containers, may contain many levels of folders.

Properties

Optional businessName

businessName: undefined | string

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

Optional dataAssetKey

dataAssetKey: undefined | string

The unique key of the parent data asset.

Optional description

description: undefined | string

Detailed description of a folder.

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

key

key: string

Unique folder 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

State of the folder.

Optional objectStorageUrl

objectStorageUrl: undefined | string

URL of the folder in the object store.

Optional parentFolderKey

parentFolderKey: undefined | string

The key of the containing folder or null if there is no parent.

Optional path

path: undefined | string

Full path of the folder.

Optional timeCreated

timeCreated: Date

The date and time the folder 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 timeUpdated

timeUpdated: Date

The date and time the folder was last updated, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

Optional typeKey

typeKey: undefined | string

The type of folder object. Type keys can be found via the '/types' endpoint.

Optional uri

uri: undefined | string

URI of the folder resource within the data catalog API.

Functions

getDeserializedJsonObj

getJsonObj