Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Catalog

A data catalog enables you to collect, organize, find, access, understand, enrich, and activate technical, business, and operational metadata.

Properties

Optional attachedCatalogPrivateEndpoints

attachedCatalogPrivateEndpoints: Array<string>

The list of private reverse connection endpoints attached to the catalog

compartmentId

compartmentId: string

Compartment identifier.

Optional definedTags

definedTags: undefined | object

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional displayName

displayName: undefined | string

Data catalog identifier, which can be renamed.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

id

id: string

OCID of the data catalog instance.

Optional lifecycleDetails

lifecycleDetails: undefined | string

An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.

Optional lifecycleState

lifecycleState: model.LifecycleState

The current state of the data catalog resource.

Optional locks

Locks associated with this resource.

Optional numberOfObjects

numberOfObjects: undefined | number

The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional serviceApiUrl

serviceApiUrl: undefined | string

The REST front endpoint URL to the data catalog instance.

Optional serviceConsoleUrl

serviceConsoleUrl: undefined | string

The console front endpoint URL to the data catalog instance.

Optional systemTags

systemTags: undefined | object

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {@code {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}}

Optional timeCreated

timeCreated: Date

The time the data catalog was created. An RFC3339 formatted datetime string.

Optional timeUpdated

timeUpdated: Date

The time the data catalog was updated. An RFC3339 formatted datetime string.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Catalog): object

getJsonObj