Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Attribute

Details of an entity attribute. An attribute of a data entity describing an item of data, with a name and data type. Synonymous with 'column' in a database.

Properties

Optional associatedRuleTypes

associatedRuleTypes: Array<AssociatedRuleTypes>

Rule types associated with attribute.

Optional businessName

businessName: undefined | string

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

Optional createdById

createdById: undefined | string

OCID of the user who created this attribute in the data catalog.

Optional customPropertyMembers

customPropertyMembers: Array<CustomPropertyGetUsage>

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

Optional datatypeEntityKey

datatypeEntityKey: undefined | string

Entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.

Optional description

description: undefined | string

Detailed description of the attribute.

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 entityKey

entityKey: undefined | string

The unique key of the parent entity.

Optional externalDataType

externalDataType: undefined | string

Data type of the attribute as defined in the external system. Type mapping across systems can be achieved through term associations across domains in the ontology. The attribute can also be tagged to the datatype in the domain ontology to resolve any ambiguity arising from type name similarity that can occur with user defined types.

Optional externalDatatypeEntityKey

externalDatatypeEntityKey: undefined | string

External entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.

Optional externalKey

externalKey: undefined | string

Unique external key of this attribute in the external source system.

Optional externalParentAttributeKey

externalParentAttributeKey: undefined | string

External attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex type.

Optional isDerivedAttribute

isDerivedAttribute: undefined | false | true

Whether a column is derived or not.

Optional isIncrementalData

isIncrementalData: undefined | false | true

Property that identifies if this attribute can be used as a watermark to extract incremental data.

Optional isNullable

isNullable: undefined | false | true

Property that identifies if this attribute can be assigned null values.

key

key: string

Unique attribute key that is immutable.

Optional length

length: undefined | number

Max allowed length of the attribute value. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

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

Optional maxCollectionCount

maxCollectionCount: undefined | number

The maximum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type. For type specifications in systems that specify only "capacity" without upper or lower bound , this property can also be used to just mean "capacity". Some examples are Varray size in Oracle , Occurs Clause in Cobol , capacity in XmlSchemaObjectCollection , maxOccurs in Xml , maxItems in Json Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional minCollectionCount

minCollectionCount: undefined | number

The minimum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional objectRelationships

objectRelationships: Array<ObjectRelationship>

List of objects and their relationships to this attribute.

Optional parentAttributeKey

parentAttributeKey: undefined | string

Attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex datatype.

Optional path

path: undefined | string

Full path of the attribute.

Optional position

position: undefined | number

Position of the attribute in the record definition. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional precision

precision: undefined | number

Precision of the attribute value usually applies to float data type. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional properties

properties: undefined | object

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

Optional scale

scale: undefined | number

Scale of the attribute value usually applies to float data type. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional timeCreated

timeCreated: Date

The date and time the attribute 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 attribute was harvested, in the format defined by RFC3339.

Optional timeUpdated

timeUpdated: Date

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

Optional typeKey

typeKey: undefined | string

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

Optional updatedById

updatedById: undefined | string

OCID of the user who modified this attribute in the data catalog.

Optional uri

uri: undefined | string

URI to the attribute instance in the API.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Attribute): object

getJsonObj