Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace 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 createdById

createdById: undefined | string

OCID of the user who created the folder.

Optional customPropertyMembers

customPropertyMembers: Array<CustomPropertyGetUsage>

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

Optional dataAssetKey

dataAssetKey: undefined | string

The key of the associated 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 in the source system.

Optional harvestStatus

harvestStatus: model.HarvestStatus

Status of the object as updated by the harvest process.

key

key: string

Unique folder key that is immutable.

Optional lastJobKey

lastJobKey: undefined | string

The key of the last harvest process to update the metadata of 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 folder.

Optional objectRelationships

objectRelationships: Array<ObjectRelationship>

List of objects and their relationships to this folder.

Optional objectStorageUrl

objectStorageUrl: undefined | string

URL of the folder in the object store.

Optional parentFolderKey

parentFolderKey: undefined | string

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

Optional path

path: undefined | string

Full path of the folder.

Optional properties

properties: undefined | object

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

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 timeHarvested

timeHarvested: Date

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

Optional timeUpdated

timeUpdated: Date

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

Optional typeKey

typeKey: undefined | string

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

Optional updatedById

updatedById: undefined | string

OCID of the user who modified the folder.

Optional uri

uri: undefined | string

URI to the folder instance in the API.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Folder): object

getJsonObj

  • getJsonObj(obj: Folder): object