EntityCreateOptions
Options for creating a new Data Fabric entity
Extends¶
Properties¶
| Property | Type | Description |
|---|---|---|
description? |
string |
Optional entity description |
displayName? |
string |
Human-readable display name shown in the UI (defaults to name if omitted) |
entityClass? |
EntityClass |
Experimental Product class of the entity (default: Native). Set to Federated to create a federated entity — a read-only view over one or more external/native sources. A Federated entity requires at least one source in externalFields. |
externalFields? |
EntityCreateExternalSource[] |
Experimental External source definitions — the connections, objects, and field mappings a Federated entity reads from. Required when entityClass is Federated; ignored for Native entities. |
folderKey? |
string |
Experimental Key identifying the folder the entity belongs to. Omit for tenant-level entities. Folder-scoped Data Fabric is in preview — the contract may change. |
isAnalyticsEnabled? |
boolean |
Experimental Whether Analytics integration is enabled for this entity (default: false). Surfaced by getById as isAnalyticsEnabled. Analytics integration is in preview — the contract may change. |
isRbacEnabled? |
boolean |
Whether role-based access control is enabled for this entity (default: false) |
sourceJoinConditionDetails? |
SourceJoinConditionDetail[] |
Experimental Cross-source joins for a multi-source Federated entity. Each entry joins two sources by object + field name; omit for a single-source Federated entity. |