Interfaces
Aspect
A versioned aspect, or single group of related metadata, associated with an Entity and having a unique version
Implemented by
Fields
| Name | Description |
|---|---|
versionLong | The version of the aspect, where zero represents the latest version |
BrowsableEntity
A Metadata Entity which is browsable, or has browse paths.
Implemented by
Fields
| Name | Description |
|---|---|
browsePaths[BrowsePath!] | The browse paths corresponding to an entity. If no Browse Paths have been generated before, this will be null. |
EditableProperties
Editable properties aspect with a description that can be set in the UI
Implemented by
- ERModelRelationshipEditableProperties
- ContainerEditableProperties
- DatasetEditableProperties
- ChartEditableProperties
- DashboardEditableProperties
- NotebookEditableProperties
- DataJobEditableProperties
- DataFlowEditableProperties
- CorpGroupEditableProperties
- MLFeatureTableEditableProperties
- MLFeatureEditableProperties
- MLPrimaryKeyEditableProperties
- MLModelEditableProperties
- MLModelGroupEditableProperties
Fields
| Name | Description |
|---|---|
descriptionString | Description of the entity, edited in the UI |
Entity
A top level Metadata Entity
Implemented by
- Api
- Assertion
- AccessTokenMetadata
- ServiceAccount
- DataHubConnection
- Dataset
- DataContract
- DataProduct
- Document
- ERModelRelationship
- Role
- VersionedDataset
- GlossaryTerm
- GlossaryNode
- DataPlatform
- DataPlatformInstance
- Container
- SchemaFieldEntity
- CorpUser
- CorpGroup
- Tag
- Notebook
- Dashboard
- Chart
- DataFlow
- DataJob
- DataProcessInstance
- DataHubPolicy
- MLModel
- MLModelGroup
- MLFeature
- MLPrimaryKey
- MLFeatureTable
- Domain
- DataHubRole
- Post
- DataHubView
- QueryEntity
- Application
- OwnershipTypeEntity
- EntityTypeEntity
- Restricted
- BusinessAttribute
- DataHubFile
- Form
- Incident
- ExecutionRequest
- Metric
- SemanticModel
- DataHubPageModule
- StructuredPropertyEntity
- DataTypeEntity
- Repository
- DataHubPageTemplate
- Test
- VersionSet
- EntityWithRelationships
Fields
| Name | Description | ||||
|---|---|---|---|---|---|
urnString! | A primary key of the Metadata Entity | ||||
typeEntityType! | A standard Entity Type | ||||
relationshipsEntityRelationshipsResult | List of relationships between the source Entity and some destination entities with a given types Arguments
|
EntityProperties
Properties aspect shared by entities with a name and description
Implemented by
- ApiProperties
- RoleProperties
- DatasetProperties
- DataPlatformInstanceProperties
- GlossaryTermProperties
- GlossaryNodeProperties
- ContainerProperties
- TagProperties
- DashboardProperties
- ChartProperties
- DataFlowProperties
- DataJobProperties
- MLModelGroupProperties
- MLModelProperties
- DomainProperties
- QueryProperties
- DataProductProperties
- ApplicationProperties
- BusinessAttributeInfo
- RepositoryProperties
Fields
| Name | Description |
|---|---|
nameString | Name of the entity |
descriptionString | Description of the entity |
EntityWithRelationships
Deprecated, use relationships field instead
Implements
Implemented by
- Api
- Assertion
- Dataset
- ERModelRelationship
- SchemaFieldEntity
- Dashboard
- Chart
- DataFlow
- DataJob
- DataProcessInstance
- MLModel
- MLModelGroup
- MLFeature
- MLPrimaryKey
- MLFeatureTable
- Restricted
- Metric
- SemanticModel
- Repository
Fields
| Name | Description | ||||
|---|---|---|---|---|---|
urnString! | A primary key associated with the Metadata Entity | ||||
typeEntityType! | A standard Entity Type | ||||
relationshipsEntityRelationshipsResult | Granular API for querying edges extending from this entity Arguments
| ||||
lineageEntityLineageResult | Edges extending from this entity grouped by direction in the lineage graph Arguments
|
HasAccess
An entity with access roles
Implemented by
Fields
| Name | Description |
|---|---|
accessAccess | Roles and the properties to access the entity |
HasAiContext
An entity that can have AI context
Implemented by
Fields
| Name | Description |
|---|---|
aiContextAiContext | AI context of the entity |
HasApplications
An entity that can belong to applications
Implemented by
- Dataset
- DataProduct
- VersionedDataset
- GlossaryTerm
- GlossaryNode
- Container
- Notebook
- Dashboard
- Chart
- DataFlow
- DataJob
- MLModel
- MLModelGroup
- MLFeature
- MLPrimaryKey
- MLFeatureTable
Fields
| Name | Description |
|---|---|
applications[ApplicationAssociation!] | The applications associated with the entity |
HasBrowsePathV2
An entity with a browse path
Implemented by
- Dataset
- Document
- Container
- Notebook
- Dashboard
- Chart
- DataFlow
- DataJob
- MLModel
- MLModelGroup
- MLFeature
- MLFeatureTable
- Metric
- SemanticModel
- Repository
Fields
| Name | Description |
|---|---|
browsePathV2BrowsePathV2 | The browse path V2 corresponding to the entity |
HasContainer
An entity that can live inside a container
Implemented by
Fields
| Name | Description |
|---|---|
containerContainer | The parent container the entity belongs to |
HasCustomProperties
An aspect with custom properties
Implemented by
- AssertionInfo
- DocumentInfo
- DatasetProperties
- DataPlatformInstanceProperties
- GlossaryTermProperties
- GlossaryNodeProperties
- ContainerProperties
- CorpUserProperties
- NotebookInfo
- DashboardProperties
- ChartProperties
- DataFlowProperties
- DataJobProperties
- MLModelGroupProperties
- MLModelProperties
- MLFeatureProperties
- MLPrimaryKeyProperties
- MLFeatureTableProperties
- DomainProperties
- QueryProperties
- DataProductProperties
- ApplicationProperties
- BusinessAttributeInfo
- DataProcessInstanceProperties
Fields
| Name | Description |
|---|---|
customProperties[CustomPropertiesEntry!] | Custom properties of the entity |
HasDataPlatformInstance
An entity that can belong to a data platform instance
Implemented by
- Api
- Assertion
- Dataset
- Document
- Container
- Notebook
- Dashboard
- Chart
- DataFlow
- DataJob
- DataProcessInstance
- MLModel
- MLModelGroup
- MLFeature
- MLPrimaryKey
- MLFeatureTable
- Metric
- SemanticModel
- Repository
Fields
| Name | Description |
|---|---|
dataPlatformInstanceDataPlatformInstance | The specific instance of the data platform that the entity belongs to |
HasDeprecation
An entity that can be deprecated
Implemented by
- Dataset
- DataProduct
- VersionedDataset
- GlossaryTerm
- DataPlatformInstance
- Container
- SchemaFieldEntity
- Tag
- Dashboard
- Chart
- DataFlow
- DataJob
- MLModel
- MLModelGroup
- MLFeature
- MLPrimaryKey
- MLFeatureTable
- Domain
- Metric
- SemanticModel
Fields
| Name | Description |
|---|---|
deprecationDeprecation | The deprecation status of the entity |
HasDescription
An entity with a top-level description field
Implemented by
- AccessTokenMetadata
- ServiceAccount
- DataHubPolicy
- MLModel
- MLModelGroup
- MLFeature
- MLPrimaryKey
- MLFeatureTable
- DataHubRole
- DataHubView
- Incident
- Test
Fields
| Name | Description |
|---|---|
descriptionString | The description of the entity |
HasDisplayProperties
An entity with display properties
Implemented by
Fields
| Name | Description |
|---|---|
displayPropertiesDisplayProperties | Display properties of the entity, such as its color and icon |
HasDocumentation
An entity that can have documentation
Implemented by
Fields
| Name | Description |
|---|---|
documentationDocumentation | Documentation of the entity from various sources |
HasDomain
An entity that can belong to a domain
Implemented by
- Api
- Dataset
- DataProduct
- Document
- VersionedDataset
- GlossaryTerm
- GlossaryNode
- Container
- Notebook
- Dashboard
- Chart
- DataFlow
- DataJob
- MLModel
- MLModelGroup
- MLFeature
- MLPrimaryKey
- MLFeatureTable
- Application
- Metric
- SemanticModel
- Repository
Fields
| Name | Description |
|---|---|
domainDomainAssociation | The domain the entity belongs to |
HasEditableProperties
An entity with an editable description
Implemented by
- Dataset
- ERModelRelationship
- VersionedDataset
- Container
- CorpGroup
- Notebook
- Dashboard
- Chart
- DataFlow
- DataJob
- MLModel
- MLModelGroup
- MLFeature
- MLPrimaryKey
- MLFeatureTable
Fields
| Name | Description |
|---|---|
editablePropertiesEditableProperties | Properties of the entity edited in the UI |
HasEmbed
An entity that can be embedded
Implemented by
Fields
| Name | Description |
|---|---|
embedEmbed | Embed information about the entity |
HasExecutionRuns
Implemented by
Fields
| Name | Description | ||||||
|---|---|---|---|---|---|---|---|
runsDataProcessInstanceResult | History of runs of this task Arguments
|
HasExists
An entity that can report whether it exists
Implemented by
- Api
- Dataset
- DataProduct
- Document
- GlossaryTerm
- GlossaryNode
- Container
- CorpUser
- CorpGroup
- Notebook
- Dashboard
- Chart
- DataFlow
- DataJob
- DataProcessInstance
- MLModel
- MLModelGroup
- MLFeature
- MLPrimaryKey
- MLFeatureTable
- Application
- Metric
- SemanticModel
- DataHubPageModule
- StructuredPropertyEntity
- Repository
Fields
| Name | Description |
|---|---|
existsBoolean | Whether or not this entity exists on DataHub |
HasExternalUrl
An aspect with a link to the entity in its source system
Implemented by
- ApiProperties
- AssertionInfo
- DatasetProperties
- DataPlatformInstanceProperties
- ContainerProperties
- NotebookInfo
- DashboardProperties
- ChartProperties
- DataFlowProperties
- DataJobProperties
- MLModelGroupProperties
- MLModelProperties
- DataProductProperties
- ApplicationProperties
- DataProcessInstanceProperties
- MetricInfo
- SemanticModelInfo
Fields
| Name | Description |
|---|---|
externalUrlString | URL of the entity in its source system |
HasForms
An entity that can have forms assigned
Implemented by
- Dataset
- DataProduct
- GlossaryTerm
- GlossaryNode
- Container
- SchemaFieldEntity
- CorpUser
- CorpGroup
- Dashboard
- Chart
- DataFlow
- DataJob
- MLModel
- MLModelGroup
- MLFeature
- MLPrimaryKey
- MLFeatureTable
- Domain
- Application
Fields
| Name | Description |
|---|---|
formsForms | The forms associated with the entity |
HasGlossaryTerms
An entity that can have glossary terms
Implemented by
- Api
- Dataset
- DataProduct
- Document
- ERModelRelationship
- VersionedDataset
- Container
- SchemaFieldEntity
- Notebook
- Dashboard
- Chart
- DataFlow
- DataJob
- MLModel
- MLModelGroup
- MLFeature
- MLPrimaryKey
- MLFeatureTable
- Application
- Metric
- SemanticModel
- Repository
Fields
| Name | Description |
|---|---|
glossaryTermsGlossaryTerms | Glossary terms associated with the entity |
HasHealth
An entity with health signals
Implemented by
Fields
| Name | Description |
|---|---|
health[Health!] | Experimental! The resolved health statuses of the entity |
HasIncidents
An entity that can have incidents
Implemented by
Fields
| Name | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
incidentsEntityIncidentsResult | Incidents associated with the entity Arguments
|
HasInstitutionalMemory
An entity that can have links attached
Implemented by
- Api
- Dataset
- DataProduct
- Document
- ERModelRelationship
- VersionedDataset
- GlossaryTerm
- GlossaryNode
- DataPlatformInstance
- Container
- Notebook
- Dashboard
- Chart
- DataFlow
- DataJob
- MLModel
- MLModelGroup
- MLFeature
- MLPrimaryKey
- MLFeatureTable
- Domain
- Application
- BusinessAttribute
- Metric
- SemanticModel
- Repository
Fields
| Name | Description |
|---|---|
institutionalMemoryInstitutionalMemory | References to internal resources related to the entity |
HasLastIngested
An entity populated by ingestion
Implemented by
- Dataset
- Document
- DataPlatform
- Container
- Dashboard
- Chart
- DataFlow
- DataJob
- MLModel
- MLModelGroup
- MLFeature
- MLPrimaryKey
- MLFeatureTable
- Metric
- SemanticModel
Fields
| Name | Description |
|---|---|
lastIngestedLong | The timestamp for the last time the entity was ingested |
HasLogicalParent
Implemented by
Fields
| Name | Description |
|---|---|
logicalParentEntity | If this entity represents a physical asset, this is its logical parent, from which metadata can propagate. |
HasName
An entity with a top-level name field
Implemented by
- AccessTokenMetadata
- ServiceAccount
- Dataset
- VersionedDataset
- DataPlatform
- CorpGroup
- DataHubPolicy
- MLModel
- MLModelGroup
- MLFeature
- MLPrimaryKey
- MLFeatureTable
- DataHubRole
- DataHubView
- Test
Fields
| Name | Description |
|---|---|
nameString! | The name of the entity. Not always the display name, e.g. for Dataset this is the name from its key |
HasOwnership
An entity that can have owners
Implemented by
- Api
- Assertion
- Dataset
- DataProduct
- Document
- ERModelRelationship
- VersionedDataset
- GlossaryTerm
- GlossaryNode
- DataPlatformInstance
- Container
- CorpGroup
- Tag
- Notebook
- Dashboard
- Chart
- DataFlow
- DataJob
- MLModel
- MLModelGroup
- MLFeature
- MLPrimaryKey
- MLFeatureTable
- Domain
- Application
- BusinessAttribute
- Form
- Metric
- SemanticModel
- Repository
Fields
| Name | Description |
|---|---|
ownershipOwnership | Ownership metadata of the entity |
HasParentContainers
An entity with a container hierarchy
Implemented by
Fields
| Name | Description |
|---|---|
parentContainersParentContainersResult | Recursively get the lineage of containers for the entity |
HasPlatform
An entity that belongs to a data platform
Implemented by
- Assertion
- DataHubConnection
- Dataset
- Document
- VersionedDataset
- DataPlatformInstance
- Container
- Notebook
- Dashboard
- Chart
- DataFlow
- DataJob
- DataProcessInstance
- MLModel
- MLModelGroup
- MLFeatureTable
- QueryEntity
- Metric
- SemanticModel
- Repository
Fields
| Name | Description |
|---|---|
platformDataPlatform | The platform the entity belongs to |
HasPrivileges
An entity whose privileges for the current user can be resolved. Resolving privileges runs around 17 authorization checks per entity, so avoid selecting it through this interface in queries that return many entities, such as search results or lineage.
Implemented by
- Api
- Dataset
- DataProduct
- Document
- ERModelRelationship
- GlossaryTerm
- GlossaryNode
- Container
- CorpUser
- CorpGroup
- Dashboard
- Chart
- DataFlow
- DataJob
- MLModel
- MLModelGroup
- MLFeature
- MLPrimaryKey
- MLFeatureTable
- Domain
- QueryEntity
- Application
- BusinessAttribute
- Metric
- SemanticModel
- Repository
Fields
| Name | Description |
|---|---|
privilegesEntityPrivileges | Privileges given to the current user for the entity |
HasProperties
An entity whose properties aspect has a name and description
Implemented by
- Api
- Dataset
- DataProduct
- Role
- VersionedDataset
- GlossaryTerm
- GlossaryNode
- DataPlatformInstance
- Container
- Tag
- Dashboard
- Chart
- DataFlow
- DataJob
- MLModel
- MLModelGroup
- Domain
- QueryEntity
- Application
- BusinessAttribute
- Repository
Fields
| Name | Description |
|---|---|
propertiesEntityProperties | Properties of the entity |
HasRawAspects
An entity whose raw aspects can be fetched
Implemented by
- Api
- Assertion
- Dataset
- DataProduct
- Document
- GlossaryTerm
- GlossaryNode
- Container
- CorpUser
- CorpGroup
- Tag
- Notebook
- Dashboard
- Chart
- DataFlow
- DataJob
- MLModel
- MLModelGroup
- MLFeature
- MLPrimaryKey
- MLFeatureTable
- Domain
- DataHubRole
- Application
- Repository
Fields
| Name | Description | ||||
|---|---|---|---|---|---|
aspects[RawAspect] | Experimental API. For fetching extra entities that do not have custom UI code yet Arguments
|
HasRelatedDocuments
An entity that can have related context documents
Implemented by
- Dataset
- DataProduct
- GlossaryTerm
- GlossaryNode
- Container
- SchemaFieldEntity
- Dashboard
- Chart
- DataFlow
- DataJob
- MLModel
- MLModelGroup
- MLFeature
- MLPrimaryKey
- MLFeatureTable
- Domain
- Application
Fields
| Name | Description | ||||
|---|---|---|---|---|---|
relatedDocumentsRelatedDocumentsResult | Get context documents related to this entity Arguments
|
HasStatus
An entity that can be soft deleted
Implemented by
- Api
- Assertion
- Dataset
- ERModelRelationship
- VersionedDataset
- GlossaryTerm
- DataPlatformInstance
- Container
- SchemaFieldEntity
- Tag
- Notebook
- Dashboard
- Chart
- DataFlow
- DataJob
- DataProcessInstance
- MLModel
- MLModelGroup
- MLFeature
- MLPrimaryKey
- MLFeatureTable
- Application
- OwnershipTypeEntity
- BusinessAttribute
- Metric
- SemanticModel
- Repository
Fields
| Name | Description |
|---|---|
statusStatus | The status of the entity |
HasStructuredProperties
An entity that can have structured properties
Implemented by
- Api
- Dataset
- DataContract
- DataProduct
- Document
- GlossaryTerm
- GlossaryNode
- Container
- SchemaFieldEntity
- CorpUser
- CorpGroup
- Dashboard
- Chart
- DataFlow
- DataJob
- MLModel
- MLModelGroup
- MLFeature
- MLPrimaryKey
- MLFeatureTable
- Domain
- Application
- Metric
- SemanticModel
- Repository
Fields
| Name | Description |
|---|---|
structuredPropertiesStructuredProperties | Structured properties applied to the entity |
HasSubTypes
An entity that can have sub types
Implemented by
- Api
- Dataset
- VersionedDataset
- Container
- Notebook
- Dashboard
- Chart
- DataFlow
- DataJob
- DataProcessInstance
- Metric
- SemanticModel
- Repository
Fields
| Name | Description |
|---|---|
subTypesSubTypes | Sub types of the entity |
HasTags
An entity that can have tags
Implemented by
- Api
- Assertion
- Dataset
- DataProduct
- Document
- ERModelRelationship
- VersionedDataset
- GlossaryTerm
- GlossaryNode
- DataPlatformInstance
- Container
- SchemaFieldEntity
- CorpUser
- Notebook
- Dashboard
- Chart
- DataFlow
- DataJob
- MLModel
- MLModelGroup
- MLFeature
- MLPrimaryKey
- MLFeatureTable
- Application
- Incident
- Metric
- SemanticModel
- Repository
Fields
| Name | Description |
|---|---|
tagsGlobalTags | Tags applied to the entity |
SupportsVersions
Implemented by
Fields
| Name | Description |
|---|---|
versionPropertiesVersionProperties | Indicates that this entity is versioned and provides information about the version. |
TimeSeriesAspect
A time series aspect, or a group of related metadata associated with an Entity and corresponding to a particular timestamp
Implemented by
Fields
| Name | Description |
|---|---|
timestampMillisLong! | The timestamp associated with the time series aspect in milliseconds |