Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Type

Full data catalog type definition. Fully defines a type of the data catalog. 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 customProperties

customProperties: Array<CustomPropertySummary>

Custom properties associated with this Type.

Optional description

description: undefined | string

Detailed description of the type.

Optional externalTypeName

externalTypeName: undefined | string

Mapping type equivalence in the external system.

Optional isApproved

isApproved: undefined | false | true

Indicates whether the type is approved for use as a classifying object.

Optional isInternal

isInternal: undefined | false | true

Indicates whether the type is internal, making it unavailable for use by metadata elements.

Optional isTag

isTag: undefined | false | true

Indicates whether the type can be used for tagging metadata elements.

key

key: string

Unique type key that is immutable.

Optional lifecycleState

lifecycleState: model.LifecycleState

The current state of the type.

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 properties

properties: undefined | object

A map of arrays which defines the type specific properties, both required and optional. The map keys are category names and the values are arrays contiaing all property details. Every property is contained inside of a category. Most types have required properties within the "default" category. Example: {@code { "properties": { "default": { "attributes:": [ { "name": "host", "type": "string", "isRequired": true, "isUpdatable": false }, ... ] } } }}

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

  • getDeserializedJsonObj(obj: Type): object

getJsonObj

  • getJsonObj(obj: Type): object