mirror of
https://github.com/datahub-project/datahub.git
synced 2025-07-03 23:28:11 +00:00
118 lines
127 KiB
HTML
118 lines
127 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-graphql/enums" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v2.4.3">
|
||
<title data-rh="true">Enums | DataHub</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.datahub.com/docs/graphql/enums"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Enums | DataHub"><meta data-rh="true" name="description" content="AccessLevel"><meta data-rh="true" property="og:description" content="AccessLevel"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.datahub.com/docs/graphql/enums"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/graphql/enums" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/graphql/enums" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://RK0UG797F3-dsn.algolia.net" crossorigin="anonymous"><link rel="alternate" type="application/rss+xml" href="/learn/rss.xml" title="DataHub RSS Feed">
|
||
<link rel="alternate" type="application/atom+xml" href="/learn/atom.xml" title="DataHub Atom Feed">
|
||
|
||
<link rel="preconnect" href="https://www.google-analytics.com">
|
||
<link rel="preconnect" href="https://www.googletagmanager.com">
|
||
<script async src="https://www.googletagmanager.com/gtag/js?id=G-PKGVLETT4C"></script>
|
||
<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-PKGVLETT4C",{})</script>
|
||
<link rel="preconnect" href="https://www.googletagmanager.com">
|
||
<script>window.dataLayer=window.dataLayer||[]</script>
|
||
<script>!function(e,t,a,n,g){e[n]=e[n]||[],e[n].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var m=t.getElementsByTagName(a)[0],r=t.createElement(a);r.async=!0,r.src="https://www.googletagmanager.com/gtm.js?id=GTM-5M8T9HNN",m.parentNode.insertBefore(r,m)}(window,document,"script","dataLayer")</script>
|
||
|
||
|
||
<link rel="search" type="application/opensearchdescription+xml" title="DataHub" href="/opensearch.xml">
|
||
|
||
|
||
|
||
|
||
<meta httpequiv="Content-Security-Policy" content="frame-ancestors 'self' https://*.acryl.io https://acryldata.io http://localhost:*">
|
||
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Manrope:wght@400;500;700&display=swap">
|
||
<script src="https://tools.luckyorange.com/core/lo.js?site-id=28ea8a38" async defer="defer"></script>
|
||
<script src="/scripts/rb2b.js" async defer="defer"></script>
|
||
<script src="https://app.revenuehero.io/scheduler.min.js"></script>
|
||
<script src="https://tag.clearbitscripts.com/v1/pk_2e321cabe30432a5c44c0424781aa35f/tags.js" referrerpolicy="strict-origin-when-cross-origin"></script>
|
||
<script src="/scripts/reo.js"></script>
|
||
<script id="runllm-widget-script" type="module" src="https://widget.runllm.com" crossorigin="true" runllm-name="DataHub" runllm-assistant-id="81" runllm-position="BOTTOM_RIGHT" runllm-keyboard-shortcut="Mod+j" runllm-preset="docusaurus" runllm-theme-color="#1890FF" runllm-brand-logo="https://docs.datahub.com/img/datahub-logo-color-mark.svg" runllm-community-url="https://datahub.com/slack" runllm-community-type="slack" runllm-disable-ask-a-person="true" async></script><link rel="stylesheet" href="/assets/css/styles.d8fe2eb8.css">
|
||
<link rel="preload" href="/assets/js/runtime~main.9e7dc23e.js" as="script">
|
||
<link rel="preload" href="/assets/js/main.a5ea2da0.js" as="script">
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-5M8T9HNN" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||
|
||
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())</script><div id="__docusaurus">
|
||
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><div class="announcementBar_mb4j" style="background-color:transparent;color:#ffffff" role="banner"><div class="content_knG7 announcementBarContent_xLdY"><div class="shimmer-banner"><p>DataHub Secures $35 Million Series B</p><a href="https://datahub.com/news/series-b-announcement/" target="_blank" class="button"><div>Read the announcement<span> →</span></div></a></div></div></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a href="https://datahub.com" target="_blank" rel="noopener noreferrer" class="navbar__brand"><div class="navbar__logo"><img src="/img/datahub-logo-color-light-horizontal.svg" alt="DataHub Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/datahub-logo-color-dark-horizontal.svg" alt="DataHub Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div></a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link versionNavItem_cbn8">Next</a><ul class="dropdown__menu"><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/docs/graphql/enums">Next</a></li><li><a class="dropdown__link" href="/docs/1.1.0/graphql/enums">1.1.0</a></li><li><hr class="dropdown-separator" style="margin: 0.4rem;"></li><li><div class="dropdown__link"><b>Archived versions</b></div></li><li>
|
||
<a class="dropdown__link" href="https://docs-website-t9sv4w3gr-acryldata.vercel.app/docs/features">1.0.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-t9sv4w3gr-acryldata.vercel.app/docs/0.15.0/features">0.15.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-8jkm4uler-acryldata.vercel.app/docs/0.14.1/features">0.14.1
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-eue2qafvn-acryldata.vercel.app/docs/features">0.14.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-psat3nzgi-acryldata.vercel.app/docs/features">0.13.1
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-lzxh86531-acryldata.vercel.app/docs/features">0.13.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-2uuxmgza2-acryldata.vercel.app/docs/features">0.12.1
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-irpoe2osc-acryldata.vercel.app/docs/features">0.11.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-1gv2yzn9d-acryldata.vercel.app/docs/features">0.10.5
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li></ul></div></div><div class="navbar__items navbar__items--right"><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs">Docs</a><a class="navbar__item navbar__link" href="/integrations">Integrations</a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Learn</a><ul class="dropdown__menu dropdown__menu_Z8FC"><div class="wrapper_kp81"><div><a href="https://datahub.com/weekly-demo" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-join-slack.png" alt="Weekly Demo"></div><div class="title_c7DP">Weekly Demo</div></a></div><div><a href="https://datahub.com/use-cases" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-forum.png" alt="Use Cases"></div><div class="title_c7DP">Use Cases</div></a></div><div><a href="httpps://datahub.com/adoption-stories" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-events.png" alt="Adoption Stories"></div><div class="title_c7DP">Adoption Stories</div></a></div><div><a href="https://medium.com/datahub-project" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-champions.png" alt="Blog"></div><div class="title_c7DP">Blog</div></a></div><div><a href="https://www.youtube.com/channel/UC3qFQC5IiwR5fvWEqi_tJ5w" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-share-your-journey.png" alt="Youtube"></div><div class="title_c7DP">Youtube</div></a></div></div></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Community</a><ul class="dropdown__menu dropdown__menu_Z8FC"><div class="wrapper_kp81"><div><a href="https://datahub.com/slack/" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-join-slack.png" alt="Join Slack"></div><div class="title_c7DP">Join Slack</div></a></div><div><a href="https://datahub.com/events" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-events.png" alt="Events"></div><div class="title_c7DP">Events</div></a></div><div><a href="https://datahub.com/champions/" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-champions.png" alt="Champions"></div><div class="title_c7DP">Champions</div></a></div><div><a href="https://datahub.com/share-your-journey/" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-share-your-journey.png" alt="Share Your Journey"></div><div class="title_c7DP">Share Your Journey</div></a></div></div></ul></div><a href="https://datahub.com/products/why-datahub-cloud/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">
|
||
<style>
|
||
.cloud-cta {
|
||
color: var(--ifm-menu-color-active);
|
||
font-weight: 600;
|
||
background: linear-gradient(40deg, var(--ifm-menu-color-active), var(--ifm-menu-color-active));
|
||
background-size: 200% 100%;
|
||
-webkit-background-clip: text;
|
||
background-clip: text;
|
||
transition: background-image 0.3s ease;
|
||
}
|
||
.cloud-cta:hover {
|
||
color: transparent;
|
||
background: linear-gradient(40deg, var(--ifm-menu-color-active), #ff1493);
|
||
background-size: 200% 100%;
|
||
-webkit-background-clip: text;
|
||
background-clip: text;
|
||
animation: gradientShift 3s ease infinite;
|
||
}
|
||
@keyframes gradientShift {
|
||
0%, 100% { background-position: 0% 50%; }
|
||
50% { background-position: 100% 50%; }
|
||
}
|
||
</style>
|
||
<div class="cloud-cta">Get Cloud</div>
|
||
</a><a href="https://datahub.com/slack?utm_source=docs&utm_medium=header&utm_campaign=docs_header" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">
|
||
<style>
|
||
.slack-logo:hover {
|
||
opacity: 0.8;
|
||
}
|
||
</style>
|
||
<img class="slack-logo" src="https://upload.wikimedia.org/wikipedia/commons/d/d5/Slack_icon_2019.svg" , alt="slack" , height="20px" style="margin: 10px 0 0 0;">
|
||
</a><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG menuWithAnnouncementBar_GW3s"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Getting Started</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/features">What Is DataHub?</a><button aria-label="Toggle the collapsible sidebar category 'What Is DataHub?'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/category/features">Features</a><button aria-label="Toggle the collapsible sidebar category 'Features'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>DataHub Cloud</div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/managed-datahub/managed-datahub-overview">DataHub Cloud Overview</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/managed-datahub/welcome-acryl">Getting Started with DataHub Cloud</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/authentication/guides/sso/initialize-oidc">Configure Single Sign-On</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/managed-datahub/remote-executor/about">Remote Executor</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/managed-datahub/datahub-api/entity-events-api">DataHub API</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/managed-datahub/slack/saas-slack-app">Slack</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/managed-datahub/operator-guide/setting-up-events-api-on-aws-eventbridge">Operator Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item saasOnly"><a class="menu__link" href="/docs/managed-datahub/approval-workflows">Change Proposals & Approval Workflows</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/managed-datahub/chrome-extension">Cloud Chrome Extension</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item saasOnly"><a class="menu__link" href="/docs/managed-datahub/subscription-and-notification">Subscriptions & Notifications</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/managed-datahub/release-notes/v_0_3_12">DataHub Cloud Release History</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Integrations</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/metadata-ingestion">Overview</a><button aria-label="Toggle the collapsible sidebar category 'Overview'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/metadata-ingestion/cli-ingestion">Quickstart Guides</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/metadata-ingestion/source_overview">Sources</a><button aria-label="Toggle the collapsible sidebar category 'Sources'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/metadata-ingestion/schedule_docs/intro">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>API & SDKs</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/metadata-modeling/metadata-model">DataHub's Open Metadata Standard</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/what-is-datahub/datahub-concepts">Concepts</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/metadata-standards">Metadata Standards</a><button aria-label="Toggle the collapsible sidebar category 'Metadata Standards'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/api/datahub-apis">APIs and SDKs Overview</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/api/graphql/overview">API</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" tabindex="0" href="/docs/api/graphql/overview">GraphQL API</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/api/graphql/overview">Overview</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" tabindex="0" href="/docs/graphql/queries">Reference</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/graphql/queries">Queries</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/graphql/mutations">Mutations</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/graphql/objects">Objects</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/graphql/inputObjects">Inputs</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/graphql/interfaces">Interfaces</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/graphql/unions">Unions</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/graphql/enums">Enums</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/graphql/scalars">Scalars</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/api/graphql/how-to-set-up-graphql">Guides</a></div></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/api/openapi/openapi-usage-guide">OpenAPI</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/dev-guides/timeline">Timeline API</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/api/restli/restli-overview">Rest.li API</a></div></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/metadata-ingestion/as-a-library">Python SDK</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/metadata-integration/java/as-a-library">Java SDK</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/cli">DataHub CLI</a><button aria-label="Toggle the collapsible sidebar category 'DataHub CLI'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/act-on-metadata">DataHub Actions</a><button aria-label="Toggle the collapsible sidebar category 'DataHub Actions'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/api/tutorials/datasets">Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Admin</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/authentication">Authentication</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/authorization">Authorization</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/how/delete-metadata">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Deployment</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/category/deployment-guides">Deployment Guides</a><button aria-label="Toggle the collapsible sidebar category 'Deployment Guides'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/deploy/confluent-cloud">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Developers</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/architecture/architecture">Architecture</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/developers">Developing on DataHub</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/advanced/mcp-mcl">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Community</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/category/community">Community</a><button aria-label="Toggle the collapsible sidebar category 'Community'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/releases">Release History</a></div></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">API</span><meta itemprop="position" content="1"></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">GraphQL API</span><meta itemprop="position" content="2"></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Reference</span><meta itemprop="position" content="3"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Enums</span><meta itemprop="position" content="4"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: Next</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Enums</h1></header><h2 class="anchor anchorWithStickyNavbar_LWe7" id="accesslevel">AccessLevel<a href="#accesslevel" class="hash-link" aria-label="Direct link to AccessLevel" title="Direct link to AccessLevel"></a></h2><p>The access level for a Metadata Entity, either public or private</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>PUBLIC</td><td><p>Publicly available</p></td></tr><tr><td>PRIVATE</td><td><p>Restricted to a subset of viewers</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="accesstokenduration">AccessTokenDuration<a href="#accesstokenduration" class="hash-link" aria-label="Direct link to AccessTokenDuration" title="Direct link to AccessTokenDuration"></a></h2><p>The duration for which an Access Token is valid.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>ONE_HOUR</td><td><p>1 hour</p></td></tr><tr><td>ONE_DAY</td><td><p>1 day</p></td></tr><tr><td>ONE_WEEK</td><td><p>1 week</p></td></tr><tr><td>ONE_MONTH</td><td><p>1 month</p></td></tr><tr><td>THREE_MONTHS</td><td><p>3 months</p></td></tr><tr><td>SIX_MONTHS</td><td><p>6 months</p></td></tr><tr><td>ONE_YEAR</td><td><p>1 year</p></td></tr><tr><td>NO_EXPIRY</td><td><p>No expiry</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="accesstokentype">AccessTokenType<a href="#accesstokentype" class="hash-link" aria-label="Direct link to AccessTokenType" title="Direct link to AccessTokenType"></a></h2><p>A type of DataHub Access Token.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>PERSONAL</td><td><p>Generates a personal access token</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="assertionactiontype">AssertionActionType<a href="#assertionactiontype" class="hash-link" aria-label="Direct link to AssertionActionType" title="Direct link to AssertionActionType"></a></h2><p>The type of the Action</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>RAISE_INCIDENT</td><td><p>Raise an incident.</p></td></tr><tr><td>RESOLVE_INCIDENT</td><td><p>Resolve open incidents related to the assertion.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="assertionresulterrortype">AssertionResultErrorType<a href="#assertionresulterrortype" class="hash-link" aria-label="Direct link to AssertionResultErrorType" title="Direct link to AssertionResultErrorType"></a></h2><p>The type of error encountered when evaluating an AssertionResult</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>SOURCE_CONNECTION_ERROR</td><td><p>Source is unreachable</p></td></tr><tr><td>SOURCE_QUERY_FAILED</td><td><p>Source query failed to execute</p></td></tr><tr><td>INVALID_PARAMETERS</td><td><p>Invalid parameters were detected</p></td></tr><tr><td>INSUFFICIENT_DATA</td><td><p>Insufficient data to evaluate assertion</p></td></tr><tr><td>INVALID_SOURCE_TYPE</td><td><p>Event type not supported by the specified source</p></td></tr><tr><td>UNSUPPORTED_PLATFORM</td><td><p>Platform not supported</p></td></tr><tr><td>CUSTOM_SQL_ERROR</td><td><p>Error while executing a custom SQL assertion</p></td></tr><tr><td>FIELD_ASSERTION_ERROR</td><td><p>Error while executing a field assertion</p></td></tr><tr><td>UNKNOWN_ERROR</td><td><p>Unknown error</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="assertionresulttype">AssertionResultType<a href="#assertionresulttype" class="hash-link" aria-label="Direct link to AssertionResultType" title="Direct link to AssertionResultType"></a></h2><p>The result type of an assertion, success or failure.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>INIT</td><td><p>The assertion has not yet been fully evaluated.</p></td></tr><tr><td>SUCCESS</td><td><p>The assertion succeeded.</p></td></tr><tr><td>FAILURE</td><td><p>The assertion failed.</p></td></tr><tr><td>ERROR</td><td><p>The assertion errored.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="assertionrunstatus">AssertionRunStatus<a href="#assertionrunstatus" class="hash-link" aria-label="Direct link to AssertionRunStatus" title="Direct link to AssertionRunStatus"></a></h2><p>The state of an assertion run, as defined within an Assertion Run Event.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>COMPLETE</td><td><p>An assertion run has completed.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="assertionsourcetype">AssertionSourceType<a href="#assertionsourcetype" class="hash-link" aria-label="Direct link to AssertionSourceType" title="Direct link to AssertionSourceType"></a></h2><p>The source of an assertion</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>NATIVE</td><td><p>The assertion was defined natively on DataHub by a user.</p></td></tr><tr><td>EXTERNAL</td><td><p>The assertion was defined and managed externally of DataHub.</p></td></tr><tr><td>INFERRED</td><td><p>The assertion was inferred, e.g. from offline AI / ML models.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="assertionstdaggregation">AssertionStdAggregation<a href="#assertionstdaggregation" class="hash-link" aria-label="Direct link to AssertionStdAggregation" title="Direct link to AssertionStdAggregation"></a></h2><p>An "aggregation" function that can be applied to column values of a Dataset to create the input to an Assertion Operator.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>IDENTITY</td><td><p>Assertion is applied on individual column value</p></td></tr><tr><td>MEAN</td><td><p>Assertion is applied on column mean</p></td></tr><tr><td>MEDIAN</td><td><p>Assertion is applied on column median</p></td></tr><tr><td>UNIQUE_COUNT</td><td><p>Assertion is applied on number of distinct values in column</p></td></tr><tr><td>UNIQUE_PROPOTION</td><td><p>Assertion is applied on proportion of distinct values in column</p></td></tr><tr><td>NULL_COUNT</td><td><p>Assertion is applied on number of null values in column</p></td></tr><tr><td>NULL_PROPORTION</td><td><p>Assertion is applied on proportion of null values in column</p></td></tr><tr><td>STDDEV</td><td><p>Assertion is applied on column std deviation</p></td></tr><tr><td>MIN</td><td><p>Assertion is applied on column min</p></td></tr><tr><td>MAX</td><td><p>Assertion is applied on column std deviation</p></td></tr><tr><td>SUM</td><td><p>Assertion is applied on column sum</p></td></tr><tr><td>COLUMNS</td><td><p>Assertion is applied on all columns</p></td></tr><tr><td>COLUMN_COUNT</td><td><p>Assertion is applied on number of columns</p></td></tr><tr><td>ROW_COUNT</td><td><p>Assertion is applied on number of rows</p></td></tr><tr><td>_NATIVE_</td><td><p>Other</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="assertionstdoperator">AssertionStdOperator<a href="#assertionstdoperator" class="hash-link" aria-label="Direct link to AssertionStdOperator" title="Direct link to AssertionStdOperator"></a></h2><p>A standard operator or condition that constitutes an assertion definition</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>BETWEEN</td><td><p>Value being asserted is between min_value and max_value</p></td></tr><tr><td>LESS_THAN</td><td><p>Value being asserted is less than max_value</p></td></tr><tr><td>LESS_THAN_OR_EQUAL_TO</td><td><p>Value being asserted is less than or equal to max_value</p></td></tr><tr><td>GREATER_THAN</td><td><p>Value being asserted is greater than min_value</p></td></tr><tr><td>GREATER_THAN_OR_EQUAL_TO</td><td><p>Value being asserted is greater than or equal to min_value</p></td></tr><tr><td>EQUAL_TO</td><td><p>Value being asserted is equal to value</p></td></tr><tr><td>NOT_EQUAL_TO</td><td><p>Value being asserted is not equal to value</p></td></tr><tr><td>NULL</td><td><p>Value being asserted is null</p></td></tr><tr><td>NOT_NULL</td><td><p>Value being asserted is not null</p></td></tr><tr><td>CONTAIN</td><td><p>Value being asserted contains value</p></td></tr><tr><td>END_WITH</td><td><p>Value being asserted ends with value</p></td></tr><tr><td>START_WITH</td><td><p>Value being asserted starts with value</p></td></tr><tr><td>REGEX_MATCH</td><td><p>Value being asserted matches the regex value.</p></td></tr><tr><td>IN</td><td><p>Value being asserted is one of the array values</p></td></tr><tr><td>NOT_IN</td><td><p>Value being asserted is not in one of the array values.</p></td></tr><tr><td>IS_TRUE</td><td><p>Value being asserted is true</p></td></tr><tr><td>IS_FALSE</td><td><p>Value being asserted is false</p></td></tr><tr><td>_NATIVE_</td><td><p>Other</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="assertionstdparametertype">AssertionStdParameterType<a href="#assertionstdparametertype" class="hash-link" aria-label="Direct link to AssertionStdParameterType" title="Direct link to AssertionStdParameterType"></a></h2><p>The type of an AssertionStdParameter</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>STRING</td><td><p>A string value</p></td></tr><tr><td>NUMBER</td><td><p>A numeric value</p></td></tr><tr><td>LIST</td><td><p>A list of values. When used, the value should be formatted as a serialized JSON array.</p></td></tr><tr><td>SET</td><td><p>A set of values. When used, the value should be formatted as a serialized JSON array.</p></td></tr><tr><td>UNKNOWN</td><td><p>A value of unknown type</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="assertiontype">AssertionType<a href="#assertiontype" class="hash-link" aria-label="Direct link to AssertionType" title="Direct link to AssertionType"></a></h2><p>The top-level assertion type.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>DATASET</td><td><p>A single-dataset assertion.</p></td></tr><tr><td>FRESHNESS</td><td><p>An assertion which indicates when a particular operation should occur to an asset.</p></td></tr><tr><td>VOLUME</td><td><p>An assertion which indicates how much data should be available for a particular asset.</p></td></tr><tr><td>SQL</td><td><p>A raw SQL-statement based assertion.</p></td></tr><tr><td>FIELD</td><td><p>A structured assertion targeting a specific column or field of the Dataset.</p></td></tr><tr><td>DATA_SCHEMA</td><td><p>A schema or structural assertion.</p></td></tr><tr><td>CUSTOM</td><td><p>A custom assertion.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="assertionvaluechangetype">AssertionValueChangeType<a href="#assertionvaluechangetype" class="hash-link" aria-label="Direct link to AssertionValueChangeType" title="Direct link to AssertionValueChangeType"></a></h2><p>An enum to represent a type of change in an assertion value, metric, or measurement.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>ABSOLUTE</td><td><p>A change that is defined in absolute terms.</p></td></tr><tr><td>PERCENTAGE</td><td><p>A change that is defined in relative terms using percentage change from the original value.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="changecategorytype">ChangeCategoryType<a href="#changecategorytype" class="hash-link" aria-label="Direct link to ChangeCategoryType" title="Direct link to ChangeCategoryType"></a></h2><p>Enum of CategoryTypes</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>DOCUMENTATION</td><td><p>When documentation has been edited</p></td></tr><tr><td>GLOSSARY_TERM</td><td><p>When glossary terms have been added or removed</p></td></tr><tr><td>OWNERSHIP</td><td><p>When ownership has been modified</p></td></tr><tr><td>TECHNICAL_SCHEMA</td><td><p>When technical schemas have been added or removed</p></td></tr><tr><td>TAG</td><td><p>When tags have been added or removed</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="changeoperationtype">ChangeOperationType<a href="#changeoperationtype" class="hash-link" aria-label="Direct link to ChangeOperationType" title="Direct link to ChangeOperationType"></a></h2><p>Enum of types of changes</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>ADD</td><td><p>When an element is added</p></td></tr><tr><td>MODIFY</td><td><p>When an element is modified</p></td></tr><tr><td>REMOVE</td><td><p>When an element is removed</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="chartquerytype">ChartQueryType<a href="#chartquerytype" class="hash-link" aria-label="Direct link to ChartQueryType" title="Direct link to ChartQueryType"></a></h2><p>The type of the Chart Query</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>SQL</td><td><p>Standard ANSI SQL</p></td></tr><tr><td>LOOKML</td><td><p>LookML</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="charttype">ChartType<a href="#charttype" class="hash-link" aria-label="Direct link to ChartType" title="Direct link to ChartType"></a></h2><p>The type of a Chart Entity</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>BAR</td><td><p>Bar graph</p></td></tr><tr><td>PIE</td><td><p>Pie chart</p></td></tr><tr><td>SCATTER</td><td><p>Scatter plot</p></td></tr><tr><td>TABLE</td><td><p>Table</p></td></tr><tr><td>TEXT</td><td><p>Markdown formatted text</p></td></tr><tr><td>LINE</td><td><p>A line chart</p></td></tr><tr><td>AREA</td><td><p>An area chart</p></td></tr><tr><td>HISTOGRAM</td><td><p>A histogram chart</p></td></tr><tr><td>BOX_PLOT</td><td><p>A box plot chart</p></td></tr><tr><td>WORD_CLOUD</td><td><p>A word cloud chart</p></td></tr><tr><td>COHORT</td><td><p>A Cohort Analysis chart</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="corpuserstatus">CorpUserStatus<a href="#corpuserstatus" class="hash-link" aria-label="Direct link to CorpUserStatus" title="Direct link to CorpUserStatus"></a></h2><p>The state of a CorpUser</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>ACTIVE</td><td><p>A User that has been provisioned and logged in</p></td></tr><tr><td>SUSPENDED</td><td><p>A user that has been suspended</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="costtype">CostType<a href="#costtype" class="hash-link" aria-label="Direct link to CostType" title="Direct link to CostType"></a></h2><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>ORG_COST_TYPE</td><td><p>Org Cost Type to which the Cost of this entity should be attributed to</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="datacontractstate">DataContractState<a href="#datacontractstate" class="hash-link" aria-label="Direct link to DataContractState" title="Direct link to DataContractState"></a></h2><p>The state of the data contract</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>ACTIVE</td><td><p>The data contract is active.</p></td></tr><tr><td>PENDING</td><td><p>The data contract is pending. Note that this symbol is currently experimental.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="datahubconnectiondetailstype">DataHubConnectionDetailsType<a href="#datahubconnectiondetailstype" class="hash-link" aria-label="Direct link to DataHubConnectionDetailsType" title="Direct link to DataHubConnectionDetailsType"></a></h2><p>The type of a DataHub connection</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>JSON</td><td><p>A json-encoded set of connection details.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="datahubpagemoduletype">DataHubPageModuleType<a href="#datahubpagemoduletype" class="hash-link" aria-label="Direct link to DataHubPageModuleType" title="Direct link to DataHubPageModuleType"></a></h2><p>Enum containing the types of page modules that there are</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>LINK</td><td><p>Link type module</p></td></tr><tr><td>RICH_TEXT</td><td><p>Module containing rich text to be rendered</p></td></tr><tr><td>ASSET_COLLECTION</td><td><p>A module with a collection of assets</p></td></tr><tr><td>HIERARCHY</td><td><p>A module displaying a hierarchy to navigate</p></td></tr><tr><td>OWNED_ASSETS</td><td><p>Module displaying assets owned by a user</p></td></tr><tr><td>SUBSCRIBED_ASSETS</td><td><p>Module displaying assets subscribed to by a given user</p></td></tr><tr><td>DOMAINS</td><td><p>Module displaying the top domains</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="datahubviewtype">DataHubViewType<a href="#datahubviewtype" class="hash-link" aria-label="Direct link to DataHubViewType" title="Direct link to DataHubViewType"></a></h2><p>The type of a DataHub View</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>PERSONAL</td><td><p>A personal view - e.g. saved filters</p></td></tr><tr><td>GLOBAL</td><td><p>A global view, e.g. role view</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="dataprocessinstancerunresulttype">DataProcessInstanceRunResultType<a href="#dataprocessinstancerunresulttype" class="hash-link" aria-label="Direct link to DataProcessInstanceRunResultType" title="Direct link to DataProcessInstanceRunResultType"></a></h2><p>The result of the data process run</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>SUCCESS</td><td><p>The run finished successfully</p></td></tr><tr><td>FAILURE</td><td><p>The run finished in failure</p></td></tr><tr><td>SKIPPED</td><td><p>The run was skipped</p></td></tr><tr><td>UP_FOR_RETRY</td><td><p>The run failed and is up for retry</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="dataprocessrunstatus">DataProcessRunStatus<a href="#dataprocessrunstatus" class="hash-link" aria-label="Direct link to DataProcessRunStatus" title="Direct link to DataProcessRunStatus"></a></h2><p>The status of the data process instance</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>STARTED</td><td><p>The data process instance has started but not completed</p></td></tr><tr><td>COMPLETE</td><td><p>The data process instance has completed</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="datasetassertionscope">DatasetAssertionScope<a href="#datasetassertionscope" class="hash-link" aria-label="Direct link to DatasetAssertionScope" title="Direct link to DatasetAssertionScope"></a></h2><p>The scope that a Dataset-level assertion applies to.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>DATASET_COLUMN</td><td><p>Assertion applies to columns of a dataset.</p></td></tr><tr><td>DATASET_ROWS</td><td><p>Assertion applies to rows of a dataset.</p></td></tr><tr><td>DATASET_SCHEMA</td><td><p>Assertion applies to schema of a dataset.</p></td></tr><tr><td>UNKNOWN</td><td><p>The scope of an assertion is unknown.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="datasetfiltertype">DatasetFilterType<a href="#datasetfiltertype" class="hash-link" aria-label="Direct link to DatasetFilterType" title="Direct link to DatasetFilterType"></a></h2><p>Type of partition</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>SQL</td><td><p>Use a SQL string to apply the filter</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="datasetlineagetype">DatasetLineageType<a href="#datasetlineagetype" class="hash-link" aria-label="Direct link to DatasetLineageType" title="Direct link to DatasetLineageType"></a></h2><p>Deprecated
|
||
The type of an edge between two Datasets</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>COPY</td><td><p>Direct copy without modification</p></td></tr><tr><td>TRANSFORMED</td><td><p>Transformed dataset</p></td></tr><tr><td>VIEW</td><td><p>Represents a view defined on the sources</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="dateinterval">DateInterval<a href="#dateinterval" class="hash-link" aria-label="Direct link to DateInterval" title="Direct link to DateInterval"></a></h2><p>For consumption by UI only</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>SECOND</td><td></td></tr><tr><td>MINUTE</td><td></td></tr><tr><td>HOUR</td><td></td></tr><tr><td>DAY</td><td></td></tr><tr><td>WEEK</td><td></td></tr><tr><td>MONTH</td><td></td></tr><tr><td>YEAR</td><td></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="entitytype">EntityType<a href="#entitytype" class="hash-link" aria-label="Direct link to EntityType" title="Direct link to EntityType"></a></h2><p>A top level Metadata Entity Type</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>DOMAIN</td><td><p>A Domain containing Metadata Entities</p></td></tr><tr><td>DATASET</td><td><p>The Dataset Entity</p></td></tr><tr><td>CORP_USER</td><td><p>The CorpUser Entity</p></td></tr><tr><td>CORP_GROUP</td><td><p>The CorpGroup Entity</p></td></tr><tr><td>DATA_PLATFORM</td><td><p>The DataPlatform Entity</p></td></tr><tr><td>ER_MODEL_RELATIONSHIP</td><td><p>The ERModelRelationship Entity</p></td></tr><tr><td>DASHBOARD</td><td><p>The Dashboard Entity</p></td></tr><tr><td>NOTEBOOK</td><td><p>The Notebook Entity</p></td></tr><tr><td>CHART</td><td><p>The Chart Entity</p></td></tr><tr><td>DATA_FLOW</td><td><p>The Data Flow (or Data Pipeline) Entity,</p></td></tr><tr><td>DATA_JOB</td><td><p>The Data Job (or Data Task) Entity</p></td></tr><tr><td>TAG</td><td><p>The Tag Entity</p></td></tr><tr><td>GLOSSARY_TERM</td><td><p>The Glossary Term Entity</p></td></tr><tr><td>GLOSSARY_NODE</td><td><p>The Glossary Node Entity</p></td></tr><tr><td>CONTAINER</td><td><p>A container of Metadata Entities</p></td></tr><tr><td>MLMODEL</td><td><p>The ML Model Entity</p></td></tr><tr><td>MLMODEL_GROUP</td><td><p>The MLModelGroup Entity</p></td></tr><tr><td>MLFEATURE_TABLE</td><td><p>ML Feature Table Entity</p></td></tr><tr><td>MLFEATURE</td><td><p>The ML Feature Entity</p></td></tr><tr><td>MLPRIMARY_KEY</td><td><p>The ML Primary Key Entity</p></td></tr><tr><td>INGESTION_SOURCE</td><td><p>A DataHub Managed Ingestion Source</p></td></tr><tr><td>EXECUTION_REQUEST</td><td><p>A DataHub ExecutionRequest</p></td></tr><tr><td>ASSERTION</td><td><p>A DataHub Assertion</p></td></tr><tr><td>DATA_PROCESS_INSTANCE</td><td><p>An instance of an individual run of a data job or data flow</p></td></tr><tr><td>DATA_PLATFORM_INSTANCE</td><td><p>Data Platform Instance Entity</p></td></tr><tr><td>ACCESS_TOKEN</td><td><p>A DataHub Access Token</p></td></tr><tr><td>TEST</td><td><p>A DataHub Test</p></td></tr><tr><td>DATAHUB_POLICY</td><td><p>A DataHub Policy</p></td></tr><tr><td>DATAHUB_ROLE</td><td><p>A DataHub Role</p></td></tr><tr><td>POST</td><td><p>A DataHub Post</p></td></tr><tr><td>SCHEMA_FIELD</td><td><p>A Schema Field</p></td></tr><tr><td>DATAHUB_VIEW</td><td><p>A DataHub View</p></td></tr><tr><td>QUERY</td><td><p>A dataset query</p></td></tr><tr><td>DATA_PRODUCT</td><td><p>A Data Product</p></td></tr><tr><td>CUSTOM_OWNERSHIP_TYPE</td><td><p>A Custom Ownership Type</p></td></tr><tr><td>DATAHUB_CONNECTION</td><td><p>A connection to an external source.</p></td></tr><tr><td>INCIDENT</td><td><p>A DataHub incident - SaaS only</p></td></tr><tr><td>ROLE</td><td><p>" A Role from an organisation</p></td></tr><tr><td>DATA_CONTRACT</td><td><p>A data contract</p></td></tr><tr><td>STRUCTURED_PROPERTY</td><td><p>" An structured property on entities</p></td></tr><tr><td>FORM</td><td><p>" A form entity on entities</p></td></tr><tr><td>DATA_TYPE</td><td><p>" A data type registered to DataHub</p></td></tr><tr><td>ENTITY_TYPE</td><td><p>" A type of entity registered to DataHub</p></td></tr><tr><td>RESTRICTED</td><td><p>" A type of entity that is restricted to the user</p></td></tr><tr><td>OTHER</td><td><p>Another entity type - refer to a provided entity type urn.</p></td></tr><tr><td>BUSINESS_ATTRIBUTE</td><td><p>A Business Attribute</p></td></tr><tr><td>VERSION_SET</td><td><p>A set of versioned entities, representing a single source / logical entity over time</p></td></tr><tr><td>APPLICATION</td><td><p>An application</p></td></tr><tr><td>DATAHUB_PAGE_TEMPLATE</td><td><p>An DataHub Page Template</p></td></tr><tr><td>DATAHUB_PAGE_MODULE</td><td><p>An DataHub Page Module</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="fabrictype">FabricType<a href="#fabrictype" class="hash-link" aria-label="Direct link to FabricType" title="Direct link to FabricType"></a></h2><p>An environment identifier for a particular Entity, ie staging or production
|
||
Note that this model will soon be deprecated in favor of a more general purpose of notion
|
||
of data environment</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>DEV</td><td><p>Designates development fabrics</p></td></tr><tr><td>TEST</td><td><p>Designates testing fabrics</p></td></tr><tr><td>QA</td><td><p>Designates quality assurance fabrics</p></td></tr><tr><td>UAT</td><td><p>Designates user acceptance testing fabrics</p></td></tr><tr><td>EI</td><td><p>Designates early integration fabrics</p></td></tr><tr><td>PRE</td><td><p>Designates pre-production fabrics</p></td></tr><tr><td>STG</td><td><p>Designates staging fabrics</p></td></tr><tr><td>NON_PROD</td><td><p>Designates non-production fabrics</p></td></tr><tr><td>PROD</td><td><p>Designates production fabrics</p></td></tr><tr><td>CORP</td><td><p>Designates corporation fabrics</p></td></tr><tr><td>RVW</td><td><p>Designates review fabrics</p></td></tr><tr><td>SANDBOX</td><td><p>Designates sandbox fabrics</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="fieldassertiontype">FieldAssertionType<a href="#fieldassertiontype" class="hash-link" aria-label="Direct link to FieldAssertionType" title="Direct link to FieldAssertionType"></a></h2><p>The type of a Field assertion</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>FIELD_VALUES</td><td><p>An assertion used to validate the values contained with a field / column given a set of rows.</p></td></tr><tr><td>FIELD_METRIC</td><td><p>An assertion used to validate the value of a common field / column metric (e.g. aggregation) such as null count + percentage, min, max, median, and more.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="fieldmetrictype">FieldMetricType<a href="#fieldmetrictype" class="hash-link" aria-label="Direct link to FieldMetricType" title="Direct link to FieldMetricType"></a></h2><p>A standard metric that can be derived from the set of values
|
||
for a specific field / column of a dataset / table.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>UNIQUE_COUNT</td><td><p>The number of unique values found in the column value set</p></td></tr><tr><td>UNIQUE_PERCENTAGE</td><td><p>The percentage of unique values to total rows for the dataset</p></td></tr><tr><td>NULL_COUNT</td><td><p>The number of null values found in the column value set</p></td></tr><tr><td>NULL_PERCENTAGE</td><td><p>The percentage of null values to total rows for the dataset</p></td></tr><tr><td>MIN</td><td><p>The minimum value in the column set (applies to numeric columns)</p></td></tr><tr><td>MAX</td><td><p>The maximum value in the column set (applies to numeric columns)</p></td></tr><tr><td>MEAN</td><td><p>The mean length found in the column set (applies to numeric columns)</p></td></tr><tr><td>MEDIAN</td><td><p>The median length found in the column set (applies to numeric columns)</p></td></tr><tr><td>STDDEV</td><td><p>The stddev length found in the column set (applies to numeric columns)</p></td></tr><tr><td>NEGATIVE_COUNT</td><td><p>The number of negative values found in the value set (applies to numeric columns)</p></td></tr><tr><td>NEGATIVE_PERCENTAGE</td><td><p>The percentage of negative values to total rows for the dataset (applies to numeric columns)</p></td></tr><tr><td>ZERO_COUNT</td><td><p>The number of zero values found in the value set (applies to numeric columns)</p></td></tr><tr><td>ZERO_PERCENTAGE</td><td><p>The percentage of zero values to total rows for the dataset (applies to numeric columns)</p></td></tr><tr><td>MIN_LENGTH</td><td><p>The minimum length found in the column set (applies to string columns)</p></td></tr><tr><td>MAX_LENGTH</td><td><p>The maximum length found in the column set (applies to string columns)</p></td></tr><tr><td>EMPTY_COUNT</td><td><p>The number of empty string values found in the value set (applies to string columns). Note: This is a completely different metric different from NULL_COUNT!</p></td></tr><tr><td>EMPTY_PERCENTAGE</td><td><p>The percentage of empty string values to total rows for the dataset (applies to string columns). Note: This is a completely different metric different from NULL_PERCENTAGE!</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="fieldtransformtype">FieldTransformType<a href="#fieldtransformtype" class="hash-link" aria-label="Direct link to FieldTransformType" title="Direct link to FieldTransformType"></a></h2><p>The type of the Field Transform</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>LENGTH</td><td><p>Obtain the length of a string field / column (applicable to string types)</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="fieldvaluesfailthresholdtype">FieldValuesFailThresholdType<a href="#fieldvaluesfailthresholdtype" class="hash-link" aria-label="Direct link to FieldValuesFailThresholdType" title="Direct link to FieldValuesFailThresholdType"></a></h2><p>The type of failure threshold.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>COUNT</td><td><p>The maximum number of column values (i.e. rows) that are allowed to fail the defined expectations before the assertion officially fails.</p></td></tr><tr><td>PERCENTAGE</td><td><p>The maximum percentage of rows that are allowed to fail the defined column expectations before the assertion officially fails.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="filteroperator">FilterOperator<a href="#filteroperator" class="hash-link" aria-label="Direct link to FilterOperator" title="Direct link to FilterOperator"></a></h2><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>CONTAIN</td><td><p>Represent the relation: String field contains value, e.g. name contains Profile</p></td></tr><tr><td>EQUAL</td><td><p>Represent the relation: field = value, e.g. platform = hdfs</p></td></tr><tr><td>IEQUAL</td><td><p>Represent the relation: field = value (case-insensitive), e.g. platform = HDFS</p></td></tr><tr><td>IN</td><td><ul><li>Represent the relation: String field is one of the array values to, e.g. name in ["Profile", "Event"]</li></ul></td></tr><tr><td>EXISTS</td><td><p>Represents the relation: The field exists. If the field is an array, the field is either not present or empty.</p></td></tr><tr><td>GREATER_THAN</td><td><p>Represent the relation greater than, e.g. ownerCount > 5</p></td></tr><tr><td>GREATER_THAN_OR_EQUAL_TO</td><td><p>Represent the relation greater than or equal to, e.g. ownerCount >= 5</p></td></tr><tr><td>LESS_THAN</td><td><p>Represent the relation less than, e.g. ownerCount < 3</p></td></tr><tr><td>LESS_THAN_OR_EQUAL_TO</td><td><p>Represent the relation less than or equal to, e.g. ownerCount <= 3</p></td></tr><tr><td>START_WITH</td><td><p>Represent the relation: String field starts with value, e.g. name starts with PageView</p></td></tr><tr><td>END_WITH</td><td><p>Represent the relation: String field ends with value, e.g. name ends with Event</p></td></tr><tr><td>DESCENDANTS_INCL</td><td><p>Represent the relation: URN field any nested children in addition to the given URN</p></td></tr><tr><td>ANCESTORS_INCL</td><td><p>Represent the relation: URN field matches any nested parent in addition to the given URN</p></td></tr><tr><td>RELATED_INCL</td><td><p>Represent the relation: URN field matches any nested child or parent in addition to the given URN</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="formprompttype">FormPromptType<a href="#formprompttype" class="hash-link" aria-label="Direct link to FormPromptType" title="Direct link to FormPromptType"></a></h2><p>Enum of all form prompt types</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>STRUCTURED_PROPERTY</td><td><p>A structured property form prompt type.</p></td></tr><tr><td>FIELDS_STRUCTURED_PROPERTY</td><td><p>A schema field-level structured property form prompt type.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="formtype">FormType<a href="#formtype" class="hash-link" aria-label="Direct link to FormType" title="Direct link to FormType"></a></h2><p>The type of a form. This is optional on a form entity</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>VERIFICATION</td><td><p>This form is used for "verifying" entities as a state for governance and compliance</p></td></tr><tr><td>COMPLETION</td><td><p>This form is used to help with filling out metadata on entities</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="freshnessassertionscheduletype">FreshnessAssertionScheduleType<a href="#freshnessassertionscheduletype" class="hash-link" aria-label="Direct link to FreshnessAssertionScheduleType" title="Direct link to FreshnessAssertionScheduleType"></a></h2><p>The type of an Freshness assertion</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>CRON</td><td><p>An schedule based on a CRON schedule representing the expected event times.</p></td></tr><tr><td>FIXED_INTERVAL</td><td><p>A scheduled based on a recurring fixed schedule which is used to compute the expected operation window. E.g. "every 24 hours".</p></td></tr><tr><td>SINCE_THE_LAST_CHECK</td><td><p>A schedule computed based on when the assertion was last evaluated, to the current moment in time.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="freshnessassertiontype">FreshnessAssertionType<a href="#freshnessassertiontype" class="hash-link" aria-label="Direct link to FreshnessAssertionType" title="Direct link to FreshnessAssertionType"></a></h2><p>The type of an Freshness assertion</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>DATASET_CHANGE</td><td><p>An assertion defined against a Dataset Change Operation - insert, update, delete, etc</p></td></tr><tr><td>DATA_JOB_RUN</td><td><p>An assertion defined against a Data Job run</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="healthstatus">HealthStatus<a href="#healthstatus" class="hash-link" aria-label="Direct link to HealthStatus" title="Direct link to HealthStatus"></a></h2><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>PASS</td><td><p>The Asset is in a healthy state</p></td></tr><tr><td>WARN</td><td><p>The Asset is in a warning state</p></td></tr><tr><td>FAIL</td><td><p>The Asset is in a failing (unhealthy) state</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="healthstatustype">HealthStatusType<a href="#healthstatustype" class="hash-link" aria-label="Direct link to HealthStatusType" title="Direct link to HealthStatusType"></a></h2><p>The type of the health status</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>ASSERTIONS</td><td><p>Assertions status</p></td></tr><tr><td>INCIDENTS</td><td><p>Incidents status</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="iconlibrary">IconLibrary<a href="#iconlibrary" class="hash-link" aria-label="Direct link to IconLibrary" title="Direct link to IconLibrary"></a></h2><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>MATERIAL</td><td><p>Icons from the Material UI icon library</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="incidentpriority">IncidentPriority<a href="#incidentpriority" class="hash-link" aria-label="Direct link to IncidentPriority" title="Direct link to IncidentPriority"></a></h2><p>The priority of the incident</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>LOW</td><td><p>A low priority incident (P3)</p></td></tr><tr><td>MEDIUM</td><td><p>A medium priority incident (P2)</p></td></tr><tr><td>HIGH</td><td><p>A high priority incident (P1)</p></td></tr><tr><td>CRITICAL</td><td><p>A critical priority incident (P0)</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="incidentsourcetype">IncidentSourceType<a href="#incidentsourcetype" class="hash-link" aria-label="Direct link to IncidentSourceType" title="Direct link to IncidentSourceType"></a></h2><p>The source type of an incident, implying how it was created.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>MANUAL</td><td><p>The incident was created manually, from either the API or the UI.</p></td></tr><tr><td>ASSERTION_FAILURE</td><td><p>An assertion has failed, triggering the incident.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="incidentstage">IncidentStage<a href="#incidentstage" class="hash-link" aria-label="Direct link to IncidentStage" title="Direct link to IncidentStage"></a></h2><p>The lifecycle stage of the incident.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>TRIAGE</td><td><p>The impact and priority of the incident is being actively assessed.</p></td></tr><tr><td>INVESTIGATION</td><td><p>The incident root cause is being investigated.</p></td></tr><tr><td>WORK_IN_PROGRESS</td><td><p>The incident is in the remediation stage.</p></td></tr><tr><td>FIXED</td><td><p>The incident is in the resolved as completed stage.</p></td></tr><tr><td>NO_ACTION_REQUIRED</td><td><p>The incident is in the resolved with no action required state, e.g., the incident was a false positive, or was expected.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="incidentstate">IncidentState<a href="#incidentstate" class="hash-link" aria-label="Direct link to IncidentState" title="Direct link to IncidentState"></a></h2><p>The state of an incident.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>ACTIVE</td><td><p>The incident is ongoing, or active.</p></td></tr><tr><td>RESOLVED</td><td><p>The incident is resolved.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="incidenttype">IncidentType<a href="#incidenttype" class="hash-link" aria-label="Direct link to IncidentType" title="Direct link to IncidentType"></a></h2><p>A specific type of incident</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>FRESHNESS</td><td><p>A Freshness Assertion has failed, triggering the incident. Raised on assets where assertions are configured to generate incidents.</p></td></tr><tr><td>VOLUME</td><td><p>A Volume Assertion has failed, triggering the incident. Raised on assets where assertions are configured to generate incidents.</p></td></tr><tr><td>FIELD</td><td><p>A Field Assertion has failed, triggering the incident. Raised on assets where assertions are configured to generate incidents.</p></td></tr><tr><td>SQL</td><td><p>A SQL Assertion has failed, triggering the incident. Raised on assets where assertions are configured to generate incidents.</p></td></tr><tr><td>DATA_SCHEMA</td><td><p>A Schema has failed, triggering the incident. Raised on assets where assertions are configured to generate incidents.</p></td></tr><tr><td>OPERATIONAL</td><td><p>An operational incident, e.g. failure to materialize a dataset, or failure to execute a task / pipeline.</p></td></tr><tr><td>CUSTOM</td><td><p>A custom type of incident</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="incrementingsegmentfieldtransformertype">IncrementingSegmentFieldTransformerType<a href="#incrementingsegmentfieldtransformertype" class="hash-link" aria-label="Direct link to IncrementingSegmentFieldTransformerType" title="Direct link to IncrementingSegmentFieldTransformerType"></a></h2><p>The 'standard' transformer type. Note that not all source systems will support all operators.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>TIMESTAMP_MS_TO_MINUTE</td><td><p>Rounds a timestamp (in seconds) down to the start of the month.</p></td></tr><tr><td>TIMESTAMP_MS_TO_HOUR</td><td><p>Rounds a timestamp (in milliseconds) down to the nearest hour.</p></td></tr><tr><td>TIMESTAMP_MS_TO_DATE</td><td><p>Rounds a timestamp (in milliseconds) down to the start of the day.</p></td></tr><tr><td>TIMESTAMP_MS_TO_MONTH</td><td><p>Rounds a timestamp (in milliseconds) down to the start of the month</p></td></tr><tr><td>TIMESTAMP_MS_TO_YEAR</td><td><p>Rounds a timestamp (in milliseconds) down to the start of the year</p></td></tr><tr><td>FLOOR</td><td><p>Rounds a numeric value down to the nearest integer.</p></td></tr><tr><td>CEILING</td><td><p>Rounds a numeric value up to the nearest integer.</p></td></tr><tr><td>NATIVE</td><td><p>A backdoor to provide a native operator type specific to a given source system like Snowflake, Redshift, BQ, etc.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="intendedusertype">IntendedUserType<a href="#intendedusertype" class="hash-link" aria-label="Direct link to IntendedUserType" title="Direct link to IntendedUserType"></a></h2><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>ENTERPRISE</td><td><p>Developed for Enterprise Users</p></td></tr><tr><td>HOBBY</td><td><p>Developed for Hobbyists</p></td></tr><tr><td>ENTERTAINMENT</td><td><p>Developed for Entertainment Purposes</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="lineagedirection">LineageDirection<a href="#lineagedirection" class="hash-link" aria-label="Direct link to LineageDirection" title="Direct link to LineageDirection"></a></h2><p>Direction between two nodes in the lineage graph</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>UPSTREAM</td><td><p>Upstream, or left-to-right in the lineage visualization</p></td></tr><tr><td>DOWNSTREAM</td><td><p>Downstream, or right-to-left in the lineage visualization</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="lineagesearchpath">LineageSearchPath<a href="#lineagesearchpath" class="hash-link" aria-label="Direct link to LineageSearchPath" title="Direct link to LineageSearchPath"></a></h2><p>The path taken when doing search across lineage</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>TORTOISE</td><td><p>Designates the tortoise lineage code path</p></td></tr><tr><td>LIGHTNING</td><td><p>Designates the lightning lineage code path</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="logicaloperator">LogicalOperator<a href="#logicaloperator" class="hash-link" aria-label="Direct link to LogicalOperator" title="Direct link to LogicalOperator"></a></h2><p>A Logical Operator, AND or OR.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>AND</td><td><p>An AND operator.</p></td></tr><tr><td>OR</td><td><p>An OR operator.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="mediatype">MediaType<a href="#mediatype" class="hash-link" aria-label="Direct link to MediaType" title="Direct link to MediaType"></a></h2><p>The type of media</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>IMAGE</td><td><p>An image</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="mlfeaturedatatype">MLFeatureDataType<a href="#mlfeaturedatatype" class="hash-link" aria-label="Direct link to MLFeatureDataType" title="Direct link to MLFeatureDataType"></a></h2><p>The data type associated with an individual Machine Learning Feature</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>USELESS</td><td></td></tr><tr><td>NOMINAL</td><td></td></tr><tr><td>ORDINAL</td><td></td></tr><tr><td>BINARY</td><td></td></tr><tr><td>COUNT</td><td></td></tr><tr><td>TIME</td><td></td></tr><tr><td>INTERVAL</td><td></td></tr><tr><td>IMAGE</td><td></td></tr><tr><td>VIDEO</td><td></td></tr><tr><td>AUDIO</td><td></td></tr><tr><td>TEXT</td><td></td></tr><tr><td>MAP</td><td></td></tr><tr><td>SEQUENCE</td><td></td></tr><tr><td>SET</td><td></td></tr><tr><td>CONTINUOUS</td><td></td></tr><tr><td>BYTE</td><td></td></tr><tr><td>UNKNOWN</td><td></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="notebookcelltype">NotebookCellType<a href="#notebookcelltype" class="hash-link" aria-label="Direct link to NotebookCellType" title="Direct link to NotebookCellType"></a></h2><p>The type for a NotebookCell</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>TEXT_CELL</td><td><p>TEXT Notebook cell type. The cell context is text only.</p></td></tr><tr><td>QUERY_CELL</td><td><p>QUERY Notebook cell type. The cell context is query only.</p></td></tr><tr><td>CHART_CELL</td><td><p>CHART Notebook cell type. The cell content is chart only.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="operationsourcetype">OperationSourceType<a href="#operationsourcetype" class="hash-link" aria-label="Direct link to OperationSourceType" title="Direct link to OperationSourceType"></a></h2><p>Enum to define the source/reporter type for an Operation.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>DATA_PROCESS</td><td><p>A data process reported the operation.</p></td></tr><tr><td>DATA_PLATFORM</td><td><p>A data platform reported the operation.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="operationtype">OperationType<a href="#operationtype" class="hash-link" aria-label="Direct link to OperationType" title="Direct link to OperationType"></a></h2><p>Enum to define the operation type when an entity changes.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>INSERT</td><td><p>When data is inserted.</p></td></tr><tr><td>UPDATE</td><td><p>When data is updated.</p></td></tr><tr><td>DELETE</td><td><p>When data is deleted.</p></td></tr><tr><td>CREATE</td><td><p>When table is created.</p></td></tr><tr><td>ALTER</td><td><p>When table is altered</p></td></tr><tr><td>DROP</td><td><p>When table is dropped</p></td></tr><tr><td>UNKNOWN</td><td><p>Unknown operation</p></td></tr><tr><td>CUSTOM</td><td><p>Custom</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="origintype">OriginType<a href="#origintype" class="hash-link" aria-label="Direct link to OriginType" title="Direct link to OriginType"></a></h2><p>Enum to define where an entity originated from.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>NATIVE</td><td><p>The entity is native to DataHub.</p></td></tr><tr><td>EXTERNAL</td><td><p>The entity is external to DataHub.</p></td></tr><tr><td>UNKNOWN</td><td><p>The entity is of unknown origin.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="ownerentitytype">OwnerEntityType<a href="#ownerentitytype" class="hash-link" aria-label="Direct link to OwnerEntityType" title="Direct link to OwnerEntityType"></a></h2><p>Entities that are able to own other entities</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>CORP_USER</td><td><p>A corp user owner</p></td></tr><tr><td>CORP_GROUP</td><td><p>A corp group owner</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="ownershipsourcetype">OwnershipSourceType<a href="#ownershipsourcetype" class="hash-link" aria-label="Direct link to OwnershipSourceType" title="Direct link to OwnershipSourceType"></a></h2><p>The origin of Ownership metadata associated with a Metadata Entity</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>AUDIT</td><td><p>Auditing system or audit logs</p></td></tr><tr><td>DATABASE</td><td><p>Database, eg GRANTS table</p></td></tr><tr><td>FILE_SYSTEM</td><td><p>File system, eg file or directory owner</p></td></tr><tr><td>ISSUE_TRACKING_SYSTEM</td><td><p>Issue tracking system, eg Jira</p></td></tr><tr><td>MANUAL</td><td><p>Manually provided by a user</p></td></tr><tr><td>SERVICE</td><td><p>Other ownership like service, eg Nuage, ACL service etc</p></td></tr><tr><td>SOURCE_CONTROL</td><td><p>SCM system, eg GIT, SVN</p></td></tr><tr><td>OTHER</td><td><p>Other sources</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="ownershiptype">OwnershipType<a href="#ownershiptype" class="hash-link" aria-label="Direct link to OwnershipType" title="Direct link to OwnershipType"></a></h2><p>The type of the ownership relationship between a Person and a Metadata Entity
|
||
Note that this field will soon become deprecated due to low usage</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>TECHNICAL_OWNER</td><td><p>A person or group who is responsible for technical aspects of the asset.</p></td></tr><tr><td>BUSINESS_OWNER</td><td><p>A person or group who is responsible for logical, or business related, aspects of the asset.</p></td></tr><tr><td>DATA_STEWARD</td><td><p>A steward, expert, or delegate responsible for the asset.</p></td></tr><tr><td>NONE</td><td><p>No specific type associated with the owner.</p></td></tr><tr><td>CUSTOM</td><td><p>Associated ownership type is a custom ownership type. Please check OwnershipTypeEntity urn for custom value.</p></td></tr><tr><td>DATAOWNER</td><td><p>A person or group that owns the data. Deprecated! This ownership type is no longer supported. Use TECHNICAL_OWNER instead.</p></td></tr><tr><td>DEVELOPER</td><td><p>A person or group that is in charge of developing the code Deprecated! This ownership type is no longer supported. Use TECHNICAL_OWNER instead.</p></td></tr><tr><td>DELEGATE</td><td><p>A person or a group that overseas the operation, eg a DBA or SRE Deprecated! This ownership type is no longer supported. Use TECHNICAL_OWNER instead.</p></td></tr><tr><td>PRODUCER</td><td><p>A person, group, or service that produces or generates the data Deprecated! This ownership type is no longer supported. Use TECHNICAL_OWNER instead.</p></td></tr><tr><td>STAKEHOLDER</td><td><p>A person or a group that has direct business interest Deprecated! Use BUSINESS_OWNER instead.</p></td></tr><tr><td>CONSUMER</td><td><p>A person, group, or service that consumes the data Deprecated! This ownership type is no longer supported.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="pagemodulescope">PageModuleScope<a href="#pagemodulescope" class="hash-link" aria-label="Direct link to PageModuleScope" title="Direct link to PageModuleScope"></a></h2><p>Different scopes for where this module is relevant</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>PERSONAL</td><td><p>This module is used for individual use only</p></td></tr><tr><td>GLOBAL</td><td><p>This module is used across users</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="pagetemplatescope">PageTemplateScope<a href="#pagetemplatescope" class="hash-link" aria-label="Direct link to PageTemplateScope" title="Direct link to PageTemplateScope"></a></h2><p>Different scopes for where this template is relevant</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>PERSONAL</td><td><p>This template is used for individual use only</p></td></tr><tr><td>GLOBAL</td><td><p>This template is used across users</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="pagetemplatesurfacetype">PageTemplateSurfaceType<a href="#pagetemplatesurfacetype" class="hash-link" aria-label="Direct link to PageTemplateSurfaceType" title="Direct link to PageTemplateSurfaceType"></a></h2><p>Different surface areas for a page template</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>HOME_PAGE</td><td><p>This template applies to what to display on the home page for users.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="partitiontype">PartitionType<a href="#partitiontype" class="hash-link" aria-label="Direct link to PartitionType" title="Direct link to PartitionType"></a></h2><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>FULL_TABLE</td><td></td></tr><tr><td>QUERY</td><td></td></tr><tr><td>PARTITION</td><td></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="personalsidebarsection">PersonalSidebarSection<a href="#personalsidebarsection" class="hash-link" aria-label="Direct link to PersonalSidebarSection" title="Direct link to PersonalSidebarSection"></a></h2><p>Variants of APIs used in the Search bar to get data</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>YOUR_GROUPS</td><td><p>The section containing groups you are in</p></td></tr><tr><td>YOUR_ASSETS</td><td><p>The section containing assets you own</p></td></tr><tr><td>YOUR_DOMAINS</td><td><p>The section containing domains you own</p></td></tr><tr><td>YOUR_GLOSSARY_NODES</td><td><p>The section containing glossary nodes you own</p></td></tr><tr><td>YOUR_TAGS</td><td><p>The section containing tags you own</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="platformnativetype">PlatformNativeType<a href="#platformnativetype" class="hash-link" aria-label="Direct link to PlatformNativeType" title="Direct link to PlatformNativeType"></a></h2><p>Deprecated, do not use this type
|
||
The logical type associated with an individual Dataset</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>TABLE</td><td><p>Table</p></td></tr><tr><td>VIEW</td><td><p>View</p></td></tr><tr><td>DIRECTORY</td><td><p>Directory in file system</p></td></tr><tr><td>STREAM</td><td><p>Stream</p></td></tr><tr><td>BUCKET</td><td><p>Bucket in key value store</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="platformtype">PlatformType<a href="#platformtype" class="hash-link" aria-label="Direct link to PlatformType" title="Direct link to PlatformType"></a></h2><p>The category of a specific Data Platform</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>FILE_SYSTEM</td><td><p>Value for a file system</p></td></tr><tr><td>KEY_VALUE_STORE</td><td><p>Value for a key value store</p></td></tr><tr><td>MESSAGE_BROKER</td><td><p>Value for a message broker</p></td></tr><tr><td>OBJECT_STORE</td><td><p>Value for an object store</p></td></tr><tr><td>OLAP_DATASTORE</td><td><p>Value for an OLAP datastore</p></td></tr><tr><td>QUERY_ENGINE</td><td><p>Value for a query engine</p></td></tr><tr><td>RELATIONAL_DB</td><td><p>Value for a relational database</p></td></tr><tr><td>SEARCH_ENGINE</td><td><p>Value for a search engine</p></td></tr><tr><td>OTHERS</td><td><p>Value for other platforms</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="policymatchcondition">PolicyMatchCondition<a href="#policymatchcondition" class="hash-link" aria-label="Direct link to PolicyMatchCondition" title="Direct link to PolicyMatchCondition"></a></h2><p>Match condition</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>EQUALS</td><td><p>Whether the field matches the value</p></td></tr><tr><td>STARTS_WITH</td><td><p>Whether the field value starts with the value</p></td></tr><tr><td>NOT_EQUALS</td><td><p>Whether the field does not match the value</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="policystate">PolicyState<a href="#policystate" class="hash-link" aria-label="Direct link to PolicyState" title="Direct link to PolicyState"></a></h2><p>The state of an Access Policy</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>DRAFT</td><td><p>A Policy that has not been officially created, but in progress Currently unused</p></td></tr><tr><td>ACTIVE</td><td><p>A Policy that is active and being enforced</p></td></tr><tr><td>INACTIVE</td><td><p>A Policy that is not active or being enforced</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="policytype">PolicyType<a href="#policytype" class="hash-link" aria-label="Direct link to PolicyType" title="Direct link to PolicyType"></a></h2><p>The type of the Access Policy</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>METADATA</td><td><p>An access policy that grants privileges pertaining to Metadata Entities</p></td></tr><tr><td>PLATFORM</td><td><p>An access policy that grants top level administrative privileges pertaining to the DataHub Platform itself</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="postcontenttype">PostContentType<a href="#postcontenttype" class="hash-link" aria-label="Direct link to PostContentType" title="Direct link to PostContentType"></a></h2><p>The type of post</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>TEXT</td><td><p>Text content</p></td></tr><tr><td>LINK</td><td><p>Link content</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="posttype">PostType<a href="#posttype" class="hash-link" aria-label="Direct link to PostType" title="Direct link to PostType"></a></h2><p>The type of post</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>HOME_PAGE_ANNOUNCEMENT</td><td><p>Posts on the home page</p></td></tr><tr><td>ENTITY_ANNOUNCEMENT</td><td><p>Posts on an entity page</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="propertycardinality">PropertyCardinality<a href="#propertycardinality" class="hash-link" aria-label="Direct link to PropertyCardinality" title="Direct link to PropertyCardinality"></a></h2><p>The cardinality of a Structured Property determining whether one or multiple values
|
||
can be applied to the entity from this property.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>SINGLE</td><td><p>Only one value of this property can applied to an entity</p></td></tr><tr><td>MULTIPLE</td><td><p>Multiple values of this property can applied to an entity</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="querylanguage">QueryLanguage<a href="#querylanguage" class="hash-link" aria-label="Direct link to QueryLanguage" title="Direct link to QueryLanguage"></a></h2><p>A query language / dialect.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>SQL</td><td><p>Standard ANSI SQL</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="querysource">QuerySource<a href="#querysource" class="hash-link" aria-label="Direct link to QuerySource" title="Direct link to QuerySource"></a></h2><p>The source of the query</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>MANUAL</td><td><p>The query was provided manually, e.g. from the UI.</p></td></tr><tr><td>SYSTEM</td><td><p>The query was extracted by the system, e.g. from a dashboard.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="recommendationrendertype">RecommendationRenderType<a href="#recommendationrendertype" class="hash-link" aria-label="Direct link to RecommendationRenderType" title="Direct link to RecommendationRenderType"></a></h2><p>Enum that defines how the modules should be rendered.
|
||
There should be two frontend implementation of large and small modules per type.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>ENTITY_NAME_LIST</td><td><p>Simple list of entities</p></td></tr><tr><td>PLATFORM_SEARCH_LIST</td><td><p>List of platforms</p></td></tr><tr><td>TAG_SEARCH_LIST</td><td><p>Tag search list</p></td></tr><tr><td>SEARCH_QUERY_LIST</td><td><p>A list of recommended search queries</p></td></tr><tr><td>GLOSSARY_TERM_SEARCH_LIST</td><td><p>Glossary Term search list</p></td></tr><tr><td>DOMAIN_SEARCH_LIST</td><td><p>Domain Search List</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="relationshipdirection">RelationshipDirection<a href="#relationshipdirection" class="hash-link" aria-label="Direct link to RelationshipDirection" title="Direct link to RelationshipDirection"></a></h2><p>Direction between a source and destination node</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>INCOMING</td><td><p>A directed edge pointing at the source Entity</p></td></tr><tr><td>OUTGOING</td><td><p>A directed edge pointing at the destination Entity</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="scenariotype">ScenarioType<a href="#scenariotype" class="hash-link" aria-label="Direct link to ScenarioType" title="Direct link to ScenarioType"></a></h2><p>Type of the scenario requesting recommendation</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>HOME</td><td><p>Recommendations to show on the users home page</p></td></tr><tr><td>SEARCH_RESULTS</td><td><p>Recommendations to show on the search results page</p></td></tr><tr><td>ENTITY_PROFILE</td><td><p>Recommendations to show on an Entity Profile page</p></td></tr><tr><td>SEARCH_BAR</td><td><p>Recommendations to show on the search bar when clicked</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="schemaassertioncompatibility">SchemaAssertionCompatibility<a href="#schemaassertioncompatibility" class="hash-link" aria-label="Direct link to SchemaAssertionCompatibility" title="Direct link to SchemaAssertionCompatibility"></a></h2><p>Defines the required compatibility level for the schema assertion to pass.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>EXACT_MATCH</td><td><p>The schema must be exactly the same as the expected schema.</p></td></tr><tr><td>SUPERSET</td><td><p>The schema must be a superset of the expected schema.</p></td></tr><tr><td>SUBSET</td><td><p>The schema must be a subset of the expected schema.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="schemafielddatatype">SchemaFieldDataType<a href="#schemafielddatatype" class="hash-link" aria-label="Direct link to SchemaFieldDataType" title="Direct link to SchemaFieldDataType"></a></h2><p>The type associated with a single Dataset schema field</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>BOOLEAN</td><td><p>A boolean type</p></td></tr><tr><td>FIXED</td><td><p>A fixed bytestring type</p></td></tr><tr><td>STRING</td><td><p>A string type</p></td></tr><tr><td>BYTES</td><td><p>A string of bytes</p></td></tr><tr><td>NUMBER</td><td><p>A number, including integers, floats, and doubles</p></td></tr><tr><td>DATE</td><td><p>A datestrings type</p></td></tr><tr><td>TIME</td><td><p>A timestamp type</p></td></tr><tr><td>ENUM</td><td><p>An enum type</p></td></tr><tr><td>NULL</td><td><p>A NULL type</p></td></tr><tr><td>MAP</td><td><p>A map collection type</p></td></tr><tr><td>ARRAY</td><td><p>An array collection type</p></td></tr><tr><td>UNION</td><td><p>An union type</p></td></tr><tr><td>STRUCT</td><td><p>An complex struct type</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="searchbarapi">SearchBarAPI<a href="#searchbarapi" class="hash-link" aria-label="Direct link to SearchBarAPI" title="Direct link to SearchBarAPI"></a></h2><p>Variants of APIs used in the Search bar to get data</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>AUTOCOMPLETE_FOR_MULTIPLE</td><td></td></tr><tr><td>SEARCH_ACROSS_ENTITIES</td><td></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="sortorder">SortOrder<a href="#sortorder" class="hash-link" aria-label="Direct link to SortOrder" title="Direct link to SortOrder"></a></h2><p>Order for sorting</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>ASCENDING</td><td></td></tr><tr><td>DESCENDING</td><td></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="sourcecodeurltype">SourceCodeUrlType<a href="#sourcecodeurltype" class="hash-link" aria-label="Direct link to SourceCodeUrlType" title="Direct link to SourceCodeUrlType"></a></h2><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>ML_MODEL_SOURCE_CODE</td><td><p>MLModel Source Code</p></td></tr><tr><td>TRAINING_PIPELINE_SOURCE_CODE</td><td><p>Training Pipeline Source Code</p></td></tr><tr><td>EVALUATION_PIPELINE_SOURCE_CODE</td><td><p>Evaluation Pipeline Source Code</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="sqlassertiontype">SqlAssertionType<a href="#sqlassertiontype" class="hash-link" aria-label="Direct link to SqlAssertionType" title="Direct link to SqlAssertionType"></a></h2><p>The type of the SQL assertion being monitored.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>METRIC</td><td><p>A SQL Metric Assertion, e.g. one based on a numeric value returned by an arbitrary SQL query.</p></td></tr><tr><td>METRIC_CHANGE</td><td><p>A SQL assertion that is evaluated against the CHANGE in a metric assertion over time.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="stddatatype">StdDataType<a href="#stddatatype" class="hash-link" aria-label="Direct link to StdDataType" title="Direct link to StdDataType"></a></h2><p>A well-supported, standard DataHub Data Type.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>STRING</td><td><p>String data type</p></td></tr><tr><td>NUMBER</td><td><p>Number data type</p></td></tr><tr><td>URN</td><td><p>Urn data type</p></td></tr><tr><td>RICH_TEXT</td><td><p>Rich text data type. Right now this is markdown only.</p></td></tr><tr><td>DATE</td><td><p>Date data type in format YYYY-MM-DD</p></td></tr><tr><td>OTHER</td><td><p>Any other data type - refer to a provided data type urn.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="subresourcetype">SubResourceType<a href="#subresourcetype" class="hash-link" aria-label="Direct link to SubResourceType" title="Direct link to SubResourceType"></a></h2><p>A type of Metadata Entity sub resource</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>DATASET_FIELD</td><td><p>A Dataset field or column</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="termrelationshiptype">TermRelationshipType<a href="#termrelationshiptype" class="hash-link" aria-label="Direct link to TermRelationshipType" title="Direct link to TermRelationshipType"></a></h2><p>A type of Metadata Entity sub resource</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>isA</td><td><p>When a Term inherits from, or has an 'Is A' relationship with another Term</p></td></tr><tr><td>hasA</td><td><p>When a Term contains, or has a 'Has A' relationship with another Term</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="testresulttype">TestResultType<a href="#testresulttype" class="hash-link" aria-label="Direct link to TestResultType" title="Direct link to TestResultType"></a></h2><p>The result type of a test that has been run</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>SUCCESS</td><td><p>The test succeeded.</p></td></tr><tr><td>FAILURE</td><td><p>The test failed.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="timerange">TimeRange<a href="#timerange" class="hash-link" aria-label="Direct link to TimeRange" title="Direct link to TimeRange"></a></h2><p>A time range used in fetching Usage statistics</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>DAY</td><td><p>Last day</p></td></tr><tr><td>WEEK</td><td><p>Last week</p></td></tr><tr><td>MONTH</td><td><p>Last month</p></td></tr><tr><td>QUARTER</td><td><p>Last quarter</p></td></tr><tr><td>YEAR</td><td><p>Last year</p></td></tr><tr><td>ALL</td><td><p>All time</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="usersetting">UserSetting<a href="#usersetting" class="hash-link" aria-label="Direct link to UserSetting" title="Direct link to UserSetting"></a></h2><p>An individual setting type for a Corp User.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>SHOW_SIMPLIFIED_HOMEPAGE</td><td><p>Show simplified homepage</p></td></tr><tr><td>SHOW_THEME_V2</td><td><p>Show theme v2</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="volumeassertiontype">VolumeAssertionType<a href="#volumeassertiontype" class="hash-link" aria-label="Direct link to VolumeAssertionType" title="Direct link to VolumeAssertionType"></a></h2><p>A type of volume (row count) assertion</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>ROW_COUNT_TOTAL</td><td><p>A volume assertion that is evaluated against the total row count of a dataset.</p></td></tr><tr><td>ROW_COUNT_CHANGE</td><td><p>A volume assertion that is evaluated against an incremental row count of a dataset, or a row count change.</p></td></tr><tr><td>INCREMENTING_SEGMENT_ROW_COUNT_TOTAL</td><td><p>A volume assertion that checks the latest "segment" in a table based on an incrementing column to check whether it's row count falls into a particular range. This can be used to monitor the row count of an incrementing date-partition column segment.</p></td></tr><tr><td>INCREMENTING_SEGMENT_ROW_COUNT_CHANGE</td><td><p>A volume assertion that compares the row counts in neighboring "segments" or "partitions" of an incrementing column. This can be used to track changes between subsequent date partition in a table, for example.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="windowduration">WindowDuration<a href="#windowduration" class="hash-link" aria-label="Direct link to WindowDuration" title="Direct link to WindowDuration"></a></h2><p>The duration of a fixed window of time</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>DAY</td><td><p>A one day window</p></td></tr><tr><td>WEEK</td><td><p>A one week window</p></td></tr><tr><td>MONTH</td><td><p>A one month window</p></td></tr><tr><td>YEAR</td><td><p>A one year window</p></td></tr></tbody></table></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="slackUtm_uoBr"><div class="slackUtm_uoBr"><hr>Need more help? Join the conversation in <a href="https://datahub.com/slack?utm_source=docs&utm_medium=footer&utm_campaign=docs_footer&utm_content=graphql/enums">Slack!</a></div></div><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/datahub-project/datahub/blob/master/genDocs/graphql/enums.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_VsjB"></div></div></footer><div class="feedbackWrapper_mUHF"><div class="feedbackWidget_PX4d"><div class="feedbackButtons_wn3V"><strong>Is this page helpful?</strong><div><button class="feedbackButton_UgQs"><span role="img" aria-label="like" class="anticon anticon-like"><svg viewBox="64 64 896 896" focusable="false" data-icon="like" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M885.9 533.7c16.8-22.2 26.1-49.4 26.1-77.7 0-44.9-25.1-87.4-65.5-111.1a67.67 67.67 0 00-34.3-9.3H572.4l6-122.9c1.4-29.7-9.1-57.9-29.5-79.4A106.62 106.62 0 00471 99.9c-52 0-98 35-111.8 85.1l-85.9 311H144c-17.7 0-32 14.3-32 32v364c0 17.7 14.3 32 32 32h601.3c9.2 0 18.2-1.8 26.5-5.4 47.6-20.3 78.3-66.8 78.3-118.4 0-12.6-1.8-25-5.4-37 16.8-22.2 26.1-49.4 26.1-77.7 0-12.6-1.8-25-5.4-37 16.8-22.2 26.1-49.4 26.1-77.7-.2-12.6-2-25.1-5.6-37.1zM184 852V568h81v284h-81zm636.4-353l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 16.5-7.2 32.2-19.6 43l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 16.5-7.2 32.2-19.6 43l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 22.4-13.2 42.6-33.6 51.8H329V564.8l99.5-360.5a44.1 44.1 0 0142.2-32.3c7.6 0 15.1 2.2 21.1 6.7 9.9 7.4 15.2 18.6 14.6 30.5l-9.6 198.4h314.4C829 418.5 840 436.9 840 456c0 16.5-7.2 32.1-19.6 43z"></path></svg></span></button><button class="feedbackButton_UgQs"><span role="img" aria-label="dislike" class="anticon anticon-dislike"><svg viewBox="64 64 896 896" focusable="false" data-icon="dislike" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M885.9 490.3c3.6-12 5.4-24.4 5.4-37 0-28.3-9.3-55.5-26.1-77.7 3.6-12 5.4-24.4 5.4-37 0-28.3-9.3-55.5-26.1-77.7 3.6-12 5.4-24.4 5.4-37 0-51.6-30.7-98.1-78.3-118.4a66.1 66.1 0 00-26.5-5.4H144c-17.7 0-32 14.3-32 32v364c0 17.7 14.3 32 32 32h129.3l85.8 310.8C372.9 889 418.9 924 470.9 924c29.7 0 57.4-11.8 77.9-33.4 20.5-21.5 31-49.7 29.5-79.4l-6-122.9h239.9c12.1 0 23.9-3.2 34.3-9.3 40.4-23.5 65.5-66.1 65.5-111 0-28.3-9.3-55.5-26.1-77.7zM184 456V172h81v284h-81zm627.2 160.4H496.8l9.6 198.4c.6 11.9-4.7 23.1-14.6 30.5-6.1 4.5-13.6 6.8-21.1 6.7a44.28 44.28 0 01-42.2-32.3L329 459.2V172h415.4a56.85 56.85 0 0133.6 51.8c0 9.7-2.3 18.9-6.9 27.3l-13.9 25.4 21.9 19a56.76 56.76 0 0119.6 43c0 9.7-2.3 18.9-6.9 27.3l-13.9 25.4 21.9 19a56.76 56.76 0 0119.6 43c0 9.7-2.3 18.9-6.9 27.3l-14 25.5 21.9 19a56.76 56.76 0 0119.6 43c0 19.1-11 37.5-28.8 48.4z"></path></svg></span></button></div></div></div></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/graphql/unions"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Unions</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/graphql/scalars"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Scalars</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#accesslevel" class="table-of-contents__link toc-highlight">AccessLevel</a></li><li><a href="#accesstokenduration" class="table-of-contents__link toc-highlight">AccessTokenDuration</a></li><li><a href="#accesstokentype" class="table-of-contents__link toc-highlight">AccessTokenType</a></li><li><a href="#assertionactiontype" class="table-of-contents__link toc-highlight">AssertionActionType</a></li><li><a href="#assertionresulterrortype" class="table-of-contents__link toc-highlight">AssertionResultErrorType</a></li><li><a href="#assertionresulttype" class="table-of-contents__link toc-highlight">AssertionResultType</a></li><li><a href="#assertionrunstatus" class="table-of-contents__link toc-highlight">AssertionRunStatus</a></li><li><a href="#assertionsourcetype" class="table-of-contents__link toc-highlight">AssertionSourceType</a></li><li><a href="#assertionstdaggregation" class="table-of-contents__link toc-highlight">AssertionStdAggregation</a></li><li><a href="#assertionstdoperator" class="table-of-contents__link toc-highlight">AssertionStdOperator</a></li><li><a href="#assertionstdparametertype" class="table-of-contents__link toc-highlight">AssertionStdParameterType</a></li><li><a href="#assertiontype" class="table-of-contents__link toc-highlight">AssertionType</a></li><li><a href="#assertionvaluechangetype" class="table-of-contents__link toc-highlight">AssertionValueChangeType</a></li><li><a href="#changecategorytype" class="table-of-contents__link toc-highlight">ChangeCategoryType</a></li><li><a href="#changeoperationtype" class="table-of-contents__link toc-highlight">ChangeOperationType</a></li><li><a href="#chartquerytype" class="table-of-contents__link toc-highlight">ChartQueryType</a></li><li><a href="#charttype" class="table-of-contents__link toc-highlight">ChartType</a></li><li><a href="#corpuserstatus" class="table-of-contents__link toc-highlight">CorpUserStatus</a></li><li><a href="#costtype" class="table-of-contents__link toc-highlight">CostType</a></li><li><a href="#datacontractstate" class="table-of-contents__link toc-highlight">DataContractState</a></li><li><a href="#datahubconnectiondetailstype" class="table-of-contents__link toc-highlight">DataHubConnectionDetailsType</a></li><li><a href="#datahubpagemoduletype" class="table-of-contents__link toc-highlight">DataHubPageModuleType</a></li><li><a href="#datahubviewtype" class="table-of-contents__link toc-highlight">DataHubViewType</a></li><li><a href="#dataprocessinstancerunresulttype" class="table-of-contents__link toc-highlight">DataProcessInstanceRunResultType</a></li><li><a href="#dataprocessrunstatus" class="table-of-contents__link toc-highlight">DataProcessRunStatus</a></li><li><a href="#datasetassertionscope" class="table-of-contents__link toc-highlight">DatasetAssertionScope</a></li><li><a href="#datasetfiltertype" class="table-of-contents__link toc-highlight">DatasetFilterType</a></li><li><a href="#datasetlineagetype" class="table-of-contents__link toc-highlight">DatasetLineageType</a></li><li><a href="#dateinterval" class="table-of-contents__link toc-highlight">DateInterval</a></li><li><a href="#entitytype" class="table-of-contents__link toc-highlight">EntityType</a></li><li><a href="#fabrictype" class="table-of-contents__link toc-highlight">FabricType</a></li><li><a href="#fieldassertiontype" class="table-of-contents__link toc-highlight">FieldAssertionType</a></li><li><a href="#fieldmetrictype" class="table-of-contents__link toc-highlight">FieldMetricType</a></li><li><a href="#fieldtransformtype" class="table-of-contents__link toc-highlight">FieldTransformType</a></li><li><a href="#fieldvaluesfailthresholdtype" class="table-of-contents__link toc-highlight">FieldValuesFailThresholdType</a></li><li><a href="#filteroperator" class="table-of-contents__link toc-highlight">FilterOperator</a></li><li><a href="#formprompttype" class="table-of-contents__link toc-highlight">FormPromptType</a></li><li><a href="#formtype" class="table-of-contents__link toc-highlight">FormType</a></li><li><a href="#freshnessassertionscheduletype" class="table-of-contents__link toc-highlight">FreshnessAssertionScheduleType</a></li><li><a href="#freshnessassertiontype" class="table-of-contents__link toc-highlight">FreshnessAssertionType</a></li><li><a href="#healthstatus" class="table-of-contents__link toc-highlight">HealthStatus</a></li><li><a href="#healthstatustype" class="table-of-contents__link toc-highlight">HealthStatusType</a></li><li><a href="#iconlibrary" class="table-of-contents__link toc-highlight">IconLibrary</a></li><li><a href="#incidentpriority" class="table-of-contents__link toc-highlight">IncidentPriority</a></li><li><a href="#incidentsourcetype" class="table-of-contents__link toc-highlight">IncidentSourceType</a></li><li><a href="#incidentstage" class="table-of-contents__link toc-highlight">IncidentStage</a></li><li><a href="#incidentstate" class="table-of-contents__link toc-highlight">IncidentState</a></li><li><a href="#incidenttype" class="table-of-contents__link toc-highlight">IncidentType</a></li><li><a href="#incrementingsegmentfieldtransformertype" class="table-of-contents__link toc-highlight">IncrementingSegmentFieldTransformerType</a></li><li><a href="#intendedusertype" class="table-of-contents__link toc-highlight">IntendedUserType</a></li><li><a href="#lineagedirection" class="table-of-contents__link toc-highlight">LineageDirection</a></li><li><a href="#lineagesearchpath" class="table-of-contents__link toc-highlight">LineageSearchPath</a></li><li><a href="#logicaloperator" class="table-of-contents__link toc-highlight">LogicalOperator</a></li><li><a href="#mediatype" class="table-of-contents__link toc-highlight">MediaType</a></li><li><a href="#mlfeaturedatatype" class="table-of-contents__link toc-highlight">MLFeatureDataType</a></li><li><a href="#notebookcelltype" class="table-of-contents__link toc-highlight">NotebookCellType</a></li><li><a href="#operationsourcetype" class="table-of-contents__link toc-highlight">OperationSourceType</a></li><li><a href="#operationtype" class="table-of-contents__link toc-highlight">OperationType</a></li><li><a href="#origintype" class="table-of-contents__link toc-highlight">OriginType</a></li><li><a href="#ownerentitytype" class="table-of-contents__link toc-highlight">OwnerEntityType</a></li><li><a href="#ownershipsourcetype" class="table-of-contents__link toc-highlight">OwnershipSourceType</a></li><li><a href="#ownershiptype" class="table-of-contents__link toc-highlight">OwnershipType</a></li><li><a href="#pagemodulescope" class="table-of-contents__link toc-highlight">PageModuleScope</a></li><li><a href="#pagetemplatescope" class="table-of-contents__link toc-highlight">PageTemplateScope</a></li><li><a href="#pagetemplatesurfacetype" class="table-of-contents__link toc-highlight">PageTemplateSurfaceType</a></li><li><a href="#partitiontype" class="table-of-contents__link toc-highlight">PartitionType</a></li><li><a href="#personalsidebarsection" class="table-of-contents__link toc-highlight">PersonalSidebarSection</a></li><li><a href="#platformnativetype" class="table-of-contents__link toc-highlight">PlatformNativeType</a></li><li><a href="#platformtype" class="table-of-contents__link toc-highlight">PlatformType</a></li><li><a href="#policymatchcondition" class="table-of-contents__link toc-highlight">PolicyMatchCondition</a></li><li><a href="#policystate" class="table-of-contents__link toc-highlight">PolicyState</a></li><li><a href="#policytype" class="table-of-contents__link toc-highlight">PolicyType</a></li><li><a href="#postcontenttype" class="table-of-contents__link toc-highlight">PostContentType</a></li><li><a href="#posttype" class="table-of-contents__link toc-highlight">PostType</a></li><li><a href="#propertycardinality" class="table-of-contents__link toc-highlight">PropertyCardinality</a></li><li><a href="#querylanguage" class="table-of-contents__link toc-highlight">QueryLanguage</a></li><li><a href="#querysource" class="table-of-contents__link toc-highlight">QuerySource</a></li><li><a href="#recommendationrendertype" class="table-of-contents__link toc-highlight">RecommendationRenderType</a></li><li><a href="#relationshipdirection" class="table-of-contents__link toc-highlight">RelationshipDirection</a></li><li><a href="#scenariotype" class="table-of-contents__link toc-highlight">ScenarioType</a></li><li><a href="#schemaassertioncompatibility" class="table-of-contents__link toc-highlight">SchemaAssertionCompatibility</a></li><li><a href="#schemafielddatatype" class="table-of-contents__link toc-highlight">SchemaFieldDataType</a></li><li><a href="#searchbarapi" class="table-of-contents__link toc-highlight">SearchBarAPI</a></li><li><a href="#sortorder" class="table-of-contents__link toc-highlight">SortOrder</a></li><li><a href="#sourcecodeurltype" class="table-of-contents__link toc-highlight">SourceCodeUrlType</a></li><li><a href="#sqlassertiontype" class="table-of-contents__link toc-highlight">SqlAssertionType</a></li><li><a href="#stddatatype" class="table-of-contents__link toc-highlight">StdDataType</a></li><li><a href="#subresourcetype" class="table-of-contents__link toc-highlight">SubResourceType</a></li><li><a href="#termrelationshiptype" class="table-of-contents__link toc-highlight">TermRelationshipType</a></li><li><a href="#testresulttype" class="table-of-contents__link toc-highlight">TestResultType</a></li><li><a href="#timerange" class="table-of-contents__link toc-highlight">TimeRange</a></li><li><a href="#usersetting" class="table-of-contents__link toc-highlight">UserSetting</a></li><li><a href="#volumeassertiontype" class="table-of-contents__link toc-highlight">VolumeAssertionType</a></li><li><a href="#windowduration" class="table-of-contents__link toc-highlight">WindowDuration</a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/">Introduction</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/quickstart">Quickstart</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://datahub.com/slack" target="_blank" rel="noopener noreferrer" class="footer__link-item">Slack<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.youtube.com/channel/UC3qFQC5IiwR5fvWEqi_tJ5w" target="_blank" rel="noopener noreferrer" class="footer__link-item">YouTube<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://medium.com/datahub-project" target="_blank" rel="noopener noreferrer" class="footer__link-item">Blog<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/docs/townhalls">Town Halls</a></li><li class="footer__item"><a href="https://datahub.com/adoption-stories/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Adoption<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://demo.datahub.com/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Demo</a></li><li class="footer__item"><a href="https://feature-requests.datahubproject.io/roadmap" target="_blank" rel="noopener noreferrer" class="footer__link-item">Roadmap<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/docs/contributing">Contributing</a></li><li class="footer__item"><a href="https://github.com/datahub-project/datahub" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://feature-requests.datahubproject.io/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Feature Requests<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2015-2025 DataHub Project Authors.</div></div></div></footer></div>
|
||
<script src="/assets/js/runtime~main.9e7dc23e.js"></script>
|
||
<script src="/assets/js/main.a5ea2da0.js"></script>
|
||
</body>
|
||
</html> |