Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ForeignKey

The foreign key object.

Properties

Methods

Properties

Optional attributeRefs

attributeRefs: Array<KeyAttribute>

An array of attribute references.

Optional deleteRule

deleteRule: undefined | number

The delete rule. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional key

key: undefined | string

The object key.

Const modelType

modelType: string = "FOREIGN_KEY"

Optional modelVersion

modelVersion: undefined | string

The object's model version.

Optional name

name: undefined | string

Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Optional objectStatus

objectStatus: undefined | number

The status of an object that can be set to value 1 for shallow references across objects, other values reserved. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional parentRef

parentRef: model.ParentReference

Optional referenceUniqueKey

referenceUniqueKey: PrimaryKey | UniqueDataKey

Optional updateRule

updateRule: undefined | number

The update rule. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Methods

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Key): object

getJsonObj

  • getJsonObj(obj: Key): object