Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace TypeSummary

Summary data catalog type information. All types are statically defined in the system and are immutable. It isn't possible to create new types or update existing types via the API.

Properties

Optional catalogId

catalogId: undefined | string

The data catalog's OCID.

Optional description

description: undefined | string

Detailed description of the type.

key

key: string

Unique type key that is immutable.

Optional lifecycleState

lifecycleState: model.LifecycleState

State of the folder.

Optional name

name: undefined | string

The immutable name of the type.

Optional parentTypeKey

parentTypeKey: undefined | string

Unique key of the parent type.

Optional parentTypeName

parentTypeName: undefined | string

Name of the parent type.

Optional typeCategory

typeCategory: undefined | string

Indicates the category this type belongs to. For instance, data assets, connections.

Optional uri

uri: undefined | string

URI to the type instance in the API.

Functions

getDeserializedJsonObj

getJsonObj