Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace DataEntityFromDataStore

The view entity data entity details.

Properties

Optional description

description: undefined | string

Detailed description for the object.

Optional entityType

entityType: EntityType

The entity type.

Optional externalKey

externalKey: undefined | string

The external key for the object

Optional filters

filters: undefined | string

Filters present in the Datastore. It can be Null.

Optional foreignKeys

foreignKeys: Array<ForeignKey>

An array of foreign keys.

Optional identifier

identifier: undefined | string

Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified.

Optional isEffectiveDateDisabled

isEffectiveDateDisabled: undefined | false | true

It shows whether or not effective date is disabled

Optional isFlexDataStore

isFlexDataStore: undefined | false | true

It shows whether the datastore is of flex type

Optional isSilentError

isSilentError: undefined | false | true

It shows whether the extraction of this datastore will stop on error

Optional key

key: undefined | string

The object key.

Optional metadata

metadata: model.ObjectMetadata

Const modelType

modelType: string = "DATA_STORE_ENTITY"

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 objectVersion

objectVersion: undefined | number

The version of the object that is used to track changes in the object instance. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional otherTypeLabel

otherTypeLabel: undefined | string

Specifies other type label.

Optional parentRef

parentRef: model.ParentReference

Optional resourceName

resourceName: undefined | string

The resource name.

Optional shape

shape: model.Shape

Optional shapeId

shapeId: undefined | string

The shape ID.

Optional supportsIncremental

supportsIncremental: undefined | false | true

It shows whether the datastore supports Incremental Extract or not.

Optional types

types: model.TypeLibrary

Optional uniqueKeys

uniqueKeys: Array<UniqueKey>

An array of unique keys.

Methods

getDeserializedJsonObj

getJsonObj