mirror of
https://github.com/datahub-project/datahub.git
synced 2025-07-06 16:49:03 +00:00
387 lines
1.6 MiB
387 lines
1.6 MiB
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-python-sdk/models" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v2.4.3">
|
||
<title data-rh="true">Models | 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/python-sdk/models"><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="Models | DataHub"><meta data-rh="true" name="description" content="AccessClass {datahub.metadata.schema_classes.AccessClass}"><meta data-rh="true" property="og:description" content="AccessClass {datahub.metadata.schema_classes.AccessClass}"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.datahub.com/docs/python-sdk/models"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/python-sdk/models" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/python-sdk/models" 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.50e13f51.js" as="script">
|
||
<link rel="preload" href="/assets/js/main.edc0853c.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/python-sdk/models">Next</a></li><li><a class="dropdown__link" href="/docs/1.1.0/python-sdk/models">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 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/graphql/overview">API</a></div></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/metadata-ingestion/as-a-library">Python SDK</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-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/metadata-ingestion/as-a-library">Python Emitter</a></li><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/python-sdk/builder/mce-builder">SDK Reference</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-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/python-sdk/builder/mce-builder">Builder</a></div></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/python-sdk/clients/graph-client">Clients</a></div></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/python-sdk/sdk-v2/entities">SDK V2</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/python-sdk/models">Models</a></li><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/python-sdk/urns">URNs</a></li></ul></li></ul></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">Python SDK</span><meta itemprop="position" content="1"></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">SDK Reference</span><meta itemprop="position" content="2"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Models</span><meta itemprop="position" content="3"></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>Models</h1></header><div class="sphinx-api-docs"><a id="module-datahub.metadata.schema_classes"></a><a id="models"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AccessClass"><span class="visually-hidden">AccessClass</span><a href="#datahub.metadata.schema_classes.AccessClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AccessClass" title="Direct link to datahub.metadata.schema_classes.AccessClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AccessClass</span>(<span class="arg-name">roles</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.AccessClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Aspect used for associating roles to a dataset or any asset</p><ul><li><strong>Parameters:</strong><strong>roles</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.RoleAssociationClass"><code>RoleAssociationClass</code></a>]]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-roles--none--listroleassociationclass"><em>property</em> roles <em>: None | List[<a href="#datahub.metadata.schema_classes.RoleAssociationClass">RoleAssociationClass</a>]</em><a href="#property-roles--none--listroleassociationclass" class="hash-link" aria-label="Direct link to property-roles--none--listroleassociationclass" title="Direct link to property-roles--none--listroleassociationclass"></a></h4><p>List of Roles which needs to be associated</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AccessLevelClass"><span class="visually-hidden">AccessLevelClass</span><a href="#datahub.metadata.schema_classes.AccessLevelClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AccessLevelClass" title="Direct link to datahub.metadata.schema_classes.AccessLevelClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AccessLevelClass</span>()<a href="#datahub.metadata.schema_classes.AccessLevelClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>The various access levels</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="private--private">PRIVATE <em>= 'PRIVATE'</em><a href="#private--private" class="hash-link" aria-label="Direct link to private--private" title="Direct link to private--private"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="public--public">PUBLIC <em>= 'PUBLIC'</em><a href="#public--public" class="hash-link" aria-label="Direct link to public--public" title="Direct link to public--public"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ActorsClass"><span class="visually-hidden">ActorsClass</span><a href="#datahub.metadata.schema_classes.ActorsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ActorsClass" title="Direct link to datahub.metadata.schema_classes.ActorsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ActorsClass</span>(<span class="arg-name">users</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.ActorsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Provisioned users of a role</p><ul><li><strong>Parameters:</strong><strong>users</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.RoleUserClass"><code>RoleUserClass</code></a>]]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-users--none--listroleuserclass"><em>property</em> users <em>: None | List[<a href="#datahub.metadata.schema_classes.RoleUserClass">RoleUserClass</a>]</em><a href="#property-users--none--listroleuserclass" class="hash-link" aria-label="Direct link to property-users--none--listroleuserclass" title="Direct link to property-users--none--listroleuserclass"></a></h4><p>List of provisioned users of a role</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ApplicationKeyClass"><span class="visually-hidden">ApplicationKeyClass</span><a href="#datahub.metadata.schema_classes.ApplicationKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ApplicationKeyClass" title="Direct link to datahub.metadata.schema_classes.ApplicationKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ApplicationKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.ApplicationKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Query</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str"><em>property</em> id <em>: str</em><a href="#property-id--str" class="hash-link" aria-label="Direct link to property-id--str" title="Direct link to property-id--str"></a></h4><p>A unique id for the Application.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ApplicationPropertiesClass"><span class="visually-hidden">ApplicationPropertiesClass</span><a href="#datahub.metadata.schema_classes.ApplicationPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ApplicationPropertiesClass" title="Direct link to datahub.metadata.schema_classes.ApplicationPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ApplicationPropertiesClass</span>(<span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">externalUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">name</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.ApplicationPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>The main properties of an Application</p><ul><li><strong>Parameters:</strong><ul><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>externalUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str" title="Direct link to property-customproperties--dictstr-str"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str" class="hash-link" aria-label="Direct link to property-description--none--str" title="Direct link to property-description--none--str"></a></h4><p>Documentation of the application</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-externalurl--none--str"><em>property</em> externalUrl <em>: None | str</em><a href="#property-externalurl--none--str" class="hash-link" aria-label="Direct link to property-externalurl--none--str" title="Direct link to property-externalurl--none--str"></a></h4><p>URL where the reference exist</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--none--str"><em>property</em> name <em>: None | str</em><a href="#property-name--none--str" class="hash-link" aria-label="Direct link to property-name--none--str" title="Direct link to property-name--none--str"></a></h4><p>Display name of the Application</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ApplicationsClass"><span class="visually-hidden">ApplicationsClass</span><a href="#datahub.metadata.schema_classes.ApplicationsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ApplicationsClass" title="Direct link to datahub.metadata.schema_classes.ApplicationsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ApplicationsClass</span>(<span class="arg-name">applications</span>)<a href="#datahub.metadata.schema_classes.ApplicationsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Links from an Asset to its Applications</p><ul><li><strong>Parameters:</strong><strong>applications</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-applications--liststr"><em>property</em> applications <em>: List<!-- -->[str]</em><a href="#property-applications--liststr" class="hash-link" aria-label="Direct link to property-applications--liststr" title="Direct link to property-applications--liststr"></a></h4><p>The Applications attached to an Asset</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ArrayTypeClass"><span class="visually-hidden">ArrayTypeClass</span><a href="#datahub.metadata.schema_classes.ArrayTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ArrayTypeClass" title="Direct link to datahub.metadata.schema_classes.ArrayTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ArrayTypeClass</span>(<span class="arg-name">nestedType</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.ArrayTypeClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Array field type.</p><ul><li><strong>Parameters:</strong><strong>nestedType</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-nestedtype--none--liststr"><em>property</em> nestedType <em>: None | List<!-- -->[str]</em><a href="#property-nestedtype--none--liststr" class="hash-link" aria-label="Direct link to property-nestedtype--none--liststr" title="Direct link to property-nestedtype--none--liststr"></a></h4><p>List of types this array holds.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AspectBag"><span class="visually-hidden">AspectBag</span><a href="#datahub.metadata.schema_classes.AspectBag" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AspectBag" title="Direct link to datahub.metadata.schema_classes.AspectBag"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AspectBag</span>()<a href="#datahub.metadata.schema_classes.AspectBag" class="hash-link"></a></div><p>Bases: <code>TypedDict</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="access--accessclass">access <em>: <a href="#datahub.metadata.schema_classes.AccessClass"><code>AccessClass</code></a></em><a href="#access--accessclass" class="hash-link" aria-label="Direct link to access--accessclass" title="Direct link to access--accessclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="actors--actorsclass">actors <em>: <a href="#datahub.metadata.schema_classes.ActorsClass"><code>ActorsClass</code></a></em><a href="#actors--actorsclass" class="hash-link" aria-label="Direct link to actors--actorsclass" title="Direct link to actors--actorsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="applicationkey--applicationkeyclass">applicationKey <em>: <a href="#datahub.metadata.schema_classes.ApplicationKeyClass"><code>ApplicationKeyClass</code></a></em><a href="#applicationkey--applicationkeyclass" class="hash-link" aria-label="Direct link to applicationkey--applicationkeyclass" title="Direct link to applicationkey--applicationkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="applicationproperties--applicationpropertiesclass">applicationProperties <em>: <a href="#datahub.metadata.schema_classes.ApplicationPropertiesClass"><code>ApplicationPropertiesClass</code></a></em><a href="#applicationproperties--applicationpropertiesclass" class="hash-link" aria-label="Direct link to applicationproperties--applicationpropertiesclass" title="Direct link to applicationproperties--applicationpropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="applications--applicationsclass">applications <em>: <a href="#datahub.metadata.schema_classes.ApplicationsClass"><code>ApplicationsClass</code></a></em><a href="#applications--applicationsclass" class="hash-link" aria-label="Direct link to applications--applicationsclass" title="Direct link to applications--applicationsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="assertionactions--assertionactionsclass">assertionActions <em>: <a href="#datahub.metadata.schema_classes.AssertionActionsClass"><code>AssertionActionsClass</code></a></em><a href="#assertionactions--assertionactionsclass" class="hash-link" aria-label="Direct link to assertionactions--assertionactionsclass" title="Direct link to assertionactions--assertionactionsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="assertioninfo--assertioninfoclass">assertionInfo <em>: <a href="#datahub.metadata.schema_classes.AssertionInfoClass"><code>AssertionInfoClass</code></a></em><a href="#assertioninfo--assertioninfoclass" class="hash-link" aria-label="Direct link to assertioninfo--assertioninfoclass" title="Direct link to assertioninfo--assertioninfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="assertionkey--assertionkeyclass">assertionKey <em>: <a href="#datahub.metadata.schema_classes.AssertionKeyClass"><code>AssertionKeyClass</code></a></em><a href="#assertionkey--assertionkeyclass" class="hash-link" aria-label="Direct link to assertionkey--assertionkeyclass" title="Direct link to assertionkey--assertionkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="assertionrunevent--assertionruneventclass">assertionRunEvent <em>: <a href="#datahub.metadata.schema_classes.AssertionRunEventClass"><code>AssertionRunEventClass</code></a></em><a href="#assertionrunevent--assertionruneventclass" class="hash-link" aria-label="Direct link to assertionrunevent--assertionruneventclass" title="Direct link to assertionrunevent--assertionruneventclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="browsepaths--browsepathsclass">browsePaths <em>: <a href="#datahub.metadata.schema_classes.BrowsePathsClass"><code>BrowsePathsClass</code></a></em><a href="#browsepaths--browsepathsclass" class="hash-link" aria-label="Direct link to browsepaths--browsepathsclass" title="Direct link to browsepaths--browsepathsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="browsepathsv2--browsepathsv2class">browsePathsV2 <em>: <a href="#datahub.metadata.schema_classes.BrowsePathsV2Class"><code>BrowsePathsV2Class</code></a></em><a href="#browsepathsv2--browsepathsv2class" class="hash-link" aria-label="Direct link to browsepathsv2--browsepathsv2class" title="Direct link to browsepathsv2--browsepathsv2class"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="businessattributeinfo--businessattributeinfoclass">businessAttributeInfo <em>: <a href="#datahub.metadata.schema_classes.BusinessAttributeInfoClass"><code>BusinessAttributeInfoClass</code></a></em><a href="#businessattributeinfo--businessattributeinfoclass" class="hash-link" aria-label="Direct link to businessattributeinfo--businessattributeinfoclass" title="Direct link to businessattributeinfo--businessattributeinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="businessattributekey--businessattributekeyclass">businessAttributeKey <em>: <a href="#datahub.metadata.schema_classes.BusinessAttributeKeyClass"><code>BusinessAttributeKeyClass</code></a></em><a href="#businessattributekey--businessattributekeyclass" class="hash-link" aria-label="Direct link to businessattributekey--businessattributekeyclass" title="Direct link to businessattributekey--businessattributekeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="businessattributes--businessattributesclass">businessAttributes <em>: <a href="#datahub.metadata.schema_classes.BusinessAttributesClass"><code>BusinessAttributesClass</code></a></em><a href="#businessattributes--businessattributesclass" class="hash-link" aria-label="Direct link to businessattributes--businessattributesclass" title="Direct link to businessattributes--businessattributesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="chartinfo--chartinfoclass">chartInfo <em>: <a href="#datahub.metadata.schema_classes.ChartInfoClass"><code>ChartInfoClass</code></a></em><a href="#chartinfo--chartinfoclass" class="hash-link" aria-label="Direct link to chartinfo--chartinfoclass" title="Direct link to chartinfo--chartinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="chartkey--chartkeyclass">chartKey <em>: <a href="#datahub.metadata.schema_classes.ChartKeyClass"><code>ChartKeyClass</code></a></em><a href="#chartkey--chartkeyclass" class="hash-link" aria-label="Direct link to chartkey--chartkeyclass" title="Direct link to chartkey--chartkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="chartquery--chartqueryclass">chartQuery <em>: <a href="#datahub.metadata.schema_classes.ChartQueryClass"><code>ChartQueryClass</code></a></em><a href="#chartquery--chartqueryclass" class="hash-link" aria-label="Direct link to chartquery--chartqueryclass" title="Direct link to chartquery--chartqueryclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="chartusagestatistics--chartusagestatisticsclass">chartUsageStatistics <em>: <a href="#datahub.metadata.schema_classes.ChartUsageStatisticsClass"><code>ChartUsageStatisticsClass</code></a></em><a href="#chartusagestatistics--chartusagestatisticsclass" class="hash-link" aria-label="Direct link to chartusagestatistics--chartusagestatisticsclass" title="Direct link to chartusagestatistics--chartusagestatisticsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="container--containerclass">container <em>: <a href="#datahub.metadata.schema_classes.ContainerClass"><code>ContainerClass</code></a></em><a href="#container--containerclass" class="hash-link" aria-label="Direct link to container--containerclass" title="Direct link to container--containerclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="containerkey--containerkeyclass">containerKey <em>: <a href="#datahub.metadata.schema_classes.ContainerKeyClass"><code>ContainerKeyClass</code></a></em><a href="#containerkey--containerkeyclass" class="hash-link" aria-label="Direct link to containerkey--containerkeyclass" title="Direct link to containerkey--containerkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="containerproperties--containerpropertiesclass">containerProperties <em>: <a href="#datahub.metadata.schema_classes.ContainerPropertiesClass"><code>ContainerPropertiesClass</code></a></em><a href="#containerproperties--containerpropertiesclass" class="hash-link" aria-label="Direct link to containerproperties--containerpropertiesclass" title="Direct link to containerproperties--containerpropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="corpgroupeditableinfo--corpgroupeditableinfoclass">corpGroupEditableInfo <em>: <a href="#datahub.metadata.schema_classes.CorpGroupEditableInfoClass"><code>CorpGroupEditableInfoClass</code></a></em><a href="#corpgroupeditableinfo--corpgroupeditableinfoclass" class="hash-link" aria-label="Direct link to corpgroupeditableinfo--corpgroupeditableinfoclass" title="Direct link to corpgroupeditableinfo--corpgroupeditableinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="corpgroupinfo--corpgroupinfoclass">corpGroupInfo <em>: <a href="#datahub.metadata.schema_classes.CorpGroupInfoClass"><code>CorpGroupInfoClass</code></a></em><a href="#corpgroupinfo--corpgroupinfoclass" class="hash-link" aria-label="Direct link to corpgroupinfo--corpgroupinfoclass" title="Direct link to corpgroupinfo--corpgroupinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="corpgroupkey--corpgroupkeyclass">corpGroupKey <em>: <a href="#datahub.metadata.schema_classes.CorpGroupKeyClass"><code>CorpGroupKeyClass</code></a></em><a href="#corpgroupkey--corpgroupkeyclass" class="hash-link" aria-label="Direct link to corpgroupkey--corpgroupkeyclass" title="Direct link to corpgroupkey--corpgroupkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="corpusercredentials--corpusercredentialsclass">corpUserCredentials <em>: <a href="#datahub.metadata.schema_classes.CorpUserCredentialsClass"><code>CorpUserCredentialsClass</code></a></em><a href="#corpusercredentials--corpusercredentialsclass" class="hash-link" aria-label="Direct link to corpusercredentials--corpusercredentialsclass" title="Direct link to corpusercredentials--corpusercredentialsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="corpusereditableinfo--corpusereditableinfoclass">corpUserEditableInfo <em>: <a href="#datahub.metadata.schema_classes.CorpUserEditableInfoClass"><code>CorpUserEditableInfoClass</code></a></em><a href="#corpusereditableinfo--corpusereditableinfoclass" class="hash-link" aria-label="Direct link to corpusereditableinfo--corpusereditableinfoclass" title="Direct link to corpusereditableinfo--corpusereditableinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="corpuserinfo--corpuserinfoclass">corpUserInfo <em>: <a href="#datahub.metadata.schema_classes.CorpUserInfoClass"><code>CorpUserInfoClass</code></a></em><a href="#corpuserinfo--corpuserinfoclass" class="hash-link" aria-label="Direct link to corpuserinfo--corpuserinfoclass" title="Direct link to corpuserinfo--corpuserinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="corpuserkey--corpuserkeyclass">corpUserKey <em>: <a href="#datahub.metadata.schema_classes.CorpUserKeyClass"><code>CorpUserKeyClass</code></a></em><a href="#corpuserkey--corpuserkeyclass" class="hash-link" aria-label="Direct link to corpuserkey--corpuserkeyclass" title="Direct link to corpuserkey--corpuserkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="corpusersettings--corpusersettingsclass">corpUserSettings <em>: <a href="#datahub.metadata.schema_classes.CorpUserSettingsClass"><code>CorpUserSettingsClass</code></a></em><a href="#corpusersettings--corpusersettingsclass" class="hash-link" aria-label="Direct link to corpusersettings--corpusersettingsclass" title="Direct link to corpusersettings--corpusersettingsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="corpuserstatus--corpuserstatusclass">corpUserStatus <em>: <a href="#datahub.metadata.schema_classes.CorpUserStatusClass"><code>CorpUserStatusClass</code></a></em><a href="#corpuserstatus--corpuserstatusclass" class="hash-link" aria-label="Direct link to corpuserstatus--corpuserstatusclass" title="Direct link to corpuserstatus--corpuserstatusclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="cost--costclass">cost <em>: <a href="#datahub.metadata.schema_classes.CostClass"><code>CostClass</code></a></em><a href="#cost--costclass" class="hash-link" aria-label="Direct link to cost--costclass" title="Direct link to cost--costclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dashboardinfo--dashboardinfoclass">dashboardInfo <em>: <a href="#datahub.metadata.schema_classes.DashboardInfoClass"><code>DashboardInfoClass</code></a></em><a href="#dashboardinfo--dashboardinfoclass" class="hash-link" aria-label="Direct link to dashboardinfo--dashboardinfoclass" title="Direct link to dashboardinfo--dashboardinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dashboardkey--dashboardkeyclass">dashboardKey <em>: <a href="#datahub.metadata.schema_classes.DashboardKeyClass"><code>DashboardKeyClass</code></a></em><a href="#dashboardkey--dashboardkeyclass" class="hash-link" aria-label="Direct link to dashboardkey--dashboardkeyclass" title="Direct link to dashboardkey--dashboardkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dashboardusagestatistics--dashboardusagestatisticsclass">dashboardUsageStatistics <em>: <a href="#datahub.metadata.schema_classes.DashboardUsageStatisticsClass"><code>DashboardUsageStatisticsClass</code></a></em><a href="#dashboardusagestatistics--dashboardusagestatisticsclass" class="hash-link" aria-label="Direct link to dashboardusagestatistics--dashboardusagestatisticsclass" title="Direct link to dashboardusagestatistics--dashboardusagestatisticsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datacontractkey--datacontractkeyclass">dataContractKey <em>: <a href="#datahub.metadata.schema_classes.DataContractKeyClass"><code>DataContractKeyClass</code></a></em><a href="#datacontractkey--datacontractkeyclass" class="hash-link" aria-label="Direct link to datacontractkey--datacontractkeyclass" title="Direct link to datacontractkey--datacontractkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datacontractproperties--datacontractpropertiesclass">dataContractProperties <em>: <a href="#datahub.metadata.schema_classes.DataContractPropertiesClass"><code>DataContractPropertiesClass</code></a></em><a href="#datacontractproperties--datacontractpropertiesclass" class="hash-link" aria-label="Direct link to datacontractproperties--datacontractpropertiesclass" title="Direct link to datacontractproperties--datacontractpropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datacontractstatus--datacontractstatusclass">dataContractStatus <em>: <a href="#datahub.metadata.schema_classes.DataContractStatusClass"><code>DataContractStatusClass</code></a></em><a href="#datacontractstatus--datacontractstatusclass" class="hash-link" aria-label="Direct link to datacontractstatus--datacontractstatusclass" title="Direct link to datacontractstatus--datacontractstatusclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataflowinfo--dataflowinfoclass">dataFlowInfo <em>: <a href="#datahub.metadata.schema_classes.DataFlowInfoClass"><code>DataFlowInfoClass</code></a></em><a href="#dataflowinfo--dataflowinfoclass" class="hash-link" aria-label="Direct link to dataflowinfo--dataflowinfoclass" title="Direct link to dataflowinfo--dataflowinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataflowkey--dataflowkeyclass">dataFlowKey <em>: <a href="#datahub.metadata.schema_classes.DataFlowKeyClass"><code>DataFlowKeyClass</code></a></em><a href="#dataflowkey--dataflowkeyclass" class="hash-link" aria-label="Direct link to dataflowkey--dataflowkeyclass" title="Direct link to dataflowkey--dataflowkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubaccesstokeninfo--datahubaccesstokeninfoclass">dataHubAccessTokenInfo <em>: <a href="#datahub.metadata.schema_classes.DataHubAccessTokenInfoClass"><code>DataHubAccessTokenInfoClass</code></a></em><a href="#datahubaccesstokeninfo--datahubaccesstokeninfoclass" class="hash-link" aria-label="Direct link to datahubaccesstokeninfo--datahubaccesstokeninfoclass" title="Direct link to datahubaccesstokeninfo--datahubaccesstokeninfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubaccesstokenkey--datahubaccesstokenkeyclass">dataHubAccessTokenKey <em>: <a href="#datahub.metadata.schema_classes.DataHubAccessTokenKeyClass"><code>DataHubAccessTokenKeyClass</code></a></em><a href="#datahubaccesstokenkey--datahubaccesstokenkeyclass" class="hash-link" aria-label="Direct link to datahubaccesstokenkey--datahubaccesstokenkeyclass" title="Direct link to datahubaccesstokenkey--datahubaccesstokenkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubactionkey--datahubactionkeyclass">dataHubActionKey <em>: <a href="#datahub.metadata.schema_classes.DataHubActionKeyClass"><code>DataHubActionKeyClass</code></a></em><a href="#datahubactionkey--datahubactionkeyclass" class="hash-link" aria-label="Direct link to datahubactionkey--datahubactionkeyclass" title="Direct link to datahubactionkey--datahubactionkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubconnectiondetails--datahubconnectiondetailsclass">dataHubConnectionDetails <em>: <a href="#datahub.metadata.schema_classes.DataHubConnectionDetailsClass"><code>DataHubConnectionDetailsClass</code></a></em><a href="#datahubconnectiondetails--datahubconnectiondetailsclass" class="hash-link" aria-label="Direct link to datahubconnectiondetails--datahubconnectiondetailsclass" title="Direct link to datahubconnectiondetails--datahubconnectiondetailsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubconnectionkey--datahubconnectionkeyclass">dataHubConnectionKey <em>: <a href="#datahub.metadata.schema_classes.DataHubConnectionKeyClass"><code>DataHubConnectionKeyClass</code></a></em><a href="#datahubconnectionkey--datahubconnectionkeyclass" class="hash-link" aria-label="Direct link to datahubconnectionkey--datahubconnectionkeyclass" title="Direct link to datahubconnectionkey--datahubconnectionkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubexecutionrequestinput--executionrequestinputclass">dataHubExecutionRequestInput <em>: <a href="#datahub.metadata.schema_classes.ExecutionRequestInputClass"><code>ExecutionRequestInputClass</code></a></em><a href="#datahubexecutionrequestinput--executionrequestinputclass" class="hash-link" aria-label="Direct link to datahubexecutionrequestinput--executionrequestinputclass" title="Direct link to datahubexecutionrequestinput--executionrequestinputclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubexecutionrequestkey--executionrequestkeyclass">dataHubExecutionRequestKey <em>: <a href="#datahub.metadata.schema_classes.ExecutionRequestKeyClass"><code>ExecutionRequestKeyClass</code></a></em><a href="#datahubexecutionrequestkey--executionrequestkeyclass" class="hash-link" aria-label="Direct link to datahubexecutionrequestkey--executionrequestkeyclass" title="Direct link to datahubexecutionrequestkey--executionrequestkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubexecutionrequestresult--executionrequestresultclass">dataHubExecutionRequestResult <em>: <a href="#datahub.metadata.schema_classes.ExecutionRequestResultClass"><code>ExecutionRequestResultClass</code></a></em><a href="#datahubexecutionrequestresult--executionrequestresultclass" class="hash-link" aria-label="Direct link to datahubexecutionrequestresult--executionrequestresultclass" title="Direct link to datahubexecutionrequestresult--executionrequestresultclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubexecutionrequestsignal--executionrequestsignalclass">dataHubExecutionRequestSignal <em>: <a href="#datahub.metadata.schema_classes.ExecutionRequestSignalClass"><code>ExecutionRequestSignalClass</code></a></em><a href="#datahubexecutionrequestsignal--executionrequestsignalclass" class="hash-link" aria-label="Direct link to datahubexecutionrequestsignal--executionrequestsignalclass" title="Direct link to datahubexecutionrequestsignal--executionrequestsignalclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubingestionsourceinfo--datahubingestionsourceinfoclass">dataHubIngestionSourceInfo <em>: <a href="#datahub.metadata.schema_classes.DataHubIngestionSourceInfoClass"><code>DataHubIngestionSourceInfoClass</code></a></em><a href="#datahubingestionsourceinfo--datahubingestionsourceinfoclass" class="hash-link" aria-label="Direct link to datahubingestionsourceinfo--datahubingestionsourceinfoclass" title="Direct link to datahubingestionsourceinfo--datahubingestionsourceinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubingestionsourcekey--datahubingestionsourcekeyclass">dataHubIngestionSourceKey <em>: <a href="#datahub.metadata.schema_classes.DataHubIngestionSourceKeyClass"><code>DataHubIngestionSourceKeyClass</code></a></em><a href="#datahubingestionsourcekey--datahubingestionsourcekeyclass" class="hash-link" aria-label="Direct link to datahubingestionsourcekey--datahubingestionsourcekeyclass" title="Direct link to datahubingestionsourcekey--datahubingestionsourcekeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubopenapischemakey--datahubopenapischemakeyclass">dataHubOpenAPISchemaKey <em>: <a href="#datahub.metadata.schema_classes.DataHubOpenAPISchemaKeyClass"><code>DataHubOpenAPISchemaKeyClass</code></a></em><a href="#datahubopenapischemakey--datahubopenapischemakeyclass" class="hash-link" aria-label="Direct link to datahubopenapischemakey--datahubopenapischemakeyclass" title="Direct link to datahubopenapischemakey--datahubopenapischemakeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubpagemodulekey--datahubpagemodulekeyclass">dataHubPageModuleKey <em>: <a href="#datahub.metadata.schema_classes.DataHubPageModuleKeyClass"><code>DataHubPageModuleKeyClass</code></a></em><a href="#datahubpagemodulekey--datahubpagemodulekeyclass" class="hash-link" aria-label="Direct link to datahubpagemodulekey--datahubpagemodulekeyclass" title="Direct link to datahubpagemodulekey--datahubpagemodulekeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubpagemoduleproperties--datahubpagemodulepropertiesclass">dataHubPageModuleProperties <em>: <a href="#datahub.metadata.schema_classes.DataHubPageModulePropertiesClass"><code>DataHubPageModulePropertiesClass</code></a></em><a href="#datahubpagemoduleproperties--datahubpagemodulepropertiesclass" class="hash-link" aria-label="Direct link to datahubpagemoduleproperties--datahubpagemodulepropertiesclass" title="Direct link to datahubpagemoduleproperties--datahubpagemodulepropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubpagetemplatekey--datahubpagetemplatekeyclass">dataHubPageTemplateKey <em>: <a href="#datahub.metadata.schema_classes.DataHubPageTemplateKeyClass"><code>DataHubPageTemplateKeyClass</code></a></em><a href="#datahubpagetemplatekey--datahubpagetemplatekeyclass" class="hash-link" aria-label="Direct link to datahubpagetemplatekey--datahubpagetemplatekeyclass" title="Direct link to datahubpagetemplatekey--datahubpagetemplatekeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubpagetemplateproperties--datahubpagetemplatepropertiesclass">dataHubPageTemplateProperties <em>: <a href="#datahub.metadata.schema_classes.DataHubPageTemplatePropertiesClass"><code>DataHubPageTemplatePropertiesClass</code></a></em><a href="#datahubpagetemplateproperties--datahubpagetemplatepropertiesclass" class="hash-link" aria-label="Direct link to datahubpagetemplateproperties--datahubpagetemplatepropertiesclass" title="Direct link to datahubpagetemplateproperties--datahubpagetemplatepropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubpersonainfo--datahubpersonainfoclass">dataHubPersonaInfo <em>: <a href="#datahub.metadata.schema_classes.DataHubPersonaInfoClass"><code>DataHubPersonaInfoClass</code></a></em><a href="#datahubpersonainfo--datahubpersonainfoclass" class="hash-link" aria-label="Direct link to datahubpersonainfo--datahubpersonainfoclass" title="Direct link to datahubpersonainfo--datahubpersonainfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubpersonakey--datahubpersonakeyclass">dataHubPersonaKey <em>: <a href="#datahub.metadata.schema_classes.DataHubPersonaKeyClass"><code>DataHubPersonaKeyClass</code></a></em><a href="#datahubpersonakey--datahubpersonakeyclass" class="hash-link" aria-label="Direct link to datahubpersonakey--datahubpersonakeyclass" title="Direct link to datahubpersonakey--datahubpersonakeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubpolicyinfo--datahubpolicyinfoclass">dataHubPolicyInfo <em>: <a href="#datahub.metadata.schema_classes.DataHubPolicyInfoClass"><code>DataHubPolicyInfoClass</code></a></em><a href="#datahubpolicyinfo--datahubpolicyinfoclass" class="hash-link" aria-label="Direct link to datahubpolicyinfo--datahubpolicyinfoclass" title="Direct link to datahubpolicyinfo--datahubpolicyinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubpolicykey--datahubpolicykeyclass">dataHubPolicyKey <em>: <a href="#datahub.metadata.schema_classes.DataHubPolicyKeyClass"><code>DataHubPolicyKeyClass</code></a></em><a href="#datahubpolicykey--datahubpolicykeyclass" class="hash-link" aria-label="Direct link to datahubpolicykey--datahubpolicykeyclass" title="Direct link to datahubpolicykey--datahubpolicykeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubretentionconfig--datahubretentionconfigclass">dataHubRetentionConfig <em>: <a href="#datahub.metadata.schema_classes.DataHubRetentionConfigClass"><code>DataHubRetentionConfigClass</code></a></em><a href="#datahubretentionconfig--datahubretentionconfigclass" class="hash-link" aria-label="Direct link to datahubretentionconfig--datahubretentionconfigclass" title="Direct link to datahubretentionconfig--datahubretentionconfigclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubretentionkey--datahubretentionkeyclass">dataHubRetentionKey <em>: <a href="#datahub.metadata.schema_classes.DataHubRetentionKeyClass"><code>DataHubRetentionKeyClass</code></a></em><a href="#datahubretentionkey--datahubretentionkeyclass" class="hash-link" aria-label="Direct link to datahubretentionkey--datahubretentionkeyclass" title="Direct link to datahubretentionkey--datahubretentionkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubroleinfo--datahubroleinfoclass">dataHubRoleInfo <em>: <a href="#datahub.metadata.schema_classes.DataHubRoleInfoClass"><code>DataHubRoleInfoClass</code></a></em><a href="#datahubroleinfo--datahubroleinfoclass" class="hash-link" aria-label="Direct link to datahubroleinfo--datahubroleinfoclass" title="Direct link to datahubroleinfo--datahubroleinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubrolekey--datahubrolekeyclass">dataHubRoleKey <em>: <a href="#datahub.metadata.schema_classes.DataHubRoleKeyClass"><code>DataHubRoleKeyClass</code></a></em><a href="#datahubrolekey--datahubrolekeyclass" class="hash-link" aria-label="Direct link to datahubrolekey--datahubrolekeyclass" title="Direct link to datahubrolekey--datahubrolekeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubsecretkey--datahubsecretkeyclass">dataHubSecretKey <em>: <a href="#datahub.metadata.schema_classes.DataHubSecretKeyClass"><code>DataHubSecretKeyClass</code></a></em><a href="#datahubsecretkey--datahubsecretkeyclass" class="hash-link" aria-label="Direct link to datahubsecretkey--datahubsecretkeyclass" title="Direct link to datahubsecretkey--datahubsecretkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubsecretvalue--datahubsecretvalueclass">dataHubSecretValue <em>: <a href="#datahub.metadata.schema_classes.DataHubSecretValueClass"><code>DataHubSecretValueClass</code></a></em><a href="#datahubsecretvalue--datahubsecretvalueclass" class="hash-link" aria-label="Direct link to datahubsecretvalue--datahubsecretvalueclass" title="Direct link to datahubsecretvalue--datahubsecretvalueclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubstepstatekey--datahubstepstatekeyclass">dataHubStepStateKey <em>: <a href="#datahub.metadata.schema_classes.DataHubStepStateKeyClass"><code>DataHubStepStateKeyClass</code></a></em><a href="#datahubstepstatekey--datahubstepstatekeyclass" class="hash-link" aria-label="Direct link to datahubstepstatekey--datahubstepstatekeyclass" title="Direct link to datahubstepstatekey--datahubstepstatekeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubstepstateproperties--datahubstepstatepropertiesclass">dataHubStepStateProperties <em>: <a href="#datahub.metadata.schema_classes.DataHubStepStatePropertiesClass"><code>DataHubStepStatePropertiesClass</code></a></em><a href="#datahubstepstateproperties--datahubstepstatepropertiesclass" class="hash-link" aria-label="Direct link to datahubstepstateproperties--datahubstepstatepropertiesclass" title="Direct link to datahubstepstateproperties--datahubstepstatepropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubupgradekey--datahubupgradekeyclass">dataHubUpgradeKey <em>: <a href="#datahub.metadata.schema_classes.DataHubUpgradeKeyClass"><code>DataHubUpgradeKeyClass</code></a></em><a href="#datahubupgradekey--datahubupgradekeyclass" class="hash-link" aria-label="Direct link to datahubupgradekey--datahubupgradekeyclass" title="Direct link to datahubupgradekey--datahubupgradekeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubupgraderequest--datahubupgraderequestclass">dataHubUpgradeRequest <em>: <a href="#datahub.metadata.schema_classes.DataHubUpgradeRequestClass"><code>DataHubUpgradeRequestClass</code></a></em><a href="#datahubupgraderequest--datahubupgraderequestclass" class="hash-link" aria-label="Direct link to datahubupgraderequest--datahubupgraderequestclass" title="Direct link to datahubupgraderequest--datahubupgraderequestclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubupgraderesult--datahubupgraderesultclass">dataHubUpgradeResult <em>: <a href="#datahub.metadata.schema_classes.DataHubUpgradeResultClass"><code>DataHubUpgradeResultClass</code></a></em><a href="#datahubupgraderesult--datahubupgraderesultclass" class="hash-link" aria-label="Direct link to datahubupgraderesult--datahubupgraderesultclass" title="Direct link to datahubupgraderesult--datahubupgraderesultclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubviewinfo--datahubviewinfoclass">dataHubViewInfo <em>: <a href="#datahub.metadata.schema_classes.DataHubViewInfoClass"><code>DataHubViewInfoClass</code></a></em><a href="#datahubviewinfo--datahubviewinfoclass" class="hash-link" aria-label="Direct link to datahubviewinfo--datahubviewinfoclass" title="Direct link to datahubviewinfo--datahubviewinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubviewkey--datahubviewkeyclass">dataHubViewKey <em>: <a href="#datahub.metadata.schema_classes.DataHubViewKeyClass"><code>DataHubViewKeyClass</code></a></em><a href="#datahubviewkey--datahubviewkeyclass" class="hash-link" aria-label="Direct link to datahubviewkey--datahubviewkeyclass" title="Direct link to datahubviewkey--datahubviewkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datajobinfo--datajobinfoclass">dataJobInfo <em>: <a href="#datahub.metadata.schema_classes.DataJobInfoClass"><code>DataJobInfoClass</code></a></em><a href="#datajobinfo--datajobinfoclass" class="hash-link" aria-label="Direct link to datajobinfo--datajobinfoclass" title="Direct link to datajobinfo--datajobinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datajobinputoutput--datajobinputoutputclass">dataJobInputOutput <em>: <a href="#datahub.metadata.schema_classes.DataJobInputOutputClass"><code>DataJobInputOutputClass</code></a></em><a href="#datajobinputoutput--datajobinputoutputclass" class="hash-link" aria-label="Direct link to datajobinputoutput--datajobinputoutputclass" title="Direct link to datajobinputoutput--datajobinputoutputclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datajobkey--datajobkeyclass">dataJobKey <em>: <a href="#datahub.metadata.schema_classes.DataJobKeyClass"><code>DataJobKeyClass</code></a></em><a href="#datajobkey--datajobkeyclass" class="hash-link" aria-label="Direct link to datajobkey--datajobkeyclass" title="Direct link to datajobkey--datajobkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataplatforminfo--dataplatforminfoclass">dataPlatformInfo <em>: <a href="#datahub.metadata.schema_classes.DataPlatformInfoClass"><code>DataPlatformInfoClass</code></a></em><a href="#dataplatforminfo--dataplatforminfoclass" class="hash-link" aria-label="Direct link to dataplatforminfo--dataplatforminfoclass" title="Direct link to dataplatforminfo--dataplatforminfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataplatforminstance--dataplatforminstanceclass">dataPlatformInstance <em>: <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass"><code>DataPlatformInstanceClass</code></a></em><a href="#dataplatforminstance--dataplatforminstanceclass" class="hash-link" aria-label="Direct link to dataplatforminstance--dataplatforminstanceclass" title="Direct link to dataplatforminstance--dataplatforminstanceclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataplatforminstancekey--dataplatforminstancekeyclass">dataPlatformInstanceKey <em>: <a href="#datahub.metadata.schema_classes.DataPlatformInstanceKeyClass"><code>DataPlatformInstanceKeyClass</code></a></em><a href="#dataplatforminstancekey--dataplatforminstancekeyclass" class="hash-link" aria-label="Direct link to dataplatforminstancekey--dataplatforminstancekeyclass" title="Direct link to dataplatforminstancekey--dataplatforminstancekeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataplatforminstanceproperties--dataplatforminstancepropertiesclass">dataPlatformInstanceProperties <em>: <a href="#datahub.metadata.schema_classes.DataPlatformInstancePropertiesClass"><code>DataPlatformInstancePropertiesClass</code></a></em><a href="#dataplatforminstanceproperties--dataplatforminstancepropertiesclass" class="hash-link" aria-label="Direct link to dataplatforminstanceproperties--dataplatforminstancepropertiesclass" title="Direct link to dataplatforminstanceproperties--dataplatforminstancepropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataplatformkey--dataplatformkeyclass">dataPlatformKey <em>: <a href="#datahub.metadata.schema_classes.DataPlatformKeyClass"><code>DataPlatformKeyClass</code></a></em><a href="#dataplatformkey--dataplatformkeyclass" class="hash-link" aria-label="Direct link to dataplatformkey--dataplatformkeyclass" title="Direct link to dataplatformkey--dataplatformkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataprocessinfo--dataprocessinfoclass">dataProcessInfo <em>: <a href="#datahub.metadata.schema_classes.DataProcessInfoClass"><code>DataProcessInfoClass</code></a></em><a href="#dataprocessinfo--dataprocessinfoclass" class="hash-link" aria-label="Direct link to dataprocessinfo--dataprocessinfoclass" title="Direct link to dataprocessinfo--dataprocessinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataprocessinstanceinput--dataprocessinstanceinputclass">dataProcessInstanceInput <em>: <a href="#datahub.metadata.schema_classes.DataProcessInstanceInputClass"><code>DataProcessInstanceInputClass</code></a></em><a href="#dataprocessinstanceinput--dataprocessinstanceinputclass" class="hash-link" aria-label="Direct link to dataprocessinstanceinput--dataprocessinstanceinputclass" title="Direct link to dataprocessinstanceinput--dataprocessinstanceinputclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataprocessinstancekey--dataprocessinstancekeyclass">dataProcessInstanceKey <em>: <a href="#datahub.metadata.schema_classes.DataProcessInstanceKeyClass"><code>DataProcessInstanceKeyClass</code></a></em><a href="#dataprocessinstancekey--dataprocessinstancekeyclass" class="hash-link" aria-label="Direct link to dataprocessinstancekey--dataprocessinstancekeyclass" title="Direct link to dataprocessinstancekey--dataprocessinstancekeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataprocessinstanceoutput--dataprocessinstanceoutputclass">dataProcessInstanceOutput <em>: <a href="#datahub.metadata.schema_classes.DataProcessInstanceOutputClass"><code>DataProcessInstanceOutputClass</code></a></em><a href="#dataprocessinstanceoutput--dataprocessinstanceoutputclass" class="hash-link" aria-label="Direct link to dataprocessinstanceoutput--dataprocessinstanceoutputclass" title="Direct link to dataprocessinstanceoutput--dataprocessinstanceoutputclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataprocessinstanceproperties--dataprocessinstancepropertiesclass">dataProcessInstanceProperties <em>: <a href="#datahub.metadata.schema_classes.DataProcessInstancePropertiesClass"><code>DataProcessInstancePropertiesClass</code></a></em><a href="#dataprocessinstanceproperties--dataprocessinstancepropertiesclass" class="hash-link" aria-label="Direct link to dataprocessinstanceproperties--dataprocessinstancepropertiesclass" title="Direct link to dataprocessinstanceproperties--dataprocessinstancepropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataprocessinstancerelationships--dataprocessinstancerelationshipsclass">dataProcessInstanceRelationships <em>: <a href="#datahub.metadata.schema_classes.DataProcessInstanceRelationshipsClass"><code>DataProcessInstanceRelationshipsClass</code></a></em><a href="#dataprocessinstancerelationships--dataprocessinstancerelationshipsclass" class="hash-link" aria-label="Direct link to dataprocessinstancerelationships--dataprocessinstancerelationshipsclass" title="Direct link to dataprocessinstancerelationships--dataprocessinstancerelationshipsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataprocessinstancerunevent--dataprocessinstanceruneventclass">dataProcessInstanceRunEvent <em>: <a href="#datahub.metadata.schema_classes.DataProcessInstanceRunEventClass"><code>DataProcessInstanceRunEventClass</code></a></em><a href="#dataprocessinstancerunevent--dataprocessinstanceruneventclass" class="hash-link" aria-label="Direct link to dataprocessinstancerunevent--dataprocessinstanceruneventclass" title="Direct link to dataprocessinstancerunevent--dataprocessinstanceruneventclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataprocesskey--dataprocesskeyclass">dataProcessKey <em>: <a href="#datahub.metadata.schema_classes.DataProcessKeyClass"><code>DataProcessKeyClass</code></a></em><a href="#dataprocesskey--dataprocesskeyclass" class="hash-link" aria-label="Direct link to dataprocesskey--dataprocesskeyclass" title="Direct link to dataprocesskey--dataprocesskeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataproductkey--dataproductkeyclass">dataProductKey <em>: <a href="#datahub.metadata.schema_classes.DataProductKeyClass"><code>DataProductKeyClass</code></a></em><a href="#dataproductkey--dataproductkeyclass" class="hash-link" aria-label="Direct link to dataproductkey--dataproductkeyclass" title="Direct link to dataproductkey--dataproductkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataproductproperties--dataproductpropertiesclass">dataProductProperties <em>: <a href="#datahub.metadata.schema_classes.DataProductPropertiesClass"><code>DataProductPropertiesClass</code></a></em><a href="#dataproductproperties--dataproductpropertiesclass" class="hash-link" aria-label="Direct link to dataproductproperties--dataproductpropertiesclass" title="Direct link to dataproductproperties--dataproductpropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datatransformlogic--datatransformlogicclass">dataTransformLogic <em>: <a href="#datahub.metadata.schema_classes.DataTransformLogicClass"><code>DataTransformLogicClass</code></a></em><a href="#datatransformlogic--datatransformlogicclass" class="hash-link" aria-label="Direct link to datatransformlogic--datatransformlogicclass" title="Direct link to datatransformlogic--datatransformlogicclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datatypeinfo--datatypeinfoclass">dataTypeInfo <em>: <a href="#datahub.metadata.schema_classes.DataTypeInfoClass"><code>DataTypeInfoClass</code></a></em><a href="#datatypeinfo--datatypeinfoclass" class="hash-link" aria-label="Direct link to datatypeinfo--datatypeinfoclass" title="Direct link to datatypeinfo--datatypeinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datatypekey--datatypekeyclass">dataTypeKey <em>: <a href="#datahub.metadata.schema_classes.DataTypeKeyClass"><code>DataTypeKeyClass</code></a></em><a href="#datatypekey--datatypekeyclass" class="hash-link" aria-label="Direct link to datatypekey--datatypekeyclass" title="Direct link to datatypekey--datatypekeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubingestioncheckpoint--datahubingestioncheckpointclass">datahubIngestionCheckpoint <em>: <a href="#datahub.metadata.schema_classes.DatahubIngestionCheckpointClass"><code>DatahubIngestionCheckpointClass</code></a></em><a href="#datahubingestioncheckpoint--datahubingestioncheckpointclass" class="hash-link" aria-label="Direct link to datahubingestioncheckpoint--datahubingestioncheckpointclass" title="Direct link to datahubingestioncheckpoint--datahubingestioncheckpointclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahubingestionrunsummary--datahubingestionrunsummaryclass">datahubIngestionRunSummary <em>: <a href="#datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass"><code>DatahubIngestionRunSummaryClass</code></a></em><a href="#datahubingestionrunsummary--datahubingestionrunsummaryclass" class="hash-link" aria-label="Direct link to datahubingestionrunsummary--datahubingestionrunsummaryclass" title="Direct link to datahubingestionrunsummary--datahubingestionrunsummaryclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datasetdeprecation--datasetdeprecationclass">datasetDeprecation <em>: <a href="#datahub.metadata.schema_classes.DatasetDeprecationClass"><code>DatasetDeprecationClass</code></a></em><a href="#datasetdeprecation--datasetdeprecationclass" class="hash-link" aria-label="Direct link to datasetdeprecation--datasetdeprecationclass" title="Direct link to datasetdeprecation--datasetdeprecationclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datasetkey--datasetkeyclass">datasetKey <em>: <a href="#datahub.metadata.schema_classes.DatasetKeyClass"><code>DatasetKeyClass</code></a></em><a href="#datasetkey--datasetkeyclass" class="hash-link" aria-label="Direct link to datasetkey--datasetkeyclass" title="Direct link to datasetkey--datasetkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datasetprofile--datasetprofileclass">datasetProfile <em>: <a href="#datahub.metadata.schema_classes.DatasetProfileClass"><code>DatasetProfileClass</code></a></em><a href="#datasetprofile--datasetprofileclass" class="hash-link" aria-label="Direct link to datasetprofile--datasetprofileclass" title="Direct link to datasetprofile--datasetprofileclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datasetproperties--datasetpropertiesclass">datasetProperties <em>: <a href="#datahub.metadata.schema_classes.DatasetPropertiesClass"><code>DatasetPropertiesClass</code></a></em><a href="#datasetproperties--datasetpropertiesclass" class="hash-link" aria-label="Direct link to datasetproperties--datasetpropertiesclass" title="Direct link to datasetproperties--datasetpropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datasetupstreamlineage--datasetupstreamlineageclass">datasetUpstreamLineage <em>: <a href="#datahub.metadata.schema_classes.DatasetUpstreamLineageClass"><code>DatasetUpstreamLineageClass</code></a></em><a href="#datasetupstreamlineage--datasetupstreamlineageclass" class="hash-link" aria-label="Direct link to datasetupstreamlineage--datasetupstreamlineageclass" title="Direct link to datasetupstreamlineage--datasetupstreamlineageclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datasetusagestatistics--datasetusagestatisticsclass">datasetUsageStatistics <em>: <a href="#datahub.metadata.schema_classes.DatasetUsageStatisticsClass"><code>DatasetUsageStatisticsClass</code></a></em><a href="#datasetusagestatistics--datasetusagestatisticsclass" class="hash-link" aria-label="Direct link to datasetusagestatistics--datasetusagestatisticsclass" title="Direct link to datasetusagestatistics--datasetusagestatisticsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="deprecation--deprecationclass">deprecation <em>: <a href="#datahub.metadata.schema_classes.DeprecationClass"><code>DeprecationClass</code></a></em><a href="#deprecation--deprecationclass" class="hash-link" aria-label="Direct link to deprecation--deprecationclass" title="Direct link to deprecation--deprecationclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="displayproperties--displaypropertiesclass">displayProperties <em>: <a href="#datahub.metadata.schema_classes.DisplayPropertiesClass"><code>DisplayPropertiesClass</code></a></em><a href="#displayproperties--displaypropertiesclass" class="hash-link" aria-label="Direct link to displayproperties--displaypropertiesclass" title="Direct link to displayproperties--displaypropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="documentation--documentationclass">documentation <em>: <a href="#datahub.metadata.schema_classes.DocumentationClass"><code>DocumentationClass</code></a></em><a href="#documentation--documentationclass" class="hash-link" aria-label="Direct link to documentation--documentationclass" title="Direct link to documentation--documentationclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="domainkey--domainkeyclass">domainKey <em>: <a href="#datahub.metadata.schema_classes.DomainKeyClass"><code>DomainKeyClass</code></a></em><a href="#domainkey--domainkeyclass" class="hash-link" aria-label="Direct link to domainkey--domainkeyclass" title="Direct link to domainkey--domainkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="domainproperties--domainpropertiesclass">domainProperties <em>: <a href="#datahub.metadata.schema_classes.DomainPropertiesClass"><code>DomainPropertiesClass</code></a></em><a href="#domainproperties--domainpropertiesclass" class="hash-link" aria-label="Direct link to domainproperties--domainpropertiesclass" title="Direct link to domainproperties--domainpropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="domains--domainsclass">domains <em>: <a href="#datahub.metadata.schema_classes.DomainsClass"><code>DomainsClass</code></a></em><a href="#domains--domainsclass" class="hash-link" aria-label="Direct link to domains--domainsclass" title="Direct link to domains--domainsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dynamicformassignment--dynamicformassignmentclass">dynamicFormAssignment <em>: <a href="#datahub.metadata.schema_classes.DynamicFormAssignmentClass"><code>DynamicFormAssignmentClass</code></a></em><a href="#dynamicformassignment--dynamicformassignmentclass" class="hash-link" aria-label="Direct link to dynamicformassignment--dynamicformassignmentclass" title="Direct link to dynamicformassignment--dynamicformassignmentclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="editablechartproperties--editablechartpropertiesclass">editableChartProperties <em>: <a href="#datahub.metadata.schema_classes.EditableChartPropertiesClass"><code>EditableChartPropertiesClass</code></a></em><a href="#editablechartproperties--editablechartpropertiesclass" class="hash-link" aria-label="Direct link to editablechartproperties--editablechartpropertiesclass" title="Direct link to editablechartproperties--editablechartpropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="editablecontainerproperties--editablecontainerpropertiesclass">editableContainerProperties <em>: <a href="#datahub.metadata.schema_classes.EditableContainerPropertiesClass"><code>EditableContainerPropertiesClass</code></a></em><a href="#editablecontainerproperties--editablecontainerpropertiesclass" class="hash-link" aria-label="Direct link to editablecontainerproperties--editablecontainerpropertiesclass" title="Direct link to editablecontainerproperties--editablecontainerpropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="editabledashboardproperties--editabledashboardpropertiesclass">editableDashboardProperties <em>: <a href="#datahub.metadata.schema_classes.EditableDashboardPropertiesClass"><code>EditableDashboardPropertiesClass</code></a></em><a href="#editabledashboardproperties--editabledashboardpropertiesclass" class="hash-link" aria-label="Direct link to editabledashboardproperties--editabledashboardpropertiesclass" title="Direct link to editabledashboardproperties--editabledashboardpropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="editabledataflowproperties--editabledataflowpropertiesclass">editableDataFlowProperties <em>: <a href="#datahub.metadata.schema_classes.EditableDataFlowPropertiesClass"><code>EditableDataFlowPropertiesClass</code></a></em><a href="#editabledataflowproperties--editabledataflowpropertiesclass" class="hash-link" aria-label="Direct link to editabledataflowproperties--editabledataflowpropertiesclass" title="Direct link to editabledataflowproperties--editabledataflowpropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="editabledatajobproperties--editabledatajobpropertiesclass">editableDataJobProperties <em>: <a href="#datahub.metadata.schema_classes.EditableDataJobPropertiesClass"><code>EditableDataJobPropertiesClass</code></a></em><a href="#editabledatajobproperties--editabledatajobpropertiesclass" class="hash-link" aria-label="Direct link to editabledatajobproperties--editabledatajobpropertiesclass" title="Direct link to editabledatajobproperties--editabledatajobpropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="editabledatasetproperties--editabledatasetpropertiesclass">editableDatasetProperties <em>: <a href="#datahub.metadata.schema_classes.EditableDatasetPropertiesClass"><code>EditableDatasetPropertiesClass</code></a></em><a href="#editabledatasetproperties--editabledatasetpropertiesclass" class="hash-link" aria-label="Direct link to editabledatasetproperties--editabledatasetpropertiesclass" title="Direct link to editabledatasetproperties--editabledatasetpropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="editableermodelrelationshipproperties--editableermodelrelationshippropertiesclass">editableERModelRelationshipProperties <em>: <a href="#datahub.metadata.schema_classes.EditableERModelRelationshipPropertiesClass"><code>EditableERModelRelationshipPropertiesClass</code></a></em><a href="#editableermodelrelationshipproperties--editableermodelrelationshippropertiesclass" class="hash-link" aria-label="Direct link to editableermodelrelationshipproperties--editableermodelrelationshippropertiesclass" title="Direct link to editableermodelrelationshipproperties--editableermodelrelationshippropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="editablemlfeatureproperties--editablemlfeaturepropertiesclass">editableMlFeatureProperties <em>: <a href="#datahub.metadata.schema_classes.EditableMLFeaturePropertiesClass"><code>EditableMLFeaturePropertiesClass</code></a></em><a href="#editablemlfeatureproperties--editablemlfeaturepropertiesclass" class="hash-link" aria-label="Direct link to editablemlfeatureproperties--editablemlfeaturepropertiesclass" title="Direct link to editablemlfeatureproperties--editablemlfeaturepropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="editablemlfeaturetableproperties--editablemlfeaturetablepropertiesclass">editableMlFeatureTableProperties <em>: <a href="#datahub.metadata.schema_classes.EditableMLFeatureTablePropertiesClass"><code>EditableMLFeatureTablePropertiesClass</code></a></em><a href="#editablemlfeaturetableproperties--editablemlfeaturetablepropertiesclass" class="hash-link" aria-label="Direct link to editablemlfeaturetableproperties--editablemlfeaturetablepropertiesclass" title="Direct link to editablemlfeaturetableproperties--editablemlfeaturetablepropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="editablemlmodelgroupproperties--editablemlmodelgrouppropertiesclass">editableMlModelGroupProperties <em>: <a href="#datahub.metadata.schema_classes.EditableMLModelGroupPropertiesClass"><code>EditableMLModelGroupPropertiesClass</code></a></em><a href="#editablemlmodelgroupproperties--editablemlmodelgrouppropertiesclass" class="hash-link" aria-label="Direct link to editablemlmodelgroupproperties--editablemlmodelgrouppropertiesclass" title="Direct link to editablemlmodelgroupproperties--editablemlmodelgrouppropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="editablemlmodelproperties--editablemlmodelpropertiesclass">editableMlModelProperties <em>: <a href="#datahub.metadata.schema_classes.EditableMLModelPropertiesClass"><code>EditableMLModelPropertiesClass</code></a></em><a href="#editablemlmodelproperties--editablemlmodelpropertiesclass" class="hash-link" aria-label="Direct link to editablemlmodelproperties--editablemlmodelpropertiesclass" title="Direct link to editablemlmodelproperties--editablemlmodelpropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="editablemlprimarykeyproperties--editablemlprimarykeypropertiesclass">editableMlPrimaryKeyProperties <em>: <a href="#datahub.metadata.schema_classes.EditableMLPrimaryKeyPropertiesClass"><code>EditableMLPrimaryKeyPropertiesClass</code></a></em><a href="#editablemlprimarykeyproperties--editablemlprimarykeypropertiesclass" class="hash-link" aria-label="Direct link to editablemlprimarykeyproperties--editablemlprimarykeypropertiesclass" title="Direct link to editablemlprimarykeyproperties--editablemlprimarykeypropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="editablenotebookproperties--editablenotebookpropertiesclass">editableNotebookProperties <em>: <a href="#datahub.metadata.schema_classes.EditableNotebookPropertiesClass"><code>EditableNotebookPropertiesClass</code></a></em><a href="#editablenotebookproperties--editablenotebookpropertiesclass" class="hash-link" aria-label="Direct link to editablenotebookproperties--editablenotebookpropertiesclass" title="Direct link to editablenotebookproperties--editablenotebookpropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="editableschemametadata--editableschemametadataclass">editableSchemaMetadata <em>: <a href="#datahub.metadata.schema_classes.EditableSchemaMetadataClass"><code>EditableSchemaMetadataClass</code></a></em><a href="#editableschemametadata--editableschemametadataclass" class="hash-link" aria-label="Direct link to editableschemametadata--editableschemametadataclass" title="Direct link to editableschemametadata--editableschemametadataclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="embed--embedclass">embed <em>: <a href="#datahub.metadata.schema_classes.EmbedClass"><code>EmbedClass</code></a></em><a href="#embed--embedclass" class="hash-link" aria-label="Direct link to embed--embedclass" title="Direct link to embed--embedclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="entitytypeinfo--entitytypeinfoclass">entityTypeInfo <em>: <a href="#datahub.metadata.schema_classes.EntityTypeInfoClass"><code>EntityTypeInfoClass</code></a></em><a href="#entitytypeinfo--entitytypeinfoclass" class="hash-link" aria-label="Direct link to entitytypeinfo--entitytypeinfoclass" title="Direct link to entitytypeinfo--entitytypeinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="entitytypekey--entitytypekeyclass">entityTypeKey <em>: <a href="#datahub.metadata.schema_classes.EntityTypeKeyClass"><code>EntityTypeKeyClass</code></a></em><a href="#entitytypekey--entitytypekeyclass" class="hash-link" aria-label="Direct link to entitytypekey--entitytypekeyclass" title="Direct link to entitytypekey--entitytypekeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="ermodelrelationshipkey--ermodelrelationshipkeyclass">erModelRelationshipKey <em>: <a href="#datahub.metadata.schema_classes.ERModelRelationshipKeyClass"><code>ERModelRelationshipKeyClass</code></a></em><a href="#ermodelrelationshipkey--ermodelrelationshipkeyclass" class="hash-link" aria-label="Direct link to ermodelrelationshipkey--ermodelrelationshipkeyclass" title="Direct link to ermodelrelationshipkey--ermodelrelationshipkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="ermodelrelationshipproperties--ermodelrelationshippropertiesclass">erModelRelationshipProperties <em>: <a href="#datahub.metadata.schema_classes.ERModelRelationshipPropertiesClass"><code>ERModelRelationshipPropertiesClass</code></a></em><a href="#ermodelrelationshipproperties--ermodelrelationshippropertiesclass" class="hash-link" aria-label="Direct link to ermodelrelationshipproperties--ermodelrelationshippropertiesclass" title="Direct link to ermodelrelationshipproperties--ermodelrelationshippropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="forminfo--forminfoclass">formInfo <em>: <a href="#datahub.metadata.schema_classes.FormInfoClass"><code>FormInfoClass</code></a></em><a href="#forminfo--forminfoclass" class="hash-link" aria-label="Direct link to forminfo--forminfoclass" title="Direct link to forminfo--forminfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="formkey--formkeyclass">formKey <em>: <a href="#datahub.metadata.schema_classes.FormKeyClass"><code>FormKeyClass</code></a></em><a href="#formkey--formkeyclass" class="hash-link" aria-label="Direct link to formkey--formkeyclass" title="Direct link to formkey--formkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="forms--formsclass">forms <em>: <a href="#datahub.metadata.schema_classes.FormsClass"><code>FormsClass</code></a></em><a href="#forms--formsclass" class="hash-link" aria-label="Direct link to forms--formsclass" title="Direct link to forms--formsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="globalsettingsinfo--globalsettingsinfoclass">globalSettingsInfo <em>: <a href="#datahub.metadata.schema_classes.GlobalSettingsInfoClass"><code>GlobalSettingsInfoClass</code></a></em><a href="#globalsettingsinfo--globalsettingsinfoclass" class="hash-link" aria-label="Direct link to globalsettingsinfo--globalsettingsinfoclass" title="Direct link to globalsettingsinfo--globalsettingsinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="globalsettingskey--globalsettingskeyclass">globalSettingsKey <em>: <a href="#datahub.metadata.schema_classes.GlobalSettingsKeyClass"><code>GlobalSettingsKeyClass</code></a></em><a href="#globalsettingskey--globalsettingskeyclass" class="hash-link" aria-label="Direct link to globalsettingskey--globalsettingskeyclass" title="Direct link to globalsettingskey--globalsettingskeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="globaltags--globaltagsclass">globalTags <em>: <a href="#datahub.metadata.schema_classes.GlobalTagsClass"><code>GlobalTagsClass</code></a></em><a href="#globaltags--globaltagsclass" class="hash-link" aria-label="Direct link to globaltags--globaltagsclass" title="Direct link to globaltags--globaltagsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="glossarynodeinfo--glossarynodeinfoclass">glossaryNodeInfo <em>: <a href="#datahub.metadata.schema_classes.GlossaryNodeInfoClass"><code>GlossaryNodeInfoClass</code></a></em><a href="#glossarynodeinfo--glossarynodeinfoclass" class="hash-link" aria-label="Direct link to glossarynodeinfo--glossarynodeinfoclass" title="Direct link to glossarynodeinfo--glossarynodeinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="glossarynodekey--glossarynodekeyclass">glossaryNodeKey <em>: <a href="#datahub.metadata.schema_classes.GlossaryNodeKeyClass"><code>GlossaryNodeKeyClass</code></a></em><a href="#glossarynodekey--glossarynodekeyclass" class="hash-link" aria-label="Direct link to glossarynodekey--glossarynodekeyclass" title="Direct link to glossarynodekey--glossarynodekeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="glossaryrelatedterms--glossaryrelatedtermsclass">glossaryRelatedTerms <em>: <a href="#datahub.metadata.schema_classes.GlossaryRelatedTermsClass"><code>GlossaryRelatedTermsClass</code></a></em><a href="#glossaryrelatedterms--glossaryrelatedtermsclass" class="hash-link" aria-label="Direct link to glossaryrelatedterms--glossaryrelatedtermsclass" title="Direct link to glossaryrelatedterms--glossaryrelatedtermsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="glossaryterminfo--glossaryterminfoclass">glossaryTermInfo <em>: <a href="#datahub.metadata.schema_classes.GlossaryTermInfoClass"><code>GlossaryTermInfoClass</code></a></em><a href="#glossaryterminfo--glossaryterminfoclass" class="hash-link" aria-label="Direct link to glossaryterminfo--glossaryterminfoclass" title="Direct link to glossaryterminfo--glossaryterminfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="glossarytermkey--glossarytermkeyclass">glossaryTermKey <em>: <a href="#datahub.metadata.schema_classes.GlossaryTermKeyClass"><code>GlossaryTermKeyClass</code></a></em><a href="#glossarytermkey--glossarytermkeyclass" class="hash-link" aria-label="Direct link to glossarytermkey--glossarytermkeyclass" title="Direct link to glossarytermkey--glossarytermkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="glossaryterms--glossarytermsclass">glossaryTerms <em>: <a href="#datahub.metadata.schema_classes.GlossaryTermsClass"><code>GlossaryTermsClass</code></a></em><a href="#glossaryterms--glossarytermsclass" class="hash-link" aria-label="Direct link to glossaryterms--glossarytermsclass" title="Direct link to glossaryterms--glossarytermsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="groupmembership--groupmembershipclass">groupMembership <em>: <a href="#datahub.metadata.schema_classes.GroupMembershipClass"><code>GroupMembershipClass</code></a></em><a href="#groupmembership--groupmembershipclass" class="hash-link" aria-label="Direct link to groupmembership--groupmembershipclass" title="Direct link to groupmembership--groupmembershipclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="icebergcataloginfo--icebergcataloginfoclass">icebergCatalogInfo <em>: <a href="#datahub.metadata.schema_classes.IcebergCatalogInfoClass"><code>IcebergCatalogInfoClass</code></a></em><a href="#icebergcataloginfo--icebergcataloginfoclass" class="hash-link" aria-label="Direct link to icebergcataloginfo--icebergcataloginfoclass" title="Direct link to icebergcataloginfo--icebergcataloginfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="icebergwarehouseinfo--icebergwarehouseinfoclass">icebergWarehouseInfo <em>: <a href="#datahub.metadata.schema_classes.IcebergWarehouseInfoClass"><code>IcebergWarehouseInfoClass</code></a></em><a href="#icebergwarehouseinfo--icebergwarehouseinfoclass" class="hash-link" aria-label="Direct link to icebergwarehouseinfo--icebergwarehouseinfoclass" title="Direct link to icebergwarehouseinfo--icebergwarehouseinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="incidentinfo--incidentinfoclass">incidentInfo <em>: <a href="#datahub.metadata.schema_classes.IncidentInfoClass"><code>IncidentInfoClass</code></a></em><a href="#incidentinfo--incidentinfoclass" class="hash-link" aria-label="Direct link to incidentinfo--incidentinfoclass" title="Direct link to incidentinfo--incidentinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="incidentkey--incidentkeyclass">incidentKey <em>: <a href="#datahub.metadata.schema_classes.IncidentKeyClass"><code>IncidentKeyClass</code></a></em><a href="#incidentkey--incidentkeyclass" class="hash-link" aria-label="Direct link to incidentkey--incidentkeyclass" title="Direct link to incidentkey--incidentkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="incidentsource--incidentsourceclass">incidentSource <em>: <a href="#datahub.metadata.schema_classes.IncidentSourceClass"><code>IncidentSourceClass</code></a></em><a href="#incidentsource--incidentsourceclass" class="hash-link" aria-label="Direct link to incidentsource--incidentsourceclass" title="Direct link to incidentsource--incidentsourceclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="incidentssummary--incidentssummaryclass">incidentsSummary <em>: <a href="#datahub.metadata.schema_classes.IncidentsSummaryClass"><code>IncidentsSummaryClass</code></a></em><a href="#incidentssummary--incidentssummaryclass" class="hash-link" aria-label="Direct link to incidentssummary--incidentssummaryclass" title="Direct link to incidentssummary--incidentssummaryclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="inputfields--inputfieldsclass">inputFields <em>: <a href="#datahub.metadata.schema_classes.InputFieldsClass"><code>InputFieldsClass</code></a></em><a href="#inputfields--inputfieldsclass" class="hash-link" aria-label="Direct link to inputfields--inputfieldsclass" title="Direct link to inputfields--inputfieldsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="institutionalmemory--institutionalmemoryclass">institutionalMemory <em>: <a href="#datahub.metadata.schema_classes.InstitutionalMemoryClass"><code>InstitutionalMemoryClass</code></a></em><a href="#institutionalmemory--institutionalmemoryclass" class="hash-link" aria-label="Direct link to institutionalmemory--institutionalmemoryclass" title="Direct link to institutionalmemory--institutionalmemoryclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="intendeduse--intendeduseclass">intendedUse <em>: <a href="#datahub.metadata.schema_classes.IntendedUseClass"><code>IntendedUseClass</code></a></em><a href="#intendeduse--intendeduseclass" class="hash-link" aria-label="Direct link to intendeduse--intendeduseclass" title="Direct link to intendeduse--intendeduseclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="invitetoken--invitetokenclass">inviteToken <em>: <a href="#datahub.metadata.schema_classes.InviteTokenClass"><code>InviteTokenClass</code></a></em><a href="#invitetoken--invitetokenclass" class="hash-link" aria-label="Direct link to invitetoken--invitetokenclass" title="Direct link to invitetoken--invitetokenclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="invitetokenkey--invitetokenkeyclass">inviteTokenKey <em>: <a href="#datahub.metadata.schema_classes.InviteTokenKeyClass"><code>InviteTokenKeyClass</code></a></em><a href="#invitetokenkey--invitetokenkeyclass" class="hash-link" aria-label="Direct link to invitetokenkey--invitetokenkeyclass" title="Direct link to invitetokenkey--invitetokenkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mlfeaturekey--mlfeaturekeyclass">mlFeatureKey <em>: <a href="#datahub.metadata.schema_classes.MLFeatureKeyClass"><code>MLFeatureKeyClass</code></a></em><a href="#mlfeaturekey--mlfeaturekeyclass" class="hash-link" aria-label="Direct link to mlfeaturekey--mlfeaturekeyclass" title="Direct link to mlfeaturekey--mlfeaturekeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mlfeatureproperties--mlfeaturepropertiesclass">mlFeatureProperties <em>: <a href="#datahub.metadata.schema_classes.MLFeaturePropertiesClass"><code>MLFeaturePropertiesClass</code></a></em><a href="#mlfeatureproperties--mlfeaturepropertiesclass" class="hash-link" aria-label="Direct link to mlfeatureproperties--mlfeaturepropertiesclass" title="Direct link to mlfeatureproperties--mlfeaturepropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mlfeaturetablekey--mlfeaturetablekeyclass">mlFeatureTableKey <em>: <a href="#datahub.metadata.schema_classes.MLFeatureTableKeyClass"><code>MLFeatureTableKeyClass</code></a></em><a href="#mlfeaturetablekey--mlfeaturetablekeyclass" class="hash-link" aria-label="Direct link to mlfeaturetablekey--mlfeaturetablekeyclass" title="Direct link to mlfeaturetablekey--mlfeaturetablekeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mlfeaturetableproperties--mlfeaturetablepropertiesclass">mlFeatureTableProperties <em>: <a href="#datahub.metadata.schema_classes.MLFeatureTablePropertiesClass"><code>MLFeatureTablePropertiesClass</code></a></em><a href="#mlfeaturetableproperties--mlfeaturetablepropertiesclass" class="hash-link" aria-label="Direct link to mlfeaturetableproperties--mlfeaturetablepropertiesclass" title="Direct link to mlfeaturetableproperties--mlfeaturetablepropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mlhyperparam--mlhyperparamclass">mlHyperParam <em>: <a href="#datahub.metadata.schema_classes.MLHyperParamClass"><code>MLHyperParamClass</code></a></em><a href="#mlhyperparam--mlhyperparamclass" class="hash-link" aria-label="Direct link to mlhyperparam--mlhyperparamclass" title="Direct link to mlhyperparam--mlhyperparamclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mlmetric--mlmetricclass">mlMetric <em>: <a href="#datahub.metadata.schema_classes.MLMetricClass"><code>MLMetricClass</code></a></em><a href="#mlmetric--mlmetricclass" class="hash-link" aria-label="Direct link to mlmetric--mlmetricclass" title="Direct link to mlmetric--mlmetricclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mlmodelcaveatsandrecommendations--caveatsandrecommendationsclass">mlModelCaveatsAndRecommendations <em>: <a href="#datahub.metadata.schema_classes.CaveatsAndRecommendationsClass"><code>CaveatsAndRecommendationsClass</code></a></em><a href="#mlmodelcaveatsandrecommendations--caveatsandrecommendationsclass" class="hash-link" aria-label="Direct link to mlmodelcaveatsandrecommendations--caveatsandrecommendationsclass" title="Direct link to mlmodelcaveatsandrecommendations--caveatsandrecommendationsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mlmodeldeploymentkey--mlmodeldeploymentkeyclass">mlModelDeploymentKey <em>: <a href="#datahub.metadata.schema_classes.MLModelDeploymentKeyClass"><code>MLModelDeploymentKeyClass</code></a></em><a href="#mlmodeldeploymentkey--mlmodeldeploymentkeyclass" class="hash-link" aria-label="Direct link to mlmodeldeploymentkey--mlmodeldeploymentkeyclass" title="Direct link to mlmodeldeploymentkey--mlmodeldeploymentkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mlmodeldeploymentproperties--mlmodeldeploymentpropertiesclass">mlModelDeploymentProperties <em>: <a href="#datahub.metadata.schema_classes.MLModelDeploymentPropertiesClass"><code>MLModelDeploymentPropertiesClass</code></a></em><a href="#mlmodeldeploymentproperties--mlmodeldeploymentpropertiesclass" class="hash-link" aria-label="Direct link to mlmodeldeploymentproperties--mlmodeldeploymentpropertiesclass" title="Direct link to mlmodeldeploymentproperties--mlmodeldeploymentpropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mlmodelethicalconsiderations--ethicalconsiderationsclass">mlModelEthicalConsiderations <em>: <a href="#datahub.metadata.schema_classes.EthicalConsiderationsClass"><code>EthicalConsiderationsClass</code></a></em><a href="#mlmodelethicalconsiderations--ethicalconsiderationsclass" class="hash-link" aria-label="Direct link to mlmodelethicalconsiderations--ethicalconsiderationsclass" title="Direct link to mlmodelethicalconsiderations--ethicalconsiderationsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mlmodelevaluationdata--evaluationdataclass">mlModelEvaluationData <em>: <a href="#datahub.metadata.schema_classes.EvaluationDataClass"><code>EvaluationDataClass</code></a></em><a href="#mlmodelevaluationdata--evaluationdataclass" class="hash-link" aria-label="Direct link to mlmodelevaluationdata--evaluationdataclass" title="Direct link to mlmodelevaluationdata--evaluationdataclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mlmodelfactorprompts--mlmodelfactorpromptsclass">mlModelFactorPrompts <em>: <a href="#datahub.metadata.schema_classes.MLModelFactorPromptsClass"><code>MLModelFactorPromptsClass</code></a></em><a href="#mlmodelfactorprompts--mlmodelfactorpromptsclass" class="hash-link" aria-label="Direct link to mlmodelfactorprompts--mlmodelfactorpromptsclass" title="Direct link to mlmodelfactorprompts--mlmodelfactorpromptsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mlmodelgroupkey--mlmodelgroupkeyclass">mlModelGroupKey <em>: <a href="#datahub.metadata.schema_classes.MLModelGroupKeyClass"><code>MLModelGroupKeyClass</code></a></em><a href="#mlmodelgroupkey--mlmodelgroupkeyclass" class="hash-link" aria-label="Direct link to mlmodelgroupkey--mlmodelgroupkeyclass" title="Direct link to mlmodelgroupkey--mlmodelgroupkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mlmodelgroupproperties--mlmodelgrouppropertiesclass">mlModelGroupProperties <em>: <a href="#datahub.metadata.schema_classes.MLModelGroupPropertiesClass"><code>MLModelGroupPropertiesClass</code></a></em><a href="#mlmodelgroupproperties--mlmodelgrouppropertiesclass" class="hash-link" aria-label="Direct link to mlmodelgroupproperties--mlmodelgrouppropertiesclass" title="Direct link to mlmodelgroupproperties--mlmodelgrouppropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mlmodelkey--mlmodelkeyclass">mlModelKey <em>: <a href="#datahub.metadata.schema_classes.MLModelKeyClass"><code>MLModelKeyClass</code></a></em><a href="#mlmodelkey--mlmodelkeyclass" class="hash-link" aria-label="Direct link to mlmodelkey--mlmodelkeyclass" title="Direct link to mlmodelkey--mlmodelkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mlmodelmetrics--metricsclass">mlModelMetrics <em>: <a href="#datahub.metadata.schema_classes.MetricsClass"><code>MetricsClass</code></a></em><a href="#mlmodelmetrics--metricsclass" class="hash-link" aria-label="Direct link to mlmodelmetrics--metricsclass" title="Direct link to mlmodelmetrics--metricsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mlmodelproperties--mlmodelpropertiesclass">mlModelProperties <em>: <a href="#datahub.metadata.schema_classes.MLModelPropertiesClass"><code>MLModelPropertiesClass</code></a></em><a href="#mlmodelproperties--mlmodelpropertiesclass" class="hash-link" aria-label="Direct link to mlmodelproperties--mlmodelpropertiesclass" title="Direct link to mlmodelproperties--mlmodelpropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mlmodelquantitativeanalyses--quantitativeanalysesclass">mlModelQuantitativeAnalyses <em>: <a href="#datahub.metadata.schema_classes.QuantitativeAnalysesClass"><code>QuantitativeAnalysesClass</code></a></em><a href="#mlmodelquantitativeanalyses--quantitativeanalysesclass" class="hash-link" aria-label="Direct link to mlmodelquantitativeanalyses--quantitativeanalysesclass" title="Direct link to mlmodelquantitativeanalyses--quantitativeanalysesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mlmodeltrainingdata--trainingdataclass">mlModelTrainingData <em>: <a href="#datahub.metadata.schema_classes.TrainingDataClass"><code>TrainingDataClass</code></a></em><a href="#mlmodeltrainingdata--trainingdataclass" class="hash-link" aria-label="Direct link to mlmodeltrainingdata--trainingdataclass" title="Direct link to mlmodeltrainingdata--trainingdataclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mlprimarykeykey--mlprimarykeykeyclass">mlPrimaryKeyKey <em>: <a href="#datahub.metadata.schema_classes.MLPrimaryKeyKeyClass"><code>MLPrimaryKeyKeyClass</code></a></em><a href="#mlprimarykeykey--mlprimarykeykeyclass" class="hash-link" aria-label="Direct link to mlprimarykeykey--mlprimarykeykeyclass" title="Direct link to mlprimarykeykey--mlprimarykeykeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mlprimarykeyproperties--mlprimarykeypropertiesclass">mlPrimaryKeyProperties <em>: <a href="#datahub.metadata.schema_classes.MLPrimaryKeyPropertiesClass"><code>MLPrimaryKeyPropertiesClass</code></a></em><a href="#mlprimarykeyproperties--mlprimarykeypropertiesclass" class="hash-link" aria-label="Direct link to mlprimarykeyproperties--mlprimarykeypropertiesclass" title="Direct link to mlprimarykeyproperties--mlprimarykeypropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mltrainingrunproperties--mltrainingrunpropertiesclass">mlTrainingRunProperties <em>: <a href="#datahub.metadata.schema_classes.MLTrainingRunPropertiesClass"><code>MLTrainingRunPropertiesClass</code></a></em><a href="#mltrainingrunproperties--mltrainingrunpropertiesclass" class="hash-link" aria-label="Direct link to mltrainingrunproperties--mltrainingrunpropertiesclass" title="Direct link to mltrainingrunproperties--mltrainingrunpropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="nativegroupmembership--nativegroupmembershipclass">nativeGroupMembership <em>: <a href="#datahub.metadata.schema_classes.NativeGroupMembershipClass"><code>NativeGroupMembershipClass</code></a></em><a href="#nativegroupmembership--nativegroupmembershipclass" class="hash-link" aria-label="Direct link to nativegroupmembership--nativegroupmembershipclass" title="Direct link to nativegroupmembership--nativegroupmembershipclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="notebookcontent--notebookcontentclass">notebookContent <em>: <a href="#datahub.metadata.schema_classes.NotebookContentClass"><code>NotebookContentClass</code></a></em><a href="#notebookcontent--notebookcontentclass" class="hash-link" aria-label="Direct link to notebookcontent--notebookcontentclass" title="Direct link to notebookcontent--notebookcontentclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="notebookinfo--notebookinfoclass">notebookInfo <em>: <a href="#datahub.metadata.schema_classes.NotebookInfoClass"><code>NotebookInfoClass</code></a></em><a href="#notebookinfo--notebookinfoclass" class="hash-link" aria-label="Direct link to notebookinfo--notebookinfoclass" title="Direct link to notebookinfo--notebookinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="notebookkey--notebookkeyclass">notebookKey <em>: <a href="#datahub.metadata.schema_classes.NotebookKeyClass"><code>NotebookKeyClass</code></a></em><a href="#notebookkey--notebookkeyclass" class="hash-link" aria-label="Direct link to notebookkey--notebookkeyclass" title="Direct link to notebookkey--notebookkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="operation--operationclass">operation <em>: <a href="#datahub.metadata.schema_classes.OperationClass"><code>OperationClass</code></a></em><a href="#operation--operationclass" class="hash-link" aria-label="Direct link to operation--operationclass" title="Direct link to operation--operationclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="origin--originclass">origin <em>: <a href="#datahub.metadata.schema_classes.OriginClass"><code>OriginClass</code></a></em><a href="#origin--originclass" class="hash-link" aria-label="Direct link to origin--originclass" title="Direct link to origin--originclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="ownership--ownershipclass">ownership <em>: <a href="#datahub.metadata.schema_classes.OwnershipClass"><code>OwnershipClass</code></a></em><a href="#ownership--ownershipclass" class="hash-link" aria-label="Direct link to ownership--ownershipclass" title="Direct link to ownership--ownershipclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="ownershiptypeinfo--ownershiptypeinfoclass">ownershipTypeInfo <em>: <a href="#datahub.metadata.schema_classes.OwnershipTypeInfoClass"><code>OwnershipTypeInfoClass</code></a></em><a href="#ownershiptypeinfo--ownershiptypeinfoclass" class="hash-link" aria-label="Direct link to ownershiptypeinfo--ownershiptypeinfoclass" title="Direct link to ownershiptypeinfo--ownershiptypeinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="ownershiptypekey--ownershiptypekeyclass">ownershipTypeKey <em>: <a href="#datahub.metadata.schema_classes.OwnershipTypeKeyClass"><code>OwnershipTypeKeyClass</code></a></em><a href="#ownershiptypekey--ownershiptypekeyclass" class="hash-link" aria-label="Direct link to ownershiptypekey--ownershiptypekeyclass" title="Direct link to ownershiptypekey--ownershiptypekeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="partitionssummary--partitionssummaryclass">partitionsSummary <em>: <a href="#datahub.metadata.schema_classes.PartitionsSummaryClass"><code>PartitionsSummaryClass</code></a></em><a href="#partitionssummary--partitionssummaryclass" class="hash-link" aria-label="Direct link to partitionssummary--partitionssummaryclass" title="Direct link to partitionssummary--partitionssummaryclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="platformresourceinfo--platformresourceinfoclass">platformResourceInfo <em>: <a href="#datahub.metadata.schema_classes.PlatformResourceInfoClass"><code>PlatformResourceInfoClass</code></a></em><a href="#platformresourceinfo--platformresourceinfoclass" class="hash-link" aria-label="Direct link to platformresourceinfo--platformresourceinfoclass" title="Direct link to platformresourceinfo--platformresourceinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="platformresourcekey--platformresourcekeyclass">platformResourceKey <em>: <a href="#datahub.metadata.schema_classes.PlatformResourceKeyClass"><code>PlatformResourceKeyClass</code></a></em><a href="#platformresourcekey--platformresourcekeyclass" class="hash-link" aria-label="Direct link to platformresourcekey--platformresourcekeyclass" title="Direct link to platformresourcekey--platformresourcekeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="postinfo--postinfoclass">postInfo <em>: <a href="#datahub.metadata.schema_classes.PostInfoClass"><code>PostInfoClass</code></a></em><a href="#postinfo--postinfoclass" class="hash-link" aria-label="Direct link to postinfo--postinfoclass" title="Direct link to postinfo--postinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="postkey--postkeyclass">postKey <em>: <a href="#datahub.metadata.schema_classes.PostKeyClass"><code>PostKeyClass</code></a></em><a href="#postkey--postkeyclass" class="hash-link" aria-label="Direct link to postkey--postkeyclass" title="Direct link to postkey--postkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="propertydefinition--structuredpropertydefinitionclass">propertyDefinition <em>: <a href="#datahub.metadata.schema_classes.StructuredPropertyDefinitionClass"><code>StructuredPropertyDefinitionClass</code></a></em><a href="#propertydefinition--structuredpropertydefinitionclass" class="hash-link" aria-label="Direct link to propertydefinition--structuredpropertydefinitionclass" title="Direct link to propertydefinition--structuredpropertydefinitionclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="querykey--querykeyclass">queryKey <em>: <a href="#datahub.metadata.schema_classes.QueryKeyClass"><code>QueryKeyClass</code></a></em><a href="#querykey--querykeyclass" class="hash-link" aria-label="Direct link to querykey--querykeyclass" title="Direct link to querykey--querykeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="queryproperties--querypropertiesclass">queryProperties <em>: <a href="#datahub.metadata.schema_classes.QueryPropertiesClass"><code>QueryPropertiesClass</code></a></em><a href="#queryproperties--querypropertiesclass" class="hash-link" aria-label="Direct link to queryproperties--querypropertiesclass" title="Direct link to queryproperties--querypropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="querysubjects--querysubjectsclass">querySubjects <em>: <a href="#datahub.metadata.schema_classes.QuerySubjectsClass"><code>QuerySubjectsClass</code></a></em><a href="#querysubjects--querysubjectsclass" class="hash-link" aria-label="Direct link to querysubjects--querysubjectsclass" title="Direct link to querysubjects--querysubjectsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="queryusagestatistics--queryusagestatisticsclass">queryUsageStatistics <em>: <a href="#datahub.metadata.schema_classes.QueryUsageStatisticsClass"><code>QueryUsageStatisticsClass</code></a></em><a href="#queryusagestatistics--queryusagestatisticsclass" class="hash-link" aria-label="Direct link to queryusagestatistics--queryusagestatisticsclass" title="Direct link to queryusagestatistics--queryusagestatisticsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="rolekey--rolekeyclass">roleKey <em>: <a href="#datahub.metadata.schema_classes.RoleKeyClass"><code>RoleKeyClass</code></a></em><a href="#rolekey--rolekeyclass" class="hash-link" aria-label="Direct link to rolekey--rolekeyclass" title="Direct link to rolekey--rolekeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="rolemembership--rolemembershipclass">roleMembership <em>: <a href="#datahub.metadata.schema_classes.RoleMembershipClass"><code>RoleMembershipClass</code></a></em><a href="#rolemembership--rolemembershipclass" class="hash-link" aria-label="Direct link to rolemembership--rolemembershipclass" title="Direct link to rolemembership--rolemembershipclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="roleproperties--rolepropertiesclass">roleProperties <em>: <a href="#datahub.metadata.schema_classes.RolePropertiesClass"><code>RolePropertiesClass</code></a></em><a href="#roleproperties--rolepropertiesclass" class="hash-link" aria-label="Direct link to roleproperties--rolepropertiesclass" title="Direct link to roleproperties--rolepropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="schemafieldaliases--schemafieldaliasesclass">schemaFieldAliases <em>: <a href="#datahub.metadata.schema_classes.SchemaFieldAliasesClass"><code>SchemaFieldAliasesClass</code></a></em><a href="#schemafieldaliases--schemafieldaliasesclass" class="hash-link" aria-label="Direct link to schemafieldaliases--schemafieldaliasesclass" title="Direct link to schemafieldaliases--schemafieldaliasesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="schemafieldkey--schemafieldkeyclass">schemaFieldKey <em>: <a href="#datahub.metadata.schema_classes.SchemaFieldKeyClass"><code>SchemaFieldKeyClass</code></a></em><a href="#schemafieldkey--schemafieldkeyclass" class="hash-link" aria-label="Direct link to schemafieldkey--schemafieldkeyclass" title="Direct link to schemafieldkey--schemafieldkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="schemametadata--schemametadataclass">schemaMetadata <em>: <a href="#datahub.metadata.schema_classes.SchemaMetadataClass"><code>SchemaMetadataClass</code></a></em><a href="#schemametadata--schemametadataclass" class="hash-link" aria-label="Direct link to schemametadata--schemametadataclass" title="Direct link to schemametadata--schemametadataclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="schemafieldinfo--schemafieldinfoclass">schemafieldInfo <em>: <a href="#datahub.metadata.schema_classes.SchemaFieldInfoClass"><code>SchemaFieldInfoClass</code></a></em><a href="#schemafieldinfo--schemafieldinfoclass" class="hash-link" aria-label="Direct link to schemafieldinfo--schemafieldinfoclass" title="Direct link to schemafieldinfo--schemafieldinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="siblings--siblingsclass">siblings <em>: <a href="#datahub.metadata.schema_classes.SiblingsClass"><code>SiblingsClass</code></a></em><a href="#siblings--siblingsclass" class="hash-link" aria-label="Direct link to siblings--siblingsclass" title="Direct link to siblings--siblingsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="slackuserinfo--slackuserinfoclass">slackUserInfo <em>: <a href="#datahub.metadata.schema_classes.SlackUserInfoClass"><code>SlackUserInfoClass</code></a></em><a href="#slackuserinfo--slackuserinfoclass" class="hash-link" aria-label="Direct link to slackuserinfo--slackuserinfoclass" title="Direct link to slackuserinfo--slackuserinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sourcecode--sourcecodeclass">sourceCode <em>: <a href="#datahub.metadata.schema_classes.SourceCodeClass"><code>SourceCodeClass</code></a></em><a href="#sourcecode--sourcecodeclass" class="hash-link" aria-label="Direct link to sourcecode--sourcecodeclass" title="Direct link to sourcecode--sourcecodeclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="status--statusclass">status <em>: <a href="#datahub.metadata.schema_classes.StatusClass"><code>StatusClass</code></a></em><a href="#status--statusclass" class="hash-link" aria-label="Direct link to status--statusclass" title="Direct link to status--statusclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="structuredproperties--structuredpropertiesclass">structuredProperties <em>: <a href="#datahub.metadata.schema_classes.StructuredPropertiesClass"><code>StructuredPropertiesClass</code></a></em><a href="#structuredproperties--structuredpropertiesclass" class="hash-link" aria-label="Direct link to structuredproperties--structuredpropertiesclass" title="Direct link to structuredproperties--structuredpropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="structuredpropertykey--structuredpropertykeyclass">structuredPropertyKey <em>: <a href="#datahub.metadata.schema_classes.StructuredPropertyKeyClass"><code>StructuredPropertyKeyClass</code></a></em><a href="#structuredpropertykey--structuredpropertykeyclass" class="hash-link" aria-label="Direct link to structuredpropertykey--structuredpropertykeyclass" title="Direct link to structuredpropertykey--structuredpropertykeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="structuredpropertysettings--structuredpropertysettingsclass">structuredPropertySettings <em>: <a href="#datahub.metadata.schema_classes.StructuredPropertySettingsClass"><code>StructuredPropertySettingsClass</code></a></em><a href="#structuredpropertysettings--structuredpropertysettingsclass" class="hash-link" aria-label="Direct link to structuredpropertysettings--structuredpropertysettingsclass" title="Direct link to structuredpropertysettings--structuredpropertysettingsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="subtypes--subtypesclass">subTypes <em>: <a href="#datahub.metadata.schema_classes.SubTypesClass"><code>SubTypesClass</code></a></em><a href="#subtypes--subtypesclass" class="hash-link" aria-label="Direct link to subtypes--subtypesclass" title="Direct link to subtypes--subtypesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="systemmetadata--systemmetadataclass">systemMetadata <em>: <a href="#datahub.metadata.schema_classes.SystemMetadataClass"><code>SystemMetadataClass</code></a></em><a href="#systemmetadata--systemmetadataclass" class="hash-link" aria-label="Direct link to systemmetadata--systemmetadataclass" title="Direct link to systemmetadata--systemmetadataclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="tagkey--tagkeyclass">tagKey <em>: <a href="#datahub.metadata.schema_classes.TagKeyClass"><code>TagKeyClass</code></a></em><a href="#tagkey--tagkeyclass" class="hash-link" aria-label="Direct link to tagkey--tagkeyclass" title="Direct link to tagkey--tagkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="tagproperties--tagpropertiesclass">tagProperties <em>: <a href="#datahub.metadata.schema_classes.TagPropertiesClass"><code>TagPropertiesClass</code></a></em><a href="#tagproperties--tagpropertiesclass" class="hash-link" aria-label="Direct link to tagproperties--tagpropertiesclass" title="Direct link to tagproperties--tagpropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="telemetryclientid--telemetryclientidclass">telemetryClientId <em>: <a href="#datahub.metadata.schema_classes.TelemetryClientIdClass"><code>TelemetryClientIdClass</code></a></em><a href="#telemetryclientid--telemetryclientidclass" class="hash-link" aria-label="Direct link to telemetryclientid--telemetryclientidclass" title="Direct link to telemetryclientid--telemetryclientidclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="telemetrykey--telemetrykeyclass">telemetryKey <em>: <a href="#datahub.metadata.schema_classes.TelemetryKeyClass"><code>TelemetryKeyClass</code></a></em><a href="#telemetrykey--telemetrykeyclass" class="hash-link" aria-label="Direct link to telemetrykey--telemetrykeyclass" title="Direct link to telemetrykey--telemetrykeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="testinfo--testinfoclass">testInfo <em>: <a href="#datahub.metadata.schema_classes.TestInfoClass"><code>TestInfoClass</code></a></em><a href="#testinfo--testinfoclass" class="hash-link" aria-label="Direct link to testinfo--testinfoclass" title="Direct link to testinfo--testinfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="testkey--testkeyclass">testKey <em>: <a href="#datahub.metadata.schema_classes.TestKeyClass"><code>TestKeyClass</code></a></em><a href="#testkey--testkeyclass" class="hash-link" aria-label="Direct link to testkey--testkeyclass" title="Direct link to testkey--testkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="testresults--testresultsclass">testResults <em>: <a href="#datahub.metadata.schema_classes.TestResultsClass"><code>TestResultsClass</code></a></em><a href="#testresults--testresultsclass" class="hash-link" aria-label="Direct link to testresults--testresultsclass" title="Direct link to testresults--testresultsclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="upstreamlineage--upstreamlineageclass">upstreamLineage <em>: <a href="#datahub.metadata.schema_classes.UpstreamLineageClass"><code>UpstreamLineageClass</code></a></em><a href="#upstreamlineage--upstreamlineageclass" class="hash-link" aria-label="Direct link to upstreamlineage--upstreamlineageclass" title="Direct link to upstreamlineage--upstreamlineageclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="versioninfo--versioninfoclass">versionInfo <em>: <a href="#datahub.metadata.schema_classes.VersionInfoClass"><code>VersionInfoClass</code></a></em><a href="#versioninfo--versioninfoclass" class="hash-link" aria-label="Direct link to versioninfo--versioninfoclass" title="Direct link to versioninfo--versioninfoclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="versionproperties--versionpropertiesclass">versionProperties <em>: <a href="#datahub.metadata.schema_classes.VersionPropertiesClass"><code>VersionPropertiesClass</code></a></em><a href="#versionproperties--versionpropertiesclass" class="hash-link" aria-label="Direct link to versionproperties--versionpropertiesclass" title="Direct link to versionproperties--versionpropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="versionsetkey--versionsetkeyclass">versionSetKey <em>: <a href="#datahub.metadata.schema_classes.VersionSetKeyClass"><code>VersionSetKeyClass</code></a></em><a href="#versionsetkey--versionsetkeyclass" class="hash-link" aria-label="Direct link to versionsetkey--versionsetkeyclass" title="Direct link to versionsetkey--versionsetkeyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="versionsetproperties--versionsetpropertiesclass">versionSetProperties <em>: <a href="#datahub.metadata.schema_classes.VersionSetPropertiesClass"><code>VersionSetPropertiesClass</code></a></em><a href="#versionsetproperties--versionsetpropertiesclass" class="hash-link" aria-label="Direct link to versionsetproperties--versionsetpropertiesclass" title="Direct link to versionsetproperties--versionsetpropertiesclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="viewproperties--viewpropertiesclass">viewProperties <em>: <a href="#datahub.metadata.schema_classes.ViewPropertiesClass"><code>ViewPropertiesClass</code></a></em><a href="#viewproperties--viewpropertiesclass" class="hash-link" aria-label="Direct link to viewproperties--viewpropertiesclass" title="Direct link to viewproperties--viewpropertiesclass"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AssertionActionClass"><span class="visually-hidden">AssertionActionClass</span><a href="#datahub.metadata.schema_classes.AssertionActionClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AssertionActionClass" title="Direct link to datahub.metadata.schema_classes.AssertionActionClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AssertionActionClass</span>(<span class="arg-name">type</span>)<a href="#datahub.metadata.schema_classes.AssertionActionClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>The Actions about an Assertion.
|
||
In the future, we’ll likely extend this model to support additional
|
||
parameters or options related to the assertion actions.</p><ul><li><strong>Parameters:</strong><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.AssertionActionTypeClass"><code>AssertionActionTypeClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--assertionactiontypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.AssertionActionTypeClass">AssertionActionTypeClass</a></em><a href="#property-type--str--assertionactiontypeclass" class="hash-link" aria-label="Direct link to property-type--str--assertionactiontypeclass" title="Direct link to property-type--str--assertionactiontypeclass"></a></h4><p>The type of the Action</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AssertionActionTypeClass"><span class="visually-hidden">AssertionActionTypeClass</span><a href="#datahub.metadata.schema_classes.AssertionActionTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AssertionActionTypeClass" title="Direct link to datahub.metadata.schema_classes.AssertionActionTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AssertionActionTypeClass</span>()<a href="#datahub.metadata.schema_classes.AssertionActionTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="raise_incident--raise_incident">RAISE_INCIDENT <em>= 'RAISE_INCIDENT'</em><a href="#raise_incident--raise_incident" class="hash-link" aria-label="Direct link to raise_incident--raise_incident" title="Direct link to raise_incident--raise_incident"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="resolve_incident--resolve_incident">RESOLVE_INCIDENT <em>= 'RESOLVE_INCIDENT'</em><a href="#resolve_incident--resolve_incident" class="hash-link" aria-label="Direct link to resolve_incident--resolve_incident" title="Direct link to resolve_incident--resolve_incident"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AssertionActionsClass"><span class="visually-hidden">AssertionActionsClass</span><a href="#datahub.metadata.schema_classes.AssertionActionsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AssertionActionsClass" title="Direct link to datahub.metadata.schema_classes.AssertionActionsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AssertionActionsClass</span>(<span class="arg-name">onSuccess</span> = <span class="arg-default">None</span>, <span class="arg-name">onFailure</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.AssertionActionsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>The Actions about an Assertion</p><ul><li><strong>Parameters:</strong><ul><li><strong>onSuccess</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.AssertionActionClass"><code>AssertionActionClass</code></a>]]) – </li><li><strong>onFailure</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.AssertionActionClass"><code>AssertionActionClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-onfailure--listassertionactionclass"><em>property</em> onFailure <em>: List[<a href="#datahub.metadata.schema_classes.AssertionActionClass">AssertionActionClass</a>]</em><a href="#property-onfailure--listassertionactionclass" class="hash-link" aria-label="Direct link to property-onfailure--listassertionactionclass" title="Direct link to property-onfailure--listassertionactionclass"></a></h4><p>Actions to be executed on failed assertion run.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-onsuccess--listassertionactionclass"><em>property</em> onSuccess <em>: List[<a href="#datahub.metadata.schema_classes.AssertionActionClass">AssertionActionClass</a>]</em><a href="#property-onsuccess--listassertionactionclass" class="hash-link" aria-label="Direct link to property-onsuccess--listassertionactionclass" title="Direct link to property-onsuccess--listassertionactionclass"></a></h4><p>Actions to be executed on successful assertion run.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AssertionInfoClass"><span class="visually-hidden">AssertionInfoClass</span><a href="#datahub.metadata.schema_classes.AssertionInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AssertionInfoClass" title="Direct link to datahub.metadata.schema_classes.AssertionInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AssertionInfoClass</span>(<span class="arg-name">type</span>, <span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">externalUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">datasetAssertion</span> = <span class="arg-default">None</span>, <span class="arg-name">freshnessAssertion</span> = <span class="arg-default">None</span>, <span class="arg-name">volumeAssertion</span> = <span class="arg-default">None</span>, <span class="arg-name">sqlAssertion</span> = <span class="arg-default">None</span>, <span class="arg-name">fieldAssertion</span> = <span class="arg-default">None</span>, <span class="arg-name">schemaAssertion</span> = <span class="arg-default">None</span>, <span class="arg-name">customAssertion</span> = <span class="arg-default">None</span>, <span class="arg-name">source</span> = <span class="arg-default">None</span>, <span class="arg-name">lastUpdated</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.AssertionInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about an assertion</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.AssertionTypeClass"><code>AssertionTypeClass</code></a>]) – </li><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>externalUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>datasetAssertion</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.DatasetAssertionInfoClass"><code>DatasetAssertionInfoClass</code></a>]) – </li><li><strong>freshnessAssertion</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.FreshnessAssertionInfoClass"><code>FreshnessAssertionInfoClass</code></a>]) – </li><li><strong>volumeAssertion</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.VolumeAssertionInfoClass"><code>VolumeAssertionInfoClass</code></a>]) – </li><li><strong>sqlAssertion</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.SqlAssertionInfoClass"><code>SqlAssertionInfoClass</code></a>]) – </li><li><strong>fieldAssertion</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.FieldAssertionInfoClass"><code>FieldAssertionInfoClass</code></a>]) – </li><li><strong>schemaAssertion</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.SchemaAssertionInfoClass"><code>SchemaAssertionInfoClass</code></a>]) – </li><li><strong>customAssertion</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.CustomAssertionInfoClass"><code>CustomAssertionInfoClass</code></a>]) – </li><li><strong>source</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AssertionSourceClass"><code>AssertionSourceClass</code></a>]) – </li><li><strong>lastUpdated</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customassertion--none--customassertioninfoclass"><em>property</em> customAssertion <em>: None | <a href="#datahub.metadata.schema_classes.CustomAssertionInfoClass">CustomAssertionInfoClass</a></em><a href="#property-customassertion--none--customassertioninfoclass" class="hash-link" aria-label="Direct link to property-customassertion--none--customassertioninfoclass" title="Direct link to property-customassertion--none--customassertioninfoclass"></a></h4><p>A Custom Assertion definition. This field is populated when type is CUSTOM.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-1"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-1" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-1" title="Direct link to property-customproperties--dictstr-str-1"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-datasetassertion--none--datasetassertioninfoclass"><em>property</em> datasetAssertion <em>: None | <a href="#datahub.metadata.schema_classes.DatasetAssertionInfoClass">DatasetAssertionInfoClass</a></em><a href="#property-datasetassertion--none--datasetassertioninfoclass" class="hash-link" aria-label="Direct link to property-datasetassertion--none--datasetassertioninfoclass" title="Direct link to property-datasetassertion--none--datasetassertioninfoclass"></a></h4><p>A Dataset Assertion definition. This field is populated when the type is DATASET.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-1"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-1" class="hash-link" aria-label="Direct link to property-description--none--str-1" title="Direct link to property-description--none--str-1"></a></h4><p>An optional human-readable description of the assertion</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-externalurl--none--str-1"><em>property</em> externalUrl <em>: None | str</em><a href="#property-externalurl--none--str-1" class="hash-link" aria-label="Direct link to property-externalurl--none--str-1" title="Direct link to property-externalurl--none--str-1"></a></h4><p>URL where the reference exist</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fieldassertion--none--fieldassertioninfoclass"><em>property</em> fieldAssertion <em>: None | <a href="#datahub.metadata.schema_classes.FieldAssertionInfoClass">FieldAssertionInfoClass</a></em><a href="#property-fieldassertion--none--fieldassertioninfoclass" class="hash-link" aria-label="Direct link to property-fieldassertion--none--fieldassertioninfoclass" title="Direct link to property-fieldassertion--none--fieldassertioninfoclass"></a></h4><p>A Field Assertion definition. This field is populated when the type is FIELD.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-freshnessassertion--none--freshnessassertioninfoclass"><em>property</em> freshnessAssertion <em>: None | <a href="#datahub.metadata.schema_classes.FreshnessAssertionInfoClass">FreshnessAssertionInfoClass</a></em><a href="#property-freshnessassertion--none--freshnessassertioninfoclass" class="hash-link" aria-label="Direct link to property-freshnessassertion--none--freshnessassertioninfoclass" title="Direct link to property-freshnessassertion--none--freshnessassertioninfoclass"></a></h4><p>An Freshness Assertion definition. This field is populated when the type is FRESHNESS.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastupdated--none--auditstampclass"><em>property</em> lastUpdated <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastupdated--none--auditstampclass" class="hash-link" aria-label="Direct link to property-lastupdated--none--auditstampclass" title="Direct link to property-lastupdated--none--auditstampclass"></a></h4><p>The time at which the assertion was last updated and the actor who updated it.
|
||
This field is only present for Native assertions updated after this field was introduced.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-schemaassertion--none--schemaassertioninfoclass"><em>property</em> schemaAssertion <em>: None | <a href="#datahub.metadata.schema_classes.SchemaAssertionInfoClass">SchemaAssertionInfoClass</a></em><a href="#property-schemaassertion--none--schemaassertioninfoclass" class="hash-link" aria-label="Direct link to property-schemaassertion--none--schemaassertioninfoclass" title="Direct link to property-schemaassertion--none--schemaassertioninfoclass"></a></h4><p>An schema Assertion definition. This field is populated when the type is DATA_SCHEMA</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-source--none--assertionsourceclass"><em>property</em> source <em>: None | <a href="#datahub.metadata.schema_classes.AssertionSourceClass">AssertionSourceClass</a></em><a href="#property-source--none--assertionsourceclass" class="hash-link" aria-label="Direct link to property-source--none--assertionsourceclass" title="Direct link to property-source--none--assertionsourceclass"></a></h4><p>The source or origin of the Assertion definition.</p><p>If the source type of the Assertion is EXTERNAL, it is expected to have a corresponding dataPlatformInstance aspect detailing
|
||
the platform where it was ingested from.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-sqlassertion--none--sqlassertioninfoclass"><em>property</em> sqlAssertion <em>: None | <a href="#datahub.metadata.schema_classes.SqlAssertionInfoClass">SqlAssertionInfoClass</a></em><a href="#property-sqlassertion--none--sqlassertioninfoclass" class="hash-link" aria-label="Direct link to property-sqlassertion--none--sqlassertioninfoclass" title="Direct link to property-sqlassertion--none--sqlassertioninfoclass"></a></h4><p>A SQL Assertion definition. This field is populated when the type is SQL.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--assertiontypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.AssertionTypeClass">AssertionTypeClass</a></em><a href="#property-type--str--assertiontypeclass" class="hash-link" aria-label="Direct link to property-type--str--assertiontypeclass" title="Direct link to property-type--str--assertiontypeclass"></a></h4><p>Type of assertion. Assertion types can evolve to span Datasets, Flows (Pipelines), Models, Features etc.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-volumeassertion--none--volumeassertioninfoclass"><em>property</em> volumeAssertion <em>: None | <a href="#datahub.metadata.schema_classes.VolumeAssertionInfoClass">VolumeAssertionInfoClass</a></em><a href="#property-volumeassertion--none--volumeassertioninfoclass" class="hash-link" aria-label="Direct link to property-volumeassertion--none--volumeassertioninfoclass" title="Direct link to property-volumeassertion--none--volumeassertioninfoclass"></a></h4><p>An Volume Assertion definition. This field is populated when the type is VOLUME.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AssertionKeyClass"><span class="visually-hidden">AssertionKeyClass</span><a href="#datahub.metadata.schema_classes.AssertionKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AssertionKeyClass" title="Direct link to datahub.metadata.schema_classes.AssertionKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AssertionKeyClass</span>(<span class="arg-name">assertionId</span>)<a href="#datahub.metadata.schema_classes.AssertionKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Assertion</p><ul><li><strong>Parameters:</strong><strong>assertionId</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-assertionid--str"><em>property</em> assertionId <em>: str</em><a href="#property-assertionid--str" class="hash-link" aria-label="Direct link to property-assertionid--str" title="Direct link to property-assertionid--str"></a></h4><p>Unique id for the assertion.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AssertionResultClass"><span class="visually-hidden">AssertionResultClass</span><a href="#datahub.metadata.schema_classes.AssertionResultClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AssertionResultClass" title="Direct link to datahub.metadata.schema_classes.AssertionResultClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AssertionResultClass</span>(<span class="arg-name">type</span>, <span class="arg-name">rowCount</span> = <span class="arg-default">None</span>, <span class="arg-name">missingCount</span> = <span class="arg-default">None</span>, <span class="arg-name">unexpectedCount</span> = <span class="arg-default">None</span>, <span class="arg-name">actualAggValue</span> = <span class="arg-default">None</span>, <span class="arg-name">nativeResults</span> = <span class="arg-default">None</span>, <span class="arg-name">externalUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">error</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.AssertionResultClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>The result of running an assertion</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.AssertionResultTypeClass"><code>AssertionResultTypeClass</code></a>]) – </li><li><strong>rowCount</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>missingCount</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>unexpectedCount</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>actualAggValue</strong> (<code>Optional</code>[<code>float</code>]<!-- -->)</li><li><strong>nativeResults</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>externalUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>error</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AssertionResultErrorClass"><code>AssertionResultErrorClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-actualaggvalue--none--float"><em>property</em> actualAggValue <em>: None | float</em><a href="#property-actualaggvalue--none--float" class="hash-link" aria-label="Direct link to property-actualaggvalue--none--float" title="Direct link to property-actualaggvalue--none--float"></a></h4><p>Observed aggregate value for evaluated batch</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-error--none--assertionresulterrorclass"><em>property</em> error <em>: None | <a href="#datahub.metadata.schema_classes.AssertionResultErrorClass">AssertionResultErrorClass</a></em><a href="#property-error--none--assertionresulterrorclass" class="hash-link" aria-label="Direct link to property-error--none--assertionresulterrorclass" title="Direct link to property-error--none--assertionresulterrorclass"></a></h4><p>The error object if AssertionResultType is an Error</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-externalurl--none--str-2"><em>property</em> externalUrl <em>: None | str</em><a href="#property-externalurl--none--str-2" class="hash-link" aria-label="Direct link to property-externalurl--none--str-2" title="Direct link to property-externalurl--none--str-2"></a></h4><p>External URL where full results are available. Only present when assertion source is not native.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-missingcount--none--int"><em>property</em> missingCount <em>: None | int</em><a href="#property-missingcount--none--int" class="hash-link" aria-label="Direct link to property-missingcount--none--int" title="Direct link to property-missingcount--none--int"></a></h4><p>Number of rows with missing value for evaluated batch</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-nativeresults--none--dictstr-str"><em>property</em> nativeResults <em>: None | Dict<!-- -->[str, str]</em><a href="#property-nativeresults--none--dictstr-str" class="hash-link" aria-label="Direct link to property-nativeresults--none--dictstr-str" title="Direct link to property-nativeresults--none--dictstr-str"></a></h4><p>Other results of evaluation</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-rowcount--none--int"><em>property</em> rowCount <em>: None | int</em><a href="#property-rowcount--none--int" class="hash-link" aria-label="Direct link to property-rowcount--none--int" title="Direct link to property-rowcount--none--int"></a></h4><p>Number of rows for evaluated batch</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--assertionresulttypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.AssertionResultTypeClass">AssertionResultTypeClass</a></em><a href="#property-type--str--assertionresulttypeclass" class="hash-link" aria-label="Direct link to property-type--str--assertionresulttypeclass" title="Direct link to property-type--str--assertionresulttypeclass"></a></h4><p>The final result, e.g. either SUCCESS, FAILURE, or ERROR.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-unexpectedcount--none--int"><em>property</em> unexpectedCount <em>: None | int</em><a href="#property-unexpectedcount--none--int" class="hash-link" aria-label="Direct link to property-unexpectedcount--none--int" title="Direct link to property-unexpectedcount--none--int"></a></h4><p>Number of rows with unexpected value for evaluated batch</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AssertionResultErrorClass"><span class="visually-hidden">AssertionResultErrorClass</span><a href="#datahub.metadata.schema_classes.AssertionResultErrorClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AssertionResultErrorClass" title="Direct link to datahub.metadata.schema_classes.AssertionResultErrorClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AssertionResultErrorClass</span>(<span class="arg-name">type</span>, <span class="arg-name">properties</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.AssertionResultErrorClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>An error encountered when evaluating an AssertionResult</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.AssertionResultErrorTypeClass"><code>AssertionResultErrorTypeClass</code></a>]) – </li><li><strong>properties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-properties--none--dictstr-str"><em>property</em> properties <em>: None | Dict<!-- -->[str, str]</em><a href="#property-properties--none--dictstr-str" class="hash-link" aria-label="Direct link to property-properties--none--dictstr-str" title="Direct link to property-properties--none--dictstr-str"></a></h4><p>Additional metadata depending on the type of error</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--assertionresulterrortypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.AssertionResultErrorTypeClass">AssertionResultErrorTypeClass</a></em><a href="#property-type--str--assertionresulterrortypeclass" class="hash-link" aria-label="Direct link to property-type--str--assertionresulterrortypeclass" title="Direct link to property-type--str--assertionresulterrortypeclass"></a></h4><p>The type of error encountered</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AssertionResultErrorTypeClass"><span class="visually-hidden">AssertionResultErrorTypeClass</span><a href="#datahub.metadata.schema_classes.AssertionResultErrorTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AssertionResultErrorTypeClass" title="Direct link to datahub.metadata.schema_classes.AssertionResultErrorTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AssertionResultErrorTypeClass</span>()<a href="#datahub.metadata.schema_classes.AssertionResultErrorTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="custom_sql_error--custom_sql_error">CUSTOM_SQL_ERROR <em>= 'CUSTOM_SQL_ERROR'</em><a href="#custom_sql_error--custom_sql_error" class="hash-link" aria-label="Direct link to custom_sql_error--custom_sql_error" title="Direct link to custom_sql_error--custom_sql_error"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="field_assertion_error--field_assertion_error">FIELD_ASSERTION_ERROR <em>= 'FIELD_ASSERTION_ERROR'</em><a href="#field_assertion_error--field_assertion_error" class="hash-link" aria-label="Direct link to field_assertion_error--field_assertion_error" title="Direct link to field_assertion_error--field_assertion_error"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="insufficient_data--insufficient_data">INSUFFICIENT_DATA <em>= 'INSUFFICIENT_DATA'</em><a href="#insufficient_data--insufficient_data" class="hash-link" aria-label="Direct link to insufficient_data--insufficient_data" title="Direct link to insufficient_data--insufficient_data"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="invalid_parameters--invalid_parameters">INVALID_PARAMETERS <em>= 'INVALID_PARAMETERS'</em><a href="#invalid_parameters--invalid_parameters" class="hash-link" aria-label="Direct link to invalid_parameters--invalid_parameters" title="Direct link to invalid_parameters--invalid_parameters"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="invalid_source_type--invalid_source_type">INVALID_SOURCE_TYPE <em>= 'INVALID_SOURCE_TYPE'</em><a href="#invalid_source_type--invalid_source_type" class="hash-link" aria-label="Direct link to invalid_source_type--invalid_source_type" title="Direct link to invalid_source_type--invalid_source_type"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="source_connection_error--source_connection_error">SOURCE_CONNECTION_ERROR <em>= 'SOURCE_CONNECTION_ERROR'</em><a href="#source_connection_error--source_connection_error" class="hash-link" aria-label="Direct link to source_connection_error--source_connection_error" title="Direct link to source_connection_error--source_connection_error"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="source_query_failed--source_query_failed">SOURCE_QUERY_FAILED <em>= 'SOURCE_QUERY_FAILED'</em><a href="#source_query_failed--source_query_failed" class="hash-link" aria-label="Direct link to source_query_failed--source_query_failed" title="Direct link to source_query_failed--source_query_failed"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="unknown_error--unknown_error">UNKNOWN_ERROR <em>= 'UNKNOWN_ERROR'</em><a href="#unknown_error--unknown_error" class="hash-link" aria-label="Direct link to unknown_error--unknown_error" title="Direct link to unknown_error--unknown_error"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="unsupported_platform--unsupported_platform">UNSUPPORTED_PLATFORM <em>= 'UNSUPPORTED_PLATFORM'</em><a href="#unsupported_platform--unsupported_platform" class="hash-link" aria-label="Direct link to unsupported_platform--unsupported_platform" title="Direct link to unsupported_platform--unsupported_platform"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AssertionResultTypeClass"><span class="visually-hidden">AssertionResultTypeClass</span><a href="#datahub.metadata.schema_classes.AssertionResultTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AssertionResultTypeClass" title="Direct link to datahub.metadata.schema_classes.AssertionResultTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AssertionResultTypeClass</span>()<a href="#datahub.metadata.schema_classes.AssertionResultTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>The final result of evaluating an assertion, e.g. SUCCESS, FAILURE, or ERROR.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="error--error">ERROR <em>= 'ERROR'</em><a href="#error--error" class="hash-link" aria-label="Direct link to error--error" title="Direct link to error--error"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="failure--failure">FAILURE <em>= 'FAILURE'</em><a href="#failure--failure" class="hash-link" aria-label="Direct link to failure--failure" title="Direct link to failure--failure"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="init--init">INIT <em>= 'INIT'</em><a href="#init--init" class="hash-link" aria-label="Direct link to init--init" title="Direct link to init--init"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="success--success">SUCCESS <em>= 'SUCCESS'</em><a href="#success--success" class="hash-link" aria-label="Direct link to success--success" title="Direct link to success--success"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AssertionRunEventClass"><span class="visually-hidden">AssertionRunEventClass</span><a href="#datahub.metadata.schema_classes.AssertionRunEventClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AssertionRunEventClass" title="Direct link to datahub.metadata.schema_classes.AssertionRunEventClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AssertionRunEventClass</span>(<span class="arg-name">timestampMillis</span>, <span class="arg-name">runId</span>, <span class="arg-name">asserteeUrn</span>, <span class="arg-name">status</span>, <span class="arg-name">assertionUrn</span>, <span class="arg-name">result</span> = <span class="arg-default">None</span>, <span class="arg-name">runtimeContext</span> = <span class="arg-default">None</span>, <span class="arg-name">batchSpec</span> = <span class="arg-default">None</span>, <span class="arg-name">eventGranularity</span> = <span class="arg-default">None</span>, <span class="arg-name">partitionSpec</span> = <span class="arg-default">None</span>, <span class="arg-name">messageId</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.AssertionRunEventClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>An event representing the current status of evaluating an assertion on a batch.
|
||
AssertionRunEvent should be used for reporting the status of a run as an assertion evaluation progresses.</p><ul><li><strong>Parameters:</strong><ul><li><strong>timestampMillis</strong> (<code>int</code>)</li><li><strong>runId</strong> (<code>str</code>)</li><li><strong>asserteeUrn</strong> (<code>str</code>)</li><li><strong>status</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.AssertionRunStatusClass"><code>AssertionRunStatusClass</code></a>]) – </li><li><strong>assertionUrn</strong> (<code>str</code>)</li><li><strong>result</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AssertionResultClass"><code>AssertionResultClass</code></a>]) – </li><li><strong>runtimeContext</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>batchSpec</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.BatchSpecClass"><code>BatchSpecClass</code></a>]) – </li><li><strong>eventGranularity</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeWindowSizeClass"><code>TimeWindowSizeClass</code></a>]) – </li><li><strong>partitionSpec</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.PartitionSpecClass"><code>PartitionSpecClass</code></a>]) – </li><li><strong>messageId</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="aspect_type--classvarstr--timeseries">ASPECT_TYPE <em>: <code>ClassVar</code>[<code>str</code>]</em> <em>= 'timeseries'</em><a href="#aspect_type--classvarstr--timeseries" class="hash-link" aria-label="Direct link to aspect_type--classvarstr--timeseries" title="Direct link to aspect_type--classvarstr--timeseries"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-asserteeurn--str"><em>property</em> asserteeUrn <em>: str</em><a href="#property-asserteeurn--str" class="hash-link" aria-label="Direct link to property-asserteeurn--str" title="Direct link to property-asserteeurn--str"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-assertionurn--str"><em>property</em> assertionUrn <em>: str</em><a href="#property-assertionurn--str" class="hash-link" aria-label="Direct link to property-assertionurn--str" title="Direct link to property-assertionurn--str"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-batchspec--none--batchspecclass"><em>property</em> batchSpec <em>: None | <a href="#datahub.metadata.schema_classes.BatchSpecClass">BatchSpecClass</a></em><a href="#property-batchspec--none--batchspecclass" class="hash-link" aria-label="Direct link to property-batchspec--none--batchspecclass" title="Direct link to property-batchspec--none--batchspecclass"></a></h4><p>Specification of the batch which this run is evaluating</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-eventgranularity--none--timewindowsizeclass"><em>property</em> eventGranularity <em>: None | <a href="#datahub.metadata.schema_classes.TimeWindowSizeClass">TimeWindowSizeClass</a></em><a href="#property-eventgranularity--none--timewindowsizeclass" class="hash-link" aria-label="Direct link to property-eventgranularity--none--timewindowsizeclass" title="Direct link to property-eventgranularity--none--timewindowsizeclass"></a></h4><p>Granularity of the event if applicable</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-messageid--none--str"><em>property</em> messageId <em>: None | str</em><a href="#property-messageid--none--str" class="hash-link" aria-label="Direct link to property-messageid--none--str" title="Direct link to property-messageid--none--str"></a></h4><p>The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-partitionspec--partitionspecclass--none"><em>property</em> partitionSpec <em>: <a href="#datahub.metadata.schema_classes.PartitionSpecClass">PartitionSpecClass</a> | None</em><a href="#property-partitionspec--partitionspecclass--none" class="hash-link" aria-label="Direct link to property-partitionspec--partitionspecclass--none" title="Direct link to property-partitionspec--partitionspecclass--none"></a></h4><p>The optional partition specification.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-result--none--assertionresultclass"><em>property</em> result <em>: None | <a href="#datahub.metadata.schema_classes.AssertionResultClass">AssertionResultClass</a></em><a href="#property-result--none--assertionresultclass" class="hash-link" aria-label="Direct link to property-result--none--assertionresultclass" title="Direct link to property-result--none--assertionresultclass"></a></h4><p>Results of assertion, present if the status is COMPLETE</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-runid--str"><em>property</em> runId <em>: str</em><a href="#property-runid--str" class="hash-link" aria-label="Direct link to property-runid--str" title="Direct link to property-runid--str"></a></h4><p>Native (platform-specific) identifier for this run</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-runtimecontext--none--dictstr-str"><em>property</em> runtimeContext <em>: None | Dict<!-- -->[str, str]</em><a href="#property-runtimecontext--none--dictstr-str" class="hash-link" aria-label="Direct link to property-runtimecontext--none--dictstr-str" title="Direct link to property-runtimecontext--none--dictstr-str"></a></h4><p>Runtime parameters of evaluation</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-status--str--assertionrunstatusclass"><em>property</em> status <em>: str | <a href="#datahub.metadata.schema_classes.AssertionRunStatusClass">AssertionRunStatusClass</a></em><a href="#property-status--str--assertionrunstatusclass" class="hash-link" aria-label="Direct link to property-status--str--assertionrunstatusclass" title="Direct link to property-status--str--assertionrunstatusclass"></a></h4><p>The status of the assertion run as per this timeseries event.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-timestampmillis--int"><em>property</em> timestampMillis <em>: int</em><a href="#property-timestampmillis--int" class="hash-link" aria-label="Direct link to property-timestampmillis--int" title="Direct link to property-timestampmillis--int"></a></h4><p>The event timestamp field as epoch at UTC in milli seconds.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AssertionRunStatusClass"><span class="visually-hidden">AssertionRunStatusClass</span><a href="#datahub.metadata.schema_classes.AssertionRunStatusClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AssertionRunStatusClass" title="Direct link to datahub.metadata.schema_classes.AssertionRunStatusClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AssertionRunStatusClass</span>()<a href="#datahub.metadata.schema_classes.AssertionRunStatusClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>The lifecycle status of an assertion run.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="complete--complete">COMPLETE <em>= 'COMPLETE'</em><a href="#complete--complete" class="hash-link" aria-label="Direct link to complete--complete" title="Direct link to complete--complete"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AssertionSourceClass"><span class="visually-hidden">AssertionSourceClass</span><a href="#datahub.metadata.schema_classes.AssertionSourceClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AssertionSourceClass" title="Direct link to datahub.metadata.schema_classes.AssertionSourceClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AssertionSourceClass</span>(<span class="arg-name">type</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.AssertionSourceClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>The source of an assertion</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.AssertionSourceTypeClass"><code>AssertionSourceTypeClass</code></a>]) – </li><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--none--auditstampclass"><em>property</em> created <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--none--auditstampclass" class="hash-link" aria-label="Direct link to property-created--none--auditstampclass" title="Direct link to property-created--none--auditstampclass"></a></h4><p>The time at which the assertion was initially created and the author who created it.
|
||
This field is only present for Native assertions created after this field was introduced.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--assertionsourcetypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.AssertionSourceTypeClass">AssertionSourceTypeClass</a></em><a href="#property-type--str--assertionsourcetypeclass" class="hash-link" aria-label="Direct link to property-type--str--assertionsourcetypeclass" title="Direct link to property-type--str--assertionsourcetypeclass"></a></h4><p>The type of the Assertion Source</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AssertionSourceTypeClass"><span class="visually-hidden">AssertionSourceTypeClass</span><a href="#datahub.metadata.schema_classes.AssertionSourceTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AssertionSourceTypeClass" title="Direct link to datahub.metadata.schema_classes.AssertionSourceTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AssertionSourceTypeClass</span>()<a href="#datahub.metadata.schema_classes.AssertionSourceTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="external--external">EXTERNAL <em>= 'EXTERNAL'</em><a href="#external--external" class="hash-link" aria-label="Direct link to external--external" title="Direct link to external--external"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="inferred--inferred">INFERRED <em>= 'INFERRED'</em><a href="#inferred--inferred" class="hash-link" aria-label="Direct link to inferred--inferred" title="Direct link to inferred--inferred"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="native--native">NATIVE <em>= 'NATIVE'</em><a href="#native--native" class="hash-link" aria-label="Direct link to native--native" title="Direct link to native--native"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AssertionStdAggregationClass"><span class="visually-hidden">AssertionStdAggregationClass</span><a href="#datahub.metadata.schema_classes.AssertionStdAggregationClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AssertionStdAggregationClass" title="Direct link to datahub.metadata.schema_classes.AssertionStdAggregationClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AssertionStdAggregationClass</span>()<a href="#datahub.metadata.schema_classes.AssertionStdAggregationClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>The function that is applied to the aggregation input (schema, rows, column values) before evaluating an operator.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="columns--columns">COLUMNS <em>= 'COLUMNS'</em><a href="#columns--columns" class="hash-link" aria-label="Direct link to columns--columns" title="Direct link to columns--columns"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="column_count--column_count">COLUMN_COUNT <em>= 'COLUMN_COUNT'</em><a href="#column_count--column_count" class="hash-link" aria-label="Direct link to column_count--column_count" title="Direct link to column_count--column_count"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="identity--identity">IDENTITY <em>= 'IDENTITY'</em><a href="#identity--identity" class="hash-link" aria-label="Direct link to identity--identity" title="Direct link to identity--identity"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="max--max">MAX <em>= 'MAX'</em><a href="#max--max" class="hash-link" aria-label="Direct link to max--max" title="Direct link to max--max"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mean--mean">MEAN <em>= 'MEAN'</em><a href="#mean--mean" class="hash-link" aria-label="Direct link to mean--mean" title="Direct link to mean--mean"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="median--median">MEDIAN <em>= 'MEDIAN'</em><a href="#median--median" class="hash-link" aria-label="Direct link to median--median" title="Direct link to median--median"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="min--min">MIN <em>= 'MIN'</em><a href="#min--min" class="hash-link" aria-label="Direct link to min--min" title="Direct link to min--min"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="null_count--null_count">NULL_COUNT <em>= 'NULL_COUNT'</em><a href="#null_count--null_count" class="hash-link" aria-label="Direct link to null_count--null_count" title="Direct link to null_count--null_count"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="null_proportion--null_proportion">NULL_PROPORTION <em>= 'NULL_PROPORTION'</em><a href="#null_proportion--null_proportion" class="hash-link" aria-label="Direct link to null_proportion--null_proportion" title="Direct link to null_proportion--null_proportion"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="row_count--row_count">ROW_COUNT <em>= 'ROW_COUNT'</em><a href="#row_count--row_count" class="hash-link" aria-label="Direct link to row_count--row_count" title="Direct link to row_count--row_count"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="stddev--stddev">STDDEV <em>= 'STDDEV'</em><a href="#stddev--stddev" class="hash-link" aria-label="Direct link to stddev--stddev" title="Direct link to stddev--stddev"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sum--sum">SUM <em>= 'SUM'</em><a href="#sum--sum" class="hash-link" aria-label="Direct link to sum--sum" title="Direct link to sum--sum"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="unique_count--unique_count">UNIQUE_COUNT <em>= 'UNIQUE_COUNT'</em><a href="#unique_count--unique_count" class="hash-link" aria-label="Direct link to unique_count--unique_count" title="Direct link to unique_count--unique_count"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="unique_proportion--unique_proportion">UNIQUE_PROPORTION <em>= 'UNIQUE_PROPORTION'</em><a href="#unique_proportion--unique_proportion" class="hash-link" aria-label="Direct link to unique_proportion--unique_proportion" title="Direct link to unique_proportion--unique_proportion"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="unique_propotion--unique_propotion">UNIQUE_PROPOTION <em>= 'UNIQUE_PROPOTION'</em><a href="#unique_propotion--unique_propotion" class="hash-link" aria-label="Direct link to unique_propotion--unique_propotion" title="Direct link to unique_propotion--unique_propotion"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AssertionStdOperatorClass"><span class="visually-hidden">AssertionStdOperatorClass</span><a href="#datahub.metadata.schema_classes.AssertionStdOperatorClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AssertionStdOperatorClass" title="Direct link to datahub.metadata.schema_classes.AssertionStdOperatorClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AssertionStdOperatorClass</span>()<a href="#datahub.metadata.schema_classes.AssertionStdOperatorClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>A boolean operator that is applied on the input to an assertion, after an aggregation function has been applied.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="between--between">BETWEEN <em>= 'BETWEEN'</em><a href="#between--between" class="hash-link" aria-label="Direct link to between--between" title="Direct link to between--between"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="contain--contain">CONTAIN <em>= 'CONTAIN'</em><a href="#contain--contain" class="hash-link" aria-label="Direct link to contain--contain" title="Direct link to contain--contain"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="end_with--end_with">END_WITH <em>= 'END_WITH'</em><a href="#end_with--end_with" class="hash-link" aria-label="Direct link to end_with--end_with" title="Direct link to end_with--end_with"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="equal_to--equal_to">EQUAL_TO <em>= 'EQUAL_TO'</em><a href="#equal_to--equal_to" class="hash-link" aria-label="Direct link to equal_to--equal_to" title="Direct link to equal_to--equal_to"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="greater_than--greater_than">GREATER_THAN <em>= 'GREATER_THAN'</em><a href="#greater_than--greater_than" class="hash-link" aria-label="Direct link to greater_than--greater_than" title="Direct link to greater_than--greater_than"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="greater_than_or_equal_to--greater_than_or_equal_to">GREATER_THAN_OR_EQUAL_TO <em>= 'GREATER_THAN_OR_EQUAL_TO'</em><a href="#greater_than_or_equal_to--greater_than_or_equal_to" class="hash-link" aria-label="Direct link to greater_than_or_equal_to--greater_than_or_equal_to" title="Direct link to greater_than_or_equal_to--greater_than_or_equal_to"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="in--in">IN <em>= 'IN'</em><a href="#in--in" class="hash-link" aria-label="Direct link to in--in" title="Direct link to in--in"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="is_false--is_false">IS_FALSE <em>= 'IS_FALSE'</em><a href="#is_false--is_false" class="hash-link" aria-label="Direct link to is_false--is_false" title="Direct link to is_false--is_false"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="is_true--is_true">IS_TRUE <em>= 'IS_TRUE'</em><a href="#is_true--is_true" class="hash-link" aria-label="Direct link to is_true--is_true" title="Direct link to is_true--is_true"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="less_than--less_than">LESS_THAN <em>= 'LESS_THAN'</em><a href="#less_than--less_than" class="hash-link" aria-label="Direct link to less_than--less_than" title="Direct link to less_than--less_than"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="less_than_or_equal_to--less_than_or_equal_to">LESS_THAN_OR_EQUAL_TO <em>= 'LESS_THAN_OR_EQUAL_TO'</em><a href="#less_than_or_equal_to--less_than_or_equal_to" class="hash-link" aria-label="Direct link to less_than_or_equal_to--less_than_or_equal_to" title="Direct link to less_than_or_equal_to--less_than_or_equal_to"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="not_equal_to--not_equal_to">NOT_EQUAL_TO <em>= 'NOT_EQUAL_TO'</em><a href="#not_equal_to--not_equal_to" class="hash-link" aria-label="Direct link to not_equal_to--not_equal_to" title="Direct link to not_equal_to--not_equal_to"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="not_in--not_in">NOT_IN <em>= 'NOT_IN'</em><a href="#not_in--not_in" class="hash-link" aria-label="Direct link to not_in--not_in" title="Direct link to not_in--not_in"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="not_null--not_null">NOT_NULL <em>= 'NOT_NULL'</em><a href="#not_null--not_null" class="hash-link" aria-label="Direct link to not_null--not_null" title="Direct link to not_null--not_null"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="null--null">NULL <em>= 'NULL'</em><a href="#null--null" class="hash-link" aria-label="Direct link to null--null" title="Direct link to null--null"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="regex_match--regex_match">REGEX_MATCH <em>= 'REGEX_MATCH'</em><a href="#regex_match--regex_match" class="hash-link" aria-label="Direct link to regex_match--regex_match" title="Direct link to regex_match--regex_match"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="start_with--start_with">START_WITH <em>= 'START_WITH'</em><a href="#start_with--start_with" class="hash-link" aria-label="Direct link to start_with--start_with" title="Direct link to start_with--start_with"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AssertionStdParameterClass"><span class="visually-hidden">AssertionStdParameterClass</span><a href="#datahub.metadata.schema_classes.AssertionStdParameterClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AssertionStdParameterClass" title="Direct link to datahub.metadata.schema_classes.AssertionStdParameterClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AssertionStdParameterClass</span>(<span class="arg-name">value</span>, <span class="arg-name">type</span>)<a href="#datahub.metadata.schema_classes.AssertionStdParameterClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Single parameter for AssertionStdOperators.</p><ul><li><strong>Parameters:</strong><ul><li><strong>value</strong> (<code>str</code>)</li><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.AssertionStdParameterTypeClass"><code>AssertionStdParameterTypeClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--assertionstdparametertypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.AssertionStdParameterTypeClass">AssertionStdParameterTypeClass</a></em><a href="#property-type--str--assertionstdparametertypeclass" class="hash-link" aria-label="Direct link to property-type--str--assertionstdparametertypeclass" title="Direct link to property-type--str--assertionstdparametertypeclass"></a></h4><p>The type of the parameter</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-value--str"><em>property</em> value <em>: str</em><a href="#property-value--str" class="hash-link" aria-label="Direct link to property-value--str" title="Direct link to property-value--str"></a></h4><p>The parameter value</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AssertionStdParameterTypeClass"><span class="visually-hidden">AssertionStdParameterTypeClass</span><a href="#datahub.metadata.schema_classes.AssertionStdParameterTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AssertionStdParameterTypeClass" title="Direct link to datahub.metadata.schema_classes.AssertionStdParameterTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AssertionStdParameterTypeClass</span>()<a href="#datahub.metadata.schema_classes.AssertionStdParameterTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="list--list">LIST <em>= 'LIST'</em><a href="#list--list" class="hash-link" aria-label="Direct link to list--list" title="Direct link to list--list"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="number--number">NUMBER <em>= 'NUMBER'</em><a href="#number--number" class="hash-link" aria-label="Direct link to number--number" title="Direct link to number--number"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set--set">SET <em>= 'SET'</em><a href="#set--set" class="hash-link" aria-label="Direct link to set--set" title="Direct link to set--set"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="string--string">STRING <em>= 'STRING'</em><a href="#string--string" class="hash-link" aria-label="Direct link to string--string" title="Direct link to string--string"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="unknown--unknown">UNKNOWN <em>= 'UNKNOWN'</em><a href="#unknown--unknown" class="hash-link" aria-label="Direct link to unknown--unknown" title="Direct link to unknown--unknown"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AssertionStdParametersClass"><span class="visually-hidden">AssertionStdParametersClass</span><a href="#datahub.metadata.schema_classes.AssertionStdParametersClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AssertionStdParametersClass" title="Direct link to datahub.metadata.schema_classes.AssertionStdParametersClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AssertionStdParametersClass</span>(<span class="arg-name">value</span> = <span class="arg-default">None</span>, <span class="arg-name">maxValue</span> = <span class="arg-default">None</span>, <span class="arg-name">minValue</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.AssertionStdParametersClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Parameters for AssertionStdOperators.</p><ul><li><strong>Parameters:</strong><ul><li><strong>value</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AssertionStdParameterClass"><code>AssertionStdParameterClass</code></a>]) – </li><li><strong>maxValue</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AssertionStdParameterClass"><code>AssertionStdParameterClass</code></a>]) – </li><li><strong>minValue</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AssertionStdParameterClass"><code>AssertionStdParameterClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-maxvalue--none--assertionstdparameterclass"><em>property</em> maxValue <em>: None | <a href="#datahub.metadata.schema_classes.AssertionStdParameterClass">AssertionStdParameterClass</a></em><a href="#property-maxvalue--none--assertionstdparameterclass" class="hash-link" aria-label="Direct link to property-maxvalue--none--assertionstdparameterclass" title="Direct link to property-maxvalue--none--assertionstdparameterclass"></a></h4><p>The maxValue parameter of an assertion</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-minvalue--none--assertionstdparameterclass"><em>property</em> minValue <em>: None | <a href="#datahub.metadata.schema_classes.AssertionStdParameterClass">AssertionStdParameterClass</a></em><a href="#property-minvalue--none--assertionstdparameterclass" class="hash-link" aria-label="Direct link to property-minvalue--none--assertionstdparameterclass" title="Direct link to property-minvalue--none--assertionstdparameterclass"></a></h4><p>The minValue parameter of an assertion</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-value--none--assertionstdparameterclass"><em>property</em> value <em>: None | <a href="#datahub.metadata.schema_classes.AssertionStdParameterClass">AssertionStdParameterClass</a></em><a href="#property-value--none--assertionstdparameterclass" class="hash-link" aria-label="Direct link to property-value--none--assertionstdparameterclass" title="Direct link to property-value--none--assertionstdparameterclass"></a></h4><p>The value parameter of an assertion</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AssertionTypeClass"><span class="visually-hidden">AssertionTypeClass</span><a href="#datahub.metadata.schema_classes.AssertionTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AssertionTypeClass" title="Direct link to datahub.metadata.schema_classes.AssertionTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AssertionTypeClass</span>()<a href="#datahub.metadata.schema_classes.AssertionTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="custom--custom">CUSTOM <em>= 'CUSTOM'</em><a href="#custom--custom" class="hash-link" aria-label="Direct link to custom--custom" title="Direct link to custom--custom"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataset--dataset">DATASET <em>= 'DATASET'</em><a href="#dataset--dataset" class="hash-link" aria-label="Direct link to dataset--dataset" title="Direct link to dataset--dataset"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="data_schema--data_schema">DATA_SCHEMA <em>= 'DATA_SCHEMA'</em><a href="#data_schema--data_schema" class="hash-link" aria-label="Direct link to data_schema--data_schema" title="Direct link to data_schema--data_schema"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="field--field">FIELD <em>= 'FIELD'</em><a href="#field--field" class="hash-link" aria-label="Direct link to field--field" title="Direct link to field--field"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="freshness--freshness">FRESHNESS <em>= 'FRESHNESS'</em><a href="#freshness--freshness" class="hash-link" aria-label="Direct link to freshness--freshness" title="Direct link to freshness--freshness"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sql--sql">SQL <em>= 'SQL'</em><a href="#sql--sql" class="hash-link" aria-label="Direct link to sql--sql" title="Direct link to sql--sql"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="volume--volume">VOLUME <em>= 'VOLUME'</em><a href="#volume--volume" class="hash-link" aria-label="Direct link to volume--volume" title="Direct link to volume--volume"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AssertionValueChangeTypeClass"><span class="visually-hidden">AssertionValueChangeTypeClass</span><a href="#datahub.metadata.schema_classes.AssertionValueChangeTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AssertionValueChangeTypeClass" title="Direct link to datahub.metadata.schema_classes.AssertionValueChangeTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AssertionValueChangeTypeClass</span>()<a href="#datahub.metadata.schema_classes.AssertionValueChangeTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>An enum to represent a type of change in an assertion value, metric, or measurement.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="absolute--absolute">ABSOLUTE <em>= 'ABSOLUTE'</em><a href="#absolute--absolute" class="hash-link" aria-label="Direct link to absolute--absolute" title="Direct link to absolute--absolute"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="percentage--percentage">PERCENTAGE <em>= 'PERCENTAGE'</em><a href="#percentage--percentage" class="hash-link" aria-label="Direct link to percentage--percentage" title="Direct link to percentage--percentage"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AuditStampClass"><span class="visually-hidden">AuditStampClass</span><a href="#datahub.metadata.schema_classes.AuditStampClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AuditStampClass" title="Direct link to datahub.metadata.schema_classes.AuditStampClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AuditStampClass</span>(<span class="arg-name">time</span>, <span class="arg-name">actor</span>, <span class="arg-name">impersonator</span> = <span class="arg-default">None</span>, <span class="arg-name">message</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.AuditStampClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Data captured on a resource/association/sub-resource level giving insight into when that resource/association/sub-resource moved into a particular lifecycle stage, and who acted to move it into that specific lifecycle stage.</p><ul><li><strong>Parameters:</strong><ul><li><strong>time</strong> (<code>int</code>)</li><li><strong>actor</strong> (<code>str</code>)</li><li><strong>impersonator</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>message</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-actor--str"><em>property</em> actor <em>: str</em><a href="#property-actor--str" class="hash-link" aria-label="Direct link to property-actor--str" title="Direct link to property-actor--str"></a></h4><p>The entity (e.g. a member URN) which will be credited for moving the resource/association/sub-resource into the specific lifecycle stage. It is also the one used to authorize the change.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-impersonator--none--str"><em>property</em> impersonator <em>: None | str</em><a href="#property-impersonator--none--str" class="hash-link" aria-label="Direct link to property-impersonator--none--str" title="Direct link to property-impersonator--none--str"></a></h4><p>The entity (e.g. a service URN) which performs the change on behalf of the Actor and must be authorized to act as the Actor.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-message--none--str"><em>property</em> message <em>: None | str</em><a href="#property-message--none--str" class="hash-link" aria-label="Direct link to property-message--none--str" title="Direct link to property-message--none--str"></a></h4><p>was the change created by an automated process, or manually.</p><ul><li><strong>Type:</strong>
|
||
Additional context around how DataHub was informed of the particular change. For example</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-time--int"><em>property</em> time <em>: int</em><a href="#property-time--int" class="hash-link" aria-label="Direct link to property-time--int" title="Direct link to property-time--int"></a></h4><p>When did the resource/association/sub-resource move into the specific lifecycle stage represented by this AuditEvent.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.AzkabanJobTypeClass"><span class="visually-hidden">AzkabanJobTypeClass</span><a href="#datahub.metadata.schema_classes.AzkabanJobTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.AzkabanJobTypeClass" title="Direct link to datahub.metadata.schema_classes.AzkabanJobTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">AzkabanJobTypeClass</span>()<a href="#datahub.metadata.schema_classes.AzkabanJobTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>The various types of support azkaban jobs</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="command--command">COMMAND <em>= 'COMMAND'</em><a href="#command--command" class="hash-link" aria-label="Direct link to command--command" title="Direct link to command--command"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="glue--glue">GLUE <em>= 'GLUE'</em><a href="#glue--glue" class="hash-link" aria-label="Direct link to glue--glue" title="Direct link to glue--glue"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="hadoop_java--hadoop_java">HADOOP_JAVA <em>= 'HADOOP_JAVA'</em><a href="#hadoop_java--hadoop_java" class="hash-link" aria-label="Direct link to hadoop_java--hadoop_java" title="Direct link to hadoop_java--hadoop_java"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="hadoop_shell--hadoop_shell">HADOOP_SHELL <em>= 'HADOOP_SHELL'</em><a href="#hadoop_shell--hadoop_shell" class="hash-link" aria-label="Direct link to hadoop_shell--hadoop_shell" title="Direct link to hadoop_shell--hadoop_shell"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="hive--hive">HIVE <em>= 'HIVE'</em><a href="#hive--hive" class="hash-link" aria-label="Direct link to hive--hive" title="Direct link to hive--hive"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="pig--pig">PIG <em>= 'PIG'</em><a href="#pig--pig" class="hash-link" aria-label="Direct link to pig--pig" title="Direct link to pig--pig"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sql--sql-1">SQL <em>= 'SQL'</em><a href="#sql--sql-1" class="hash-link" aria-label="Direct link to sql--sql-1" title="Direct link to sql--sql-1"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.BaseDataClass"><span class="visually-hidden">BaseDataClass</span><a href="#datahub.metadata.schema_classes.BaseDataClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.BaseDataClass" title="Direct link to datahub.metadata.schema_classes.BaseDataClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">BaseDataClass</span>(<span class="arg-name">dataset</span>, <span class="arg-name">motivation</span> = <span class="arg-default">None</span>, <span class="arg-name">preProcessing</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.BaseDataClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>BaseData record</p><ul><li><strong>Parameters:</strong><ul><li><strong>dataset</strong> (<code>str</code>)</li><li><strong>motivation</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>preProcessing</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-dataset--str"><em>property</em> dataset <em>: str</em><a href="#property-dataset--str" class="hash-link" aria-label="Direct link to property-dataset--str" title="Direct link to property-dataset--str"></a></h4><p>What dataset were used in the MLModel?</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-motivation--none--str"><em>property</em> motivation <em>: None | str</em><a href="#property-motivation--none--str" class="hash-link" aria-label="Direct link to property-motivation--none--str" title="Direct link to property-motivation--none--str"></a></h4><p>Why was this dataset chosen?</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-preprocessing--none--liststr"><em>property</em> preProcessing <em>: None | List<!-- -->[str]</em><a href="#property-preprocessing--none--liststr" class="hash-link" aria-label="Direct link to property-preprocessing--none--liststr" title="Direct link to property-preprocessing--none--liststr"></a></h4><p>How was the data preprocessed (e.g., tokenization of sentences, cropping of images, any filtering such as dropping images without faces)?</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.BatchSpecClass"><span class="visually-hidden">BatchSpecClass</span><a href="#datahub.metadata.schema_classes.BatchSpecClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.BatchSpecClass" title="Direct link to datahub.metadata.schema_classes.BatchSpecClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">BatchSpecClass</span>(<span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">nativeBatchId</span> = <span class="arg-default">None</span>, <span class="arg-name">query</span> = <span class="arg-default">None</span>, <span class="arg-name">limit</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.BatchSpecClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A batch on which certain operations, e.g. data quality evaluation, is done.</p><ul><li><strong>Parameters:</strong><ul><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>nativeBatchId</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>query</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>limit</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-2"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-2" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-2" title="Direct link to property-customproperties--dictstr-str-2"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-limit--none--int"><em>property</em> limit <em>: None | int</em><a href="#property-limit--none--int" class="hash-link" aria-label="Direct link to property-limit--none--int" title="Direct link to property-limit--none--int"></a></h4><p>Any limit to the number of rows in the batch, if applied</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-nativebatchid--none--str"><em>property</em> nativeBatchId <em>: None | str</em><a href="#property-nativebatchid--none--str" class="hash-link" aria-label="Direct link to property-nativebatchid--none--str" title="Direct link to property-nativebatchid--none--str"></a></h4><p>The native identifier as specified by the system operating on the batch.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-query--none--str"><em>property</em> query <em>: None | str</em><a href="#property-query--none--str" class="hash-link" aria-label="Direct link to property-query--none--str" title="Direct link to property-query--none--str"></a></h4><p>A query that identifies a batch of data</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.BinaryJsonSchemaClass"><span class="visually-hidden">BinaryJsonSchemaClass</span><a href="#datahub.metadata.schema_classes.BinaryJsonSchemaClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.BinaryJsonSchemaClass" title="Direct link to datahub.metadata.schema_classes.BinaryJsonSchemaClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">BinaryJsonSchemaClass</span>(<span class="arg-name">schema</span>)<a href="#datahub.metadata.schema_classes.BinaryJsonSchemaClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Schema text of binary JSON schema.</p><ul><li><strong>Parameters:</strong><strong>schema</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-schema--str"><em>property</em> schema <em>: str</em><a href="#property-schema--str" class="hash-link" aria-label="Direct link to property-schema--str" title="Direct link to property-schema--str"></a></h4><p>The native schema text for binary JSON file format.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.BooleanTypeClass"><span class="visually-hidden">BooleanTypeClass</span><a href="#datahub.metadata.schema_classes.BooleanTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.BooleanTypeClass" title="Direct link to datahub.metadata.schema_classes.BooleanTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">BooleanTypeClass</span>()<a href="#datahub.metadata.schema_classes.BooleanTypeClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Boolean field type.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.BrowsePathEntryClass"><span class="visually-hidden">BrowsePathEntryClass</span><a href="#datahub.metadata.schema_classes.BrowsePathEntryClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.BrowsePathEntryClass" title="Direct link to datahub.metadata.schema_classes.BrowsePathEntryClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">BrowsePathEntryClass</span>(<span class="arg-name">id</span>, <span class="arg-name">urn</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.BrowsePathEntryClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Represents a single level in an entity’s browsePathV2</p><ul><li><strong>Parameters:</strong><ul><li><strong>id</strong> (<code>str</code>)</li><li><strong>urn</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-1"><em>property</em> id <em>: str</em><a href="#property-id--str-1" class="hash-link" aria-label="Direct link to property-id--str-1" title="Direct link to property-id--str-1"></a></h4><p>The ID of the browse path entry. This is what gets stored in the index.
|
||
If there’s an urn associated with this entry, id and urn will be the same</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--none--str"><em>property</em> urn <em>: None | str</em><a href="#property-urn--none--str" class="hash-link" aria-label="Direct link to property-urn--none--str" title="Direct link to property-urn--none--str"></a></h4><p>Optional urn pointing to some entity in DataHub</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.BrowsePathsClass"><span class="visually-hidden">BrowsePathsClass</span><a href="#datahub.metadata.schema_classes.BrowsePathsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.BrowsePathsClass" title="Direct link to datahub.metadata.schema_classes.BrowsePathsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">BrowsePathsClass</span>(<span class="arg-name">paths</span>)<a href="#datahub.metadata.schema_classes.BrowsePathsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Shared aspect containing Browse Paths to be indexed for an entity.</p><ul><li><strong>Parameters:</strong><strong>paths</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-paths--liststr"><em>property</em> paths <em>: List<!-- -->[str]</em><a href="#property-paths--liststr" class="hash-link" aria-label="Direct link to property-paths--liststr" title="Direct link to property-paths--liststr"></a></h4><p>A list of valid browse paths for the entity.</p><p>Browse paths are expected to be forward slash-separated strings. For example: ‘prod/snowflake/datasetName’</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.BrowsePathsV2Class"><span class="visually-hidden">BrowsePathsV2Class</span><a href="#datahub.metadata.schema_classes.BrowsePathsV2Class" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.BrowsePathsV2Class" title="Direct link to datahub.metadata.schema_classes.BrowsePathsV2Class"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">BrowsePathsV2Class</span>(<span class="arg-name">path</span>)<a href="#datahub.metadata.schema_classes.BrowsePathsV2Class" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Shared aspect containing a Browse Path to be indexed for an entity.</p><ul><li><strong>Parameters:</strong><strong>path</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.BrowsePathEntryClass"><code>BrowsePathEntryClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-path--listbrowsepathentryclass"><em>property</em> path <em>: List[<a href="#datahub.metadata.schema_classes.BrowsePathEntryClass">BrowsePathEntryClass</a>]</em><a href="#property-path--listbrowsepathentryclass" class="hash-link" aria-label="Direct link to property-path--listbrowsepathentryclass" title="Direct link to property-path--listbrowsepathentryclass"></a></h4><p>A valid browse path for the entity. This field is provided by DataHub by default.
|
||
This aspect is a newer version of browsePaths where we can encode more information in the path.
|
||
This path is also based on containers for a given entity if it has containers.</p><p>This is stored in elasticsearch as unit-separator delimited strings and only includes platform specific folders or containers.
|
||
These paths should not include high level info captured elsewhere ie. Platform and Environment.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.BusinessAttributeAssociationClass"><span class="visually-hidden">BusinessAttributeAssociationClass</span><a href="#datahub.metadata.schema_classes.BusinessAttributeAssociationClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.BusinessAttributeAssociationClass" title="Direct link to datahub.metadata.schema_classes.BusinessAttributeAssociationClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">BusinessAttributeAssociationClass</span>(<span class="arg-name">businessAttributeUrn</span>)<a href="#datahub.metadata.schema_classes.BusinessAttributeAssociationClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><strong>businessAttributeUrn</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-businessattributeurn--str"><em>property</em> businessAttributeUrn <em>: str</em><a href="#property-businessattributeurn--str" class="hash-link" aria-label="Direct link to property-businessattributeurn--str" title="Direct link to property-businessattributeurn--str"></a></h4><p>Urn of the applied businessAttribute</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.BusinessAttributeInfoClass"><span class="visually-hidden">BusinessAttributeInfoClass</span><a href="#datahub.metadata.schema_classes.BusinessAttributeInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.BusinessAttributeInfoClass" title="Direct link to datahub.metadata.schema_classes.BusinessAttributeInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">BusinessAttributeInfoClass</span>(<span class="arg-name">fieldPath</span>, <span class="arg-name">name</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">globalTags</span> = <span class="arg-default">None</span>, <span class="arg-name">glossaryTerms</span> = <span class="arg-default">None</span>, <span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>, <span class="arg-name">deleted</span> = <span class="arg-default">None</span>, <span class="arg-name">type</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.BusinessAttributeInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties associated with a BusinessAttribute</p><ul><li><strong>Parameters:</strong><ul><li><strong>fieldPath</strong> (<code>str</code>)</li><li><strong>name</strong> (<code>str</code>)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>globalTags</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.GlobalTagsClass"><code>GlobalTagsClass</code></a>]) – </li><li><strong>glossaryTerms</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.GlossaryTermsClass"><code>GlossaryTermsClass</code></a>]) – </li><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>deleted</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>type</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.SchemaFieldDataTypeClass"><code>SchemaFieldDataTypeClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--auditstampclass"><em>property</em> created <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--auditstampclass" class="hash-link" aria-label="Direct link to property-created--auditstampclass" title="Direct link to property-created--auditstampclass"></a></h4><p>An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-3"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-3" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-3" title="Direct link to property-customproperties--dictstr-str-3"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-deleted--none--auditstampclass"><em>property</em> deleted <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-deleted--none--auditstampclass" class="hash-link" aria-label="Direct link to property-deleted--none--auditstampclass" title="Direct link to property-deleted--none--auditstampclass"></a></h4><p>An AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-2"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-2" class="hash-link" aria-label="Direct link to property-description--none--str-2" title="Direct link to property-description--none--str-2"></a></h4><p>Description</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fieldpath--str"><em>property</em> fieldPath <em>: str</em><a href="#property-fieldpath--str" class="hash-link" aria-label="Direct link to property-fieldpath--str" title="Direct link to property-fieldpath--str"></a></h4><p>FieldPath uniquely identifying the SchemaField this metadata is associated with</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-globaltags--none--globaltagsclass"><em>property</em> globalTags <em>: None | <a href="#datahub.metadata.schema_classes.GlobalTagsClass">GlobalTagsClass</a></em><a href="#property-globaltags--none--globaltagsclass" class="hash-link" aria-label="Direct link to property-globaltags--none--globaltagsclass" title="Direct link to property-globaltags--none--globaltagsclass"></a></h4><p>Tags associated with the field</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-glossaryterms--none--glossarytermsclass"><em>property</em> glossaryTerms <em>: None | <a href="#datahub.metadata.schema_classes.GlossaryTermsClass">GlossaryTermsClass</a></em><a href="#property-glossaryterms--none--glossarytermsclass" class="hash-link" aria-label="Direct link to property-glossaryterms--none--glossarytermsclass" title="Direct link to property-glossaryterms--none--glossarytermsclass"></a></h4><p>Glossary terms associated with the field</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--auditstampclass"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--auditstampclass" class="hash-link" aria-label="Direct link to property-lastmodified--auditstampclass" title="Direct link to property-lastmodified--auditstampclass"></a></h4><p>An AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str"><em>property</em> name <em>: str</em><a href="#property-name--str" class="hash-link" aria-label="Direct link to property-name--str" title="Direct link to property-name--str"></a></h4><p>Display name of the BusinessAttribute</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--none--schemafielddatatypeclass"><em>property</em> type <em>: None | <a href="#datahub.metadata.schema_classes.SchemaFieldDataTypeClass">SchemaFieldDataTypeClass</a></em><a href="#property-type--none--schemafielddatatypeclass" class="hash-link" aria-label="Direct link to property-type--none--schemafielddatatypeclass" title="Direct link to property-type--none--schemafielddatatypeclass"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.BusinessAttributeKeyClass"><span class="visually-hidden">BusinessAttributeKeyClass</span><a href="#datahub.metadata.schema_classes.BusinessAttributeKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.BusinessAttributeKeyClass" title="Direct link to datahub.metadata.schema_classes.BusinessAttributeKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">BusinessAttributeKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.BusinessAttributeKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Query</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-2"><em>property</em> id <em>: str</em><a href="#property-id--str-2" class="hash-link" aria-label="Direct link to property-id--str-2" title="Direct link to property-id--str-2"></a></h4><p>A unique id for the Business Attribute.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.BusinessAttributesClass"><span class="visually-hidden">BusinessAttributesClass</span><a href="#datahub.metadata.schema_classes.BusinessAttributesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.BusinessAttributesClass" title="Direct link to datahub.metadata.schema_classes.BusinessAttributesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">BusinessAttributesClass</span>(<span class="arg-name">businessAttribute</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.BusinessAttributesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>BusinessAttribute aspect used for applying it to an entity</p><ul><li><strong>Parameters:</strong><strong>businessAttribute</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.BusinessAttributeAssociationClass"><code>BusinessAttributeAssociationClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-businessattribute--none--businessattributeassociationclass"><em>property</em> businessAttribute <em>: None | <a href="#datahub.metadata.schema_classes.BusinessAttributeAssociationClass">BusinessAttributeAssociationClass</a></em><a href="#property-businessattribute--none--businessattributeassociationclass" class="hash-link" aria-label="Direct link to property-businessattribute--none--businessattributeassociationclass" title="Direct link to property-businessattribute--none--businessattributeassociationclass"></a></h4><p>Business Attribute for this field.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.BytesTypeClass"><span class="visually-hidden">BytesTypeClass</span><a href="#datahub.metadata.schema_classes.BytesTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.BytesTypeClass" title="Direct link to datahub.metadata.schema_classes.BytesTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">BytesTypeClass</span>()<a href="#datahub.metadata.schema_classes.BytesTypeClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Bytes field type.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CalendarIntervalClass"><span class="visually-hidden">CalendarIntervalClass</span><a href="#datahub.metadata.schema_classes.CalendarIntervalClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CalendarIntervalClass" title="Direct link to datahub.metadata.schema_classes.CalendarIntervalClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CalendarIntervalClass</span>()<a href="#datahub.metadata.schema_classes.CalendarIntervalClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="day--day">DAY <em>= 'DAY'</em><a href="#day--day" class="hash-link" aria-label="Direct link to day--day" title="Direct link to day--day"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="hour--hour">HOUR <em>= 'HOUR'</em><a href="#hour--hour" class="hash-link" aria-label="Direct link to hour--hour" title="Direct link to hour--hour"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="minute--minute">MINUTE <em>= 'MINUTE'</em><a href="#minute--minute" class="hash-link" aria-label="Direct link to minute--minute" title="Direct link to minute--minute"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="month--month">MONTH <em>= 'MONTH'</em><a href="#month--month" class="hash-link" aria-label="Direct link to month--month" title="Direct link to month--month"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="quarter--quarter">QUARTER <em>= 'QUARTER'</em><a href="#quarter--quarter" class="hash-link" aria-label="Direct link to quarter--quarter" title="Direct link to quarter--quarter"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="second--second">SECOND <em>= 'SECOND'</em><a href="#second--second" class="hash-link" aria-label="Direct link to second--second" title="Direct link to second--second"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="week--week">WEEK <em>= 'WEEK'</em><a href="#week--week" class="hash-link" aria-label="Direct link to week--week" title="Direct link to week--week"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="year--year">YEAR <em>= 'YEAR'</em><a href="#year--year" class="hash-link" aria-label="Direct link to year--year" title="Direct link to year--year"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CaveatDetailsClass"><span class="visually-hidden">CaveatDetailsClass</span><a href="#datahub.metadata.schema_classes.CaveatDetailsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CaveatDetailsClass" title="Direct link to datahub.metadata.schema_classes.CaveatDetailsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CaveatDetailsClass</span>(<span class="arg-name">needsFurtherTesting</span> = <span class="arg-default">None</span>, <span class="arg-name">caveatDescription</span> = <span class="arg-default">None</span>, <span class="arg-name">groupsNotRepresented</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.CaveatDetailsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>This section should list additional concerns that were not covered in the previous sections. For example, did the results suggest any further testing? Were there any relevant groups that were not represented in the evaluation dataset? Are there additional recommendations for model use?</p><ul><li><strong>Parameters:</strong><ul><li><strong>needsFurtherTesting</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>caveatDescription</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>groupsNotRepresented</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-caveatdescription--none--str"><em>property</em> caveatDescription <em>: None | str</em><a href="#property-caveatdescription--none--str" class="hash-link" aria-label="Direct link to property-caveatdescription--none--str" title="Direct link to property-caveatdescription--none--str"></a></h4><p>Caveat Description
|
||
For ex: Given gender classes are binary (male/not male), which we include as male/female. Further work needed to evaluate across a spectrum of genders.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-groupsnotrepresented--none--liststr"><em>property</em> groupsNotRepresented <em>: None | List<!-- -->[str]</em><a href="#property-groupsnotrepresented--none--liststr" class="hash-link" aria-label="Direct link to property-groupsnotrepresented--none--liststr" title="Direct link to property-groupsnotrepresented--none--liststr"></a></h4><p>Relevant groups that were not represented in the evaluation dataset?</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-needsfurthertesting--none--bool"><em>property</em> needsFurtherTesting <em>: None | bool</em><a href="#property-needsfurthertesting--none--bool" class="hash-link" aria-label="Direct link to property-needsfurthertesting--none--bool" title="Direct link to property-needsfurthertesting--none--bool"></a></h4><p>Did the results suggest any further testing?</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CaveatsAndRecommendationsClass"><span class="visually-hidden">CaveatsAndRecommendationsClass</span><a href="#datahub.metadata.schema_classes.CaveatsAndRecommendationsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CaveatsAndRecommendationsClass" title="Direct link to datahub.metadata.schema_classes.CaveatsAndRecommendationsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CaveatsAndRecommendationsClass</span>(<span class="arg-name">caveats</span> = <span class="arg-default">None</span>, <span class="arg-name">recommendations</span> = <span class="arg-default">None</span>, <span class="arg-name">idealDatasetCharacteristics</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.CaveatsAndRecommendationsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>This section should list additional concerns that were not covered in the previous sections. For example, did the results suggest any further testing? Were there any relevant groups that were not represented in the evaluation dataset? Are there additional recommendations for model use?</p><ul><li><strong>Parameters:</strong><ul><li><strong>caveats</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.CaveatDetailsClass"><code>CaveatDetailsClass</code></a>]) – </li><li><strong>recommendations</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>idealDatasetCharacteristics</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-caveats--none--caveatdetailsclass"><em>property</em> caveats <em>: None | <a href="#datahub.metadata.schema_classes.CaveatDetailsClass">CaveatDetailsClass</a></em><a href="#property-caveats--none--caveatdetailsclass" class="hash-link" aria-label="Direct link to property-caveats--none--caveatdetailsclass" title="Direct link to property-caveats--none--caveatdetailsclass"></a></h4><p>This section should list additional concerns that were not covered in the previous sections. For example, did the results suggest any further testing? Were there any relevant groups that were not represented in the evaluation dataset?</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-idealdatasetcharacteristics--none--liststr"><em>property</em> idealDatasetCharacteristics <em>: None | List<!-- -->[str]</em><a href="#property-idealdatasetcharacteristics--none--liststr" class="hash-link" aria-label="Direct link to property-idealdatasetcharacteristics--none--liststr" title="Direct link to property-idealdatasetcharacteristics--none--liststr"></a></h4><p>Ideal characteristics of an evaluation dataset for this MLModel</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-recommendations--none--str"><em>property</em> recommendations <em>: None | str</em><a href="#property-recommendations--none--str" class="hash-link" aria-label="Direct link to property-recommendations--none--str" title="Direct link to property-recommendations--none--str"></a></h4><p>Recommendations on where this MLModel should be used.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ChangeAuditStampsClass"><span class="visually-hidden">ChangeAuditStampsClass</span><a href="#datahub.metadata.schema_classes.ChangeAuditStampsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ChangeAuditStampsClass" title="Direct link to datahub.metadata.schema_classes.ChangeAuditStampsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ChangeAuditStampsClass</span>(<span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>, <span class="arg-name">deleted</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.ChangeAuditStampsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Data captured on a resource/association/sub-resource level giving insight into when that resource/association/sub-resource moved into various lifecycle stages, and who acted to move it into those lifecycle stages. The recommended best practice is to include this record in your record schema, and annotate its fields as @readOnly in your resource. See <a href="https://github.com/linkedin/rest.li/wiki/Validation-in-Rest.li#restli-validation-annotations" target="_blank" rel="noopener noreferrer">https://github.com/linkedin/rest.li/wiki/Validation-in-Rest.li#restli-validation-annotations</a></p><ul><li><strong>Parameters:</strong><ul><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>deleted</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--auditstampclass-1"><em>property</em> created <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--auditstampclass-1" class="hash-link" aria-label="Direct link to property-created--auditstampclass-1" title="Direct link to property-created--auditstampclass-1"></a></h4><p>An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-deleted--none--auditstampclass-1"><em>property</em> deleted <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-deleted--none--auditstampclass-1" class="hash-link" aria-label="Direct link to property-deleted--none--auditstampclass-1" title="Direct link to property-deleted--none--auditstampclass-1"></a></h4><p>An AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--auditstampclass-1"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--auditstampclass-1" class="hash-link" aria-label="Direct link to property-lastmodified--auditstampclass-1" title="Direct link to property-lastmodified--auditstampclass-1"></a></h4><p>An AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ChangeTypeClass"><span class="visually-hidden">ChangeTypeClass</span><a href="#datahub.metadata.schema_classes.ChangeTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ChangeTypeClass" title="Direct link to datahub.metadata.schema_classes.ChangeTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ChangeTypeClass</span>()<a href="#datahub.metadata.schema_classes.ChangeTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>Descriptor for a change action</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="create--create">CREATE <em>= 'CREATE'</em><a href="#create--create" class="hash-link" aria-label="Direct link to create--create" title="Direct link to create--create"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="create_entity--create_entity">CREATE_ENTITY <em>= 'CREATE_ENTITY'</em><a href="#create_entity--create_entity" class="hash-link" aria-label="Direct link to create_entity--create_entity" title="Direct link to create_entity--create_entity"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="delete--delete">DELETE <em>= 'DELETE'</em><a href="#delete--delete" class="hash-link" aria-label="Direct link to delete--delete" title="Direct link to delete--delete"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="patch--patch">PATCH <em>= 'PATCH'</em><a href="#patch--patch" class="hash-link" aria-label="Direct link to patch--patch" title="Direct link to patch--patch"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="restate--restate">RESTATE <em>= 'RESTATE'</em><a href="#restate--restate" class="hash-link" aria-label="Direct link to restate--restate" title="Direct link to restate--restate"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="update--update">UPDATE <em>= 'UPDATE'</em><a href="#update--update" class="hash-link" aria-label="Direct link to update--update" title="Direct link to update--update"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="upsert--upsert">UPSERT <em>= 'UPSERT'</em><a href="#upsert--upsert" class="hash-link" aria-label="Direct link to upsert--upsert" title="Direct link to upsert--upsert"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ChartCellClass"><span class="visually-hidden">ChartCellClass</span><a href="#datahub.metadata.schema_classes.ChartCellClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ChartCellClass" title="Direct link to datahub.metadata.schema_classes.ChartCellClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ChartCellClass</span>(<span class="arg-name">cellId</span>, <span class="arg-name">changeAuditStamps</span>, <span class="arg-name">cellTitle</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.ChartCellClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Chart cell in a notebook, which will present content in chart format</p><ul><li><strong>Parameters:</strong><ul><li><strong>cellId</strong> (<code>str</code>)</li><li><strong>changeAuditStamps</strong> (<a href="#datahub.metadata.schema_classes.ChangeAuditStampsClass"><code>ChangeAuditStampsClass</code></a>) – </li><li><strong>cellTitle</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-cellid--str"><em>property</em> cellId <em>: str</em><a href="#property-cellid--str" class="hash-link" aria-label="Direct link to property-cellid--str" title="Direct link to property-cellid--str"></a></h4><p>Unique id for the cell. This id should be globally unique for a Notebook tool even when there are multiple deployments of it. As an example, Notebook URL could be used here for QueryBook such as ‘querybook.com/notebook/773/?cellId=1234’</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-celltitle--none--str"><em>property</em> cellTitle <em>: None | str</em><a href="#property-celltitle--none--str" class="hash-link" aria-label="Direct link to property-celltitle--none--str" title="Direct link to property-celltitle--none--str"></a></h4><p>Title of the cell</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-changeauditstamps--changeauditstampsclass"><em>property</em> changeAuditStamps <em>: <a href="#datahub.metadata.schema_classes.ChangeAuditStampsClass">ChangeAuditStampsClass</a></em><a href="#property-changeauditstamps--changeauditstampsclass" class="hash-link" aria-label="Direct link to property-changeauditstamps--changeauditstampsclass" title="Direct link to property-changeauditstamps--changeauditstampsclass"></a></h4><p>Captures information about who created/last modified/deleted this Notebook cell and when</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ChartInfoClass"><span class="visually-hidden">ChartInfoClass</span><a href="#datahub.metadata.schema_classes.ChartInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ChartInfoClass" title="Direct link to datahub.metadata.schema_classes.ChartInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ChartInfoClass</span>(<span class="arg-name">title</span>, <span class="arg-name">description</span>, <span class="arg-name">lastModified</span>, <span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">externalUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">chartUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">inputs</span> = <span class="arg-default">None</span>, <span class="arg-name">inputEdges</span> = <span class="arg-default">None</span>, <span class="arg-name">type</span> = <span class="arg-default">None</span>, <span class="arg-name">access</span> = <span class="arg-default">None</span>, <span class="arg-name">lastRefreshed</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.ChartInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a chart</p><ul><li><strong>Parameters:</strong><ul><li><strong>title</strong> (<code>str</code>)</li><li><strong>description</strong> (<code>str</code>)</li><li><strong>lastModified</strong> (<a href="#datahub.metadata.schema_classes.ChangeAuditStampsClass"><code>ChangeAuditStampsClass</code></a>) – </li><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>externalUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>chartUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>inputs</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>inputEdges</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.EdgeClass"><code>EdgeClass</code></a>]]) – </li><li><strong>type</strong> (<code>Union</code>[<code>None</code>, <code>str</code>, <a href="#datahub.metadata.schema_classes.ChartTypeClass"><code>ChartTypeClass</code></a>]) – </li><li><strong>access</strong> (<code>Union</code>[<code>None</code>, <code>str</code>, <a href="#datahub.metadata.schema_classes.AccessLevelClass"><code>AccessLevelClass</code></a>]) – </li><li><strong>lastRefreshed</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-access--none--str--accesslevelclass"><em>property</em> access <em>: None | str | <a href="#datahub.metadata.schema_classes.AccessLevelClass">AccessLevelClass</a></em><a href="#property-access--none--str--accesslevelclass" class="hash-link" aria-label="Direct link to property-access--none--str--accesslevelclass" title="Direct link to property-access--none--str--accesslevelclass"></a></h4><p>Access level for the chart</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-charturl--none--str"><em>property</em> chartUrl <em>: None | str</em><a href="#property-charturl--none--str" class="hash-link" aria-label="Direct link to property-charturl--none--str" title="Direct link to property-charturl--none--str"></a></h4><p>URL for the chart. This could be used as an external link on DataHub to allow users access/view the chart</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-4"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-4" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-4" title="Direct link to property-customproperties--dictstr-str-4"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--str"><em>property</em> description <em>: str</em><a href="#property-description--str" class="hash-link" aria-label="Direct link to property-description--str" title="Direct link to property-description--str"></a></h4><p>Detailed description about the chart</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-externalurl--none--str-3"><em>property</em> externalUrl <em>: None | str</em><a href="#property-externalurl--none--str-3" class="hash-link" aria-label="Direct link to property-externalurl--none--str-3" title="Direct link to property-externalurl--none--str-3"></a></h4><p>URL where the reference exist</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-inputedges--none--listedgeclass"><em>property</em> inputEdges <em>: None | List[<a href="#datahub.metadata.schema_classes.EdgeClass">EdgeClass</a>]</em><a href="#property-inputedges--none--listedgeclass" class="hash-link" aria-label="Direct link to property-inputedges--none--listedgeclass" title="Direct link to property-inputedges--none--listedgeclass"></a></h4><p>Data sources for the chart</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-inputs--none--liststr"><em>property</em> inputs <em>: None | List<!-- -->[str]</em><a href="#property-inputs--none--liststr" class="hash-link" aria-label="Direct link to property-inputs--none--liststr" title="Direct link to property-inputs--none--liststr"></a></h4><p>Data sources for the chart
|
||
Deprecated! Use inputEdges instead.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--changeauditstampsclass"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.ChangeAuditStampsClass">ChangeAuditStampsClass</a></em><a href="#property-lastmodified--changeauditstampsclass" class="hash-link" aria-label="Direct link to property-lastmodified--changeauditstampsclass" title="Direct link to property-lastmodified--changeauditstampsclass"></a></h4><p>Captures information about who created/last modified/deleted this chart and when</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastrefreshed--none--int"><em>property</em> lastRefreshed <em>: None | int</em><a href="#property-lastrefreshed--none--int" class="hash-link" aria-label="Direct link to property-lastrefreshed--none--int" title="Direct link to property-lastrefreshed--none--int"></a></h4><p>The time when this chart last refreshed</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-title--str"><em>property</em> title <em>: str</em><a href="#property-title--str" class="hash-link" aria-label="Direct link to property-title--str" title="Direct link to property-title--str"></a></h4><p>Title of the chart</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--none--str--charttypeclass"><em>property</em> type <em>: None | str | <a href="#datahub.metadata.schema_classes.ChartTypeClass">ChartTypeClass</a></em><a href="#property-type--none--str--charttypeclass" class="hash-link" aria-label="Direct link to property-type--none--str--charttypeclass" title="Direct link to property-type--none--str--charttypeclass"></a></h4><p>Type of the chart</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ChartKeyClass"><span class="visually-hidden">ChartKeyClass</span><a href="#datahub.metadata.schema_classes.ChartKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ChartKeyClass" title="Direct link to datahub.metadata.schema_classes.ChartKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ChartKeyClass</span>(<span class="arg-name">dashboardTool</span>, <span class="arg-name">chartId</span>)<a href="#datahub.metadata.schema_classes.ChartKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Chart</p><ul><li><strong>Parameters:</strong><ul><li><strong>dashboardTool</strong> (<code>str</code>)</li><li><strong>chartId</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-chartid--str"><em>property</em> chartId <em>: str</em><a href="#property-chartid--str" class="hash-link" aria-label="Direct link to property-chartid--str" title="Direct link to property-chartid--str"></a></h4><p>Unique id for the chart. This id should be globally unique for a dashboarding tool even when there are multiple deployments of it. As an example, chart URL could be used here for Looker such as ‘looker.linkedin.com/looks/1234’</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-dashboardtool--str"><em>property</em> dashboardTool <em>: str</em><a href="#property-dashboardtool--str" class="hash-link" aria-label="Direct link to property-dashboardtool--str" title="Direct link to property-dashboardtool--str"></a></h4><p>The name of the dashboard tool such as looker, redash etc.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ChartQueryClass"><span class="visually-hidden">ChartQueryClass</span><a href="#datahub.metadata.schema_classes.ChartQueryClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ChartQueryClass" title="Direct link to datahub.metadata.schema_classes.ChartQueryClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ChartQueryClass</span>(<span class="arg-name">rawQuery</span>, <span class="arg-name">type</span>)<a href="#datahub.metadata.schema_classes.ChartQueryClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information for chart query which is used for getting data of the chart</p><ul><li><strong>Parameters:</strong><ul><li><strong>rawQuery</strong> (<code>str</code>)</li><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.ChartQueryTypeClass"><code>ChartQueryTypeClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-rawquery--str"><em>property</em> rawQuery <em>: str</em><a href="#property-rawquery--str" class="hash-link" aria-label="Direct link to property-rawquery--str" title="Direct link to property-rawquery--str"></a></h4><p>Raw query to build a chart from input datasets</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--chartquerytypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.ChartQueryTypeClass">ChartQueryTypeClass</a></em><a href="#property-type--str--chartquerytypeclass" class="hash-link" aria-label="Direct link to property-type--str--chartquerytypeclass" title="Direct link to property-type--str--chartquerytypeclass"></a></h4><p>Chart query type</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ChartQueryTypeClass"><span class="visually-hidden">ChartQueryTypeClass</span><a href="#datahub.metadata.schema_classes.ChartQueryTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ChartQueryTypeClass" title="Direct link to datahub.metadata.schema_classes.ChartQueryTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ChartQueryTypeClass</span>()<a href="#datahub.metadata.schema_classes.ChartQueryTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="lookml--lookml">LOOKML <em>= 'LOOKML'</em><a href="#lookml--lookml" class="hash-link" aria-label="Direct link to lookml--lookml" title="Direct link to lookml--lookml"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sql--sql-2">SQL <em>= 'SQL'</em><a href="#sql--sql-2" class="hash-link" aria-label="Direct link to sql--sql-2" title="Direct link to sql--sql-2"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ChartSnapshotClass"><span class="visually-hidden">ChartSnapshotClass</span><a href="#datahub.metadata.schema_classes.ChartSnapshotClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ChartSnapshotClass" title="Direct link to datahub.metadata.schema_classes.ChartSnapshotClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ChartSnapshotClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">aspects</span>)<a href="#datahub.metadata.schema_classes.ChartSnapshotClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A metadata snapshot for a specific Chart entity.</p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>aspects</strong> (<code>List</code>[<code>Union</code>[<a href="#datahub.metadata.schema_classes.ChartKeyClass"><code>ChartKeyClass</code></a>, <a href="#datahub.metadata.schema_classes.ChartInfoClass"><code>ChartInfoClass</code></a>, <a href="#datahub.metadata.schema_classes.ChartQueryClass"><code>ChartQueryClass</code></a>, <a href="#datahub.metadata.schema_classes.EditableChartPropertiesClass"><code>EditableChartPropertiesClass</code></a>, <a href="#datahub.metadata.schema_classes.OwnershipClass"><code>OwnershipClass</code></a>, <a href="#datahub.metadata.schema_classes.StatusClass"><code>StatusClass</code></a>, <a href="#datahub.metadata.schema_classes.GlobalTagsClass"><code>GlobalTagsClass</code></a>, <a href="#datahub.metadata.schema_classes.BrowsePathsClass"><code>BrowsePathsClass</code></a>, <a href="#datahub.metadata.schema_classes.GlossaryTermsClass"><code>GlossaryTermsClass</code></a>, <a href="#datahub.metadata.schema_classes.InstitutionalMemoryClass"><code>InstitutionalMemoryClass</code></a>, <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass"><code>DataPlatformInstanceClass</code></a>, <a href="#datahub.metadata.schema_classes.BrowsePathsV2Class"><code>BrowsePathsV2Class</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspects--listchartkeyclass--chartinfoclass--chartqueryclass--editablechartpropertiesclass--ownershipclass--statusclass--globaltagsclass--browsepathsclass--glossarytermsclass--institutionalmemoryclass--dataplatforminstanceclass--browsepathsv2class"><em>property</em> aspects <em>: List[<a href="#datahub.metadata.schema_classes.ChartKeyClass">ChartKeyClass</a> | <a href="#datahub.metadata.schema_classes.ChartInfoClass">ChartInfoClass</a> | <a href="#datahub.metadata.schema_classes.ChartQueryClass">ChartQueryClass</a> | <a href="#datahub.metadata.schema_classes.EditableChartPropertiesClass">EditableChartPropertiesClass</a> | <a href="#datahub.metadata.schema_classes.OwnershipClass">OwnershipClass</a> | <a href="#datahub.metadata.schema_classes.StatusClass">StatusClass</a> | <a href="#datahub.metadata.schema_classes.GlobalTagsClass">GlobalTagsClass</a> | <a href="#datahub.metadata.schema_classes.BrowsePathsClass">BrowsePathsClass</a> | <a href="#datahub.metadata.schema_classes.GlossaryTermsClass">GlossaryTermsClass</a> | <a href="#datahub.metadata.schema_classes.InstitutionalMemoryClass">InstitutionalMemoryClass</a> | <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass">DataPlatformInstanceClass</a> | <a href="#datahub.metadata.schema_classes.BrowsePathsV2Class">BrowsePathsV2Class</a>]</em><a href="#property-aspects--listchartkeyclass--chartinfoclass--chartqueryclass--editablechartpropertiesclass--ownershipclass--statusclass--globaltagsclass--browsepathsclass--glossarytermsclass--institutionalmemoryclass--dataplatforminstanceclass--browsepathsv2class" class="hash-link" aria-label="Direct link to property-aspects--listchartkeyclass--chartinfoclass--chartqueryclass--editablechartpropertiesclass--ownershipclass--statusclass--globaltagsclass--browsepathsclass--glossarytermsclass--institutionalmemoryclass--dataplatforminstanceclass--browsepathsv2class" title="Direct link to property-aspects--listchartkeyclass--chartinfoclass--chartqueryclass--editablechartpropertiesclass--ownershipclass--statusclass--globaltagsclass--browsepathsclass--glossarytermsclass--institutionalmemoryclass--dataplatforminstanceclass--browsepathsv2class"></a></h4><p>The list of metadata aspects associated with the chart. Depending on the use case, this can either be all, or a selection, of supported aspects.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str"><em>property</em> urn <em>: str</em><a href="#property-urn--str" class="hash-link" aria-label="Direct link to property-urn--str" title="Direct link to property-urn--str"></a></h4><p>URN for the entity the metadata snapshot is associated with.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ChartTypeClass"><span class="visually-hidden">ChartTypeClass</span><a href="#datahub.metadata.schema_classes.ChartTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ChartTypeClass" title="Direct link to datahub.metadata.schema_classes.ChartTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ChartTypeClass</span>()<a href="#datahub.metadata.schema_classes.ChartTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>The various types of charts</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="area--area">AREA <em>= 'AREA'</em><a href="#area--area" class="hash-link" aria-label="Direct link to area--area" title="Direct link to area--area"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="bar--bar">BAR <em>= 'BAR'</em><a href="#bar--bar" class="hash-link" aria-label="Direct link to bar--bar" title="Direct link to bar--bar"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="box_plot--box_plot">BOX_PLOT <em>= 'BOX_PLOT'</em><a href="#box_plot--box_plot" class="hash-link" aria-label="Direct link to box_plot--box_plot" title="Direct link to box_plot--box_plot"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="cohort--cohort">COHORT <em>= 'COHORT'</em><a href="#cohort--cohort" class="hash-link" aria-label="Direct link to cohort--cohort" title="Direct link to cohort--cohort"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="histogram--histogram">HISTOGRAM <em>= 'HISTOGRAM'</em><a href="#histogram--histogram" class="hash-link" aria-label="Direct link to histogram--histogram" title="Direct link to histogram--histogram"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="line--line">LINE <em>= 'LINE'</em><a href="#line--line" class="hash-link" aria-label="Direct link to line--line" title="Direct link to line--line"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="pie--pie">PIE <em>= 'PIE'</em><a href="#pie--pie" class="hash-link" aria-label="Direct link to pie--pie" title="Direct link to pie--pie"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="scatter--scatter">SCATTER <em>= 'SCATTER'</em><a href="#scatter--scatter" class="hash-link" aria-label="Direct link to scatter--scatter" title="Direct link to scatter--scatter"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="table--table">TABLE <em>= 'TABLE'</em><a href="#table--table" class="hash-link" aria-label="Direct link to table--table" title="Direct link to table--table"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="text--text">TEXT <em>= 'TEXT'</em><a href="#text--text" class="hash-link" aria-label="Direct link to text--text" title="Direct link to text--text"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="word_cloud--word_cloud">WORD_CLOUD <em>= 'WORD_CLOUD'</em><a href="#word_cloud--word_cloud" class="hash-link" aria-label="Direct link to word_cloud--word_cloud" title="Direct link to word_cloud--word_cloud"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ChartUsageStatisticsClass"><span class="visually-hidden">ChartUsageStatisticsClass</span><a href="#datahub.metadata.schema_classes.ChartUsageStatisticsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ChartUsageStatisticsClass" title="Direct link to datahub.metadata.schema_classes.ChartUsageStatisticsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ChartUsageStatisticsClass</span>(<span class="arg-name">timestampMillis</span>, <span class="arg-name">eventGranularity</span> = <span class="arg-default">None</span>, <span class="arg-name">partitionSpec</span> = <span class="arg-default">None</span>, <span class="arg-name">messageId</span> = <span class="arg-default">None</span>, <span class="arg-name">viewsCount</span> = <span class="arg-default">None</span>, <span class="arg-name">uniqueUserCount</span> = <span class="arg-default">None</span>, <span class="arg-name">userCounts</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.ChartUsageStatisticsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Experimental (Subject to breaking change) – Stats corresponding to chart’s usage.</p><p>If this aspect represents the latest snapshot of the statistics about a Chart, the eventGranularity field should be null.
|
||
If this aspect represents a bucketed window of usage statistics (e.g. over a day), then the eventGranularity field should be set accordingly.</p><ul><li><strong>Parameters:</strong><ul><li><strong>timestampMillis</strong> (<code>int</code>)</li><li><strong>eventGranularity</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeWindowSizeClass"><code>TimeWindowSizeClass</code></a>]) – </li><li><strong>partitionSpec</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.PartitionSpecClass"><code>PartitionSpecClass</code></a>]) – </li><li><strong>messageId</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>viewsCount</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>uniqueUserCount</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>userCounts</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.ChartUserUsageCountsClass"><code>ChartUserUsageCountsClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="aspect_type--classvarstr--timeseries-1">ASPECT_TYPE <em>: <code>ClassVar</code>[<code>str</code>]</em> <em>= 'timeseries'</em><a href="#aspect_type--classvarstr--timeseries-1" class="hash-link" aria-label="Direct link to aspect_type--classvarstr--timeseries-1" title="Direct link to aspect_type--classvarstr--timeseries-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-eventgranularity--none--timewindowsizeclass-1"><em>property</em> eventGranularity <em>: None | <a href="#datahub.metadata.schema_classes.TimeWindowSizeClass">TimeWindowSizeClass</a></em><a href="#property-eventgranularity--none--timewindowsizeclass-1" class="hash-link" aria-label="Direct link to property-eventgranularity--none--timewindowsizeclass-1" title="Direct link to property-eventgranularity--none--timewindowsizeclass-1"></a></h4><p>Granularity of the event if applicable</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-messageid--none--str-1"><em>property</em> messageId <em>: None | str</em><a href="#property-messageid--none--str-1" class="hash-link" aria-label="Direct link to property-messageid--none--str-1" title="Direct link to property-messageid--none--str-1"></a></h4><p>The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-partitionspec--partitionspecclass--none-1"><em>property</em> partitionSpec <em>: <a href="#datahub.metadata.schema_classes.PartitionSpecClass">PartitionSpecClass</a> | None</em><a href="#property-partitionspec--partitionspecclass--none-1" class="hash-link" aria-label="Direct link to property-partitionspec--partitionspecclass--none-1" title="Direct link to property-partitionspec--partitionspecclass--none-1"></a></h4><p>The optional partition specification.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-timestampmillis--int-1"><em>property</em> timestampMillis <em>: int</em><a href="#property-timestampmillis--int-1" class="hash-link" aria-label="Direct link to property-timestampmillis--int-1" title="Direct link to property-timestampmillis--int-1"></a></h4><p>The event timestamp field as epoch at UTC in milli seconds.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-uniqueusercount--none--int"><em>property</em> uniqueUserCount <em>: None | int</em><a href="#property-uniqueusercount--none--int" class="hash-link" aria-label="Direct link to property-uniqueusercount--none--int" title="Direct link to property-uniqueusercount--none--int"></a></h4><p>Unique user count</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-usercounts--none--listchartuserusagecountsclass"><em>property</em> userCounts <em>: None | List[<a href="#datahub.metadata.schema_classes.ChartUserUsageCountsClass">ChartUserUsageCountsClass</a>]</em><a href="#property-usercounts--none--listchartuserusagecountsclass" class="hash-link" aria-label="Direct link to property-usercounts--none--listchartuserusagecountsclass" title="Direct link to property-usercounts--none--listchartuserusagecountsclass"></a></h4><p>Users within this bucket, with frequency counts</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-viewscount--none--int"><em>property</em> viewsCount <em>: None | int</em><a href="#property-viewscount--none--int" class="hash-link" aria-label="Direct link to property-viewscount--none--int" title="Direct link to property-viewscount--none--int"></a></h4><p>The total number of times chart has been viewed</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ChartUserUsageCountsClass"><span class="visually-hidden">ChartUserUsageCountsClass</span><a href="#datahub.metadata.schema_classes.ChartUserUsageCountsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ChartUserUsageCountsClass" title="Direct link to datahub.metadata.schema_classes.ChartUserUsageCountsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ChartUserUsageCountsClass</span>(<span class="arg-name">user</span>, <span class="arg-name">viewsCount</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.ChartUserUsageCountsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Records a single user’s usage counts for a given resource</p><ul><li><strong>Parameters:</strong><ul><li><strong>user</strong> (<code>str</code>)</li><li><strong>viewsCount</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-user--str"><em>property</em> user <em>: str</em><a href="#property-user--str" class="hash-link" aria-label="Direct link to property-user--str" title="Direct link to property-user--str"></a></h4><p>The unique id of the user.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-viewscount--none--int-1"><em>property</em> viewsCount <em>: None | int</em><a href="#property-viewscount--none--int-1" class="hash-link" aria-label="Direct link to property-viewscount--none--int-1" title="Direct link to property-viewscount--none--int-1"></a></h4><p>The number of times the user has viewed the chart</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ConditionClass"><span class="visually-hidden">ConditionClass</span><a href="#datahub.metadata.schema_classes.ConditionClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ConditionClass" title="Direct link to datahub.metadata.schema_classes.ConditionClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ConditionClass</span>()<a href="#datahub.metadata.schema_classes.ConditionClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>The matching condition in a filter criterion</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="ancestors_incl--ancestors_incl">ANCESTORS_INCL <em>= 'ANCESTORS_INCL'</em><a href="#ancestors_incl--ancestors_incl" class="hash-link" aria-label="Direct link to ancestors_incl--ancestors_incl" title="Direct link to ancestors_incl--ancestors_incl"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="contain--contain-1">CONTAIN <em>= 'CONTAIN'</em><a href="#contain--contain-1" class="hash-link" aria-label="Direct link to contain--contain-1" title="Direct link to contain--contain-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="descendants_incl--descendants_incl">DESCENDANTS_INCL <em>= 'DESCENDANTS_INCL'</em><a href="#descendants_incl--descendants_incl" class="hash-link" aria-label="Direct link to descendants_incl--descendants_incl" title="Direct link to descendants_incl--descendants_incl"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="end_with--end_with-1">END_WITH <em>= 'END_WITH'</em><a href="#end_with--end_with-1" class="hash-link" aria-label="Direct link to end_with--end_with-1" title="Direct link to end_with--end_with-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="equal--equal">EQUAL <em>= 'EQUAL'</em><a href="#equal--equal" class="hash-link" aria-label="Direct link to equal--equal" title="Direct link to equal--equal"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="exists--exists">EXISTS <em>= 'EXISTS'</em><a href="#exists--exists" class="hash-link" aria-label="Direct link to exists--exists" title="Direct link to exists--exists"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="greater_than--greater_than-1">GREATER_THAN <em>= 'GREATER_THAN'</em><a href="#greater_than--greater_than-1" class="hash-link" aria-label="Direct link to greater_than--greater_than-1" title="Direct link to greater_than--greater_than-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="greater_than_or_equal_to--greater_than_or_equal_to-1">GREATER_THAN_OR_EQUAL_TO <em>= 'GREATER_THAN_OR_EQUAL_TO'</em><a href="#greater_than_or_equal_to--greater_than_or_equal_to-1" class="hash-link" aria-label="Direct link to greater_than_or_equal_to--greater_than_or_equal_to-1" title="Direct link to greater_than_or_equal_to--greater_than_or_equal_to-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="iequal--iequal">IEQUAL <em>= 'IEQUAL'</em><a href="#iequal--iequal" class="hash-link" aria-label="Direct link to iequal--iequal" title="Direct link to iequal--iequal"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="in--in-1">IN <em>= 'IN'</em><a href="#in--in-1" class="hash-link" aria-label="Direct link to in--in-1" title="Direct link to in--in-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="is_null--is_null">IS_NULL <em>= 'IS_NULL'</em><a href="#is_null--is_null" class="hash-link" aria-label="Direct link to is_null--is_null" title="Direct link to is_null--is_null"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="less_than--less_than-1">LESS_THAN <em>= 'LESS_THAN'</em><a href="#less_than--less_than-1" class="hash-link" aria-label="Direct link to less_than--less_than-1" title="Direct link to less_than--less_than-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="less_than_or_equal_to--less_than_or_equal_to-1">LESS_THAN_OR_EQUAL_TO <em>= 'LESS_THAN_OR_EQUAL_TO'</em><a href="#less_than_or_equal_to--less_than_or_equal_to-1" class="hash-link" aria-label="Direct link to less_than_or_equal_to--less_than_or_equal_to-1" title="Direct link to less_than_or_equal_to--less_than_or_equal_to-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="related_incl--related_incl">RELATED_INCL <em>= 'RELATED_INCL'</em><a href="#related_incl--related_incl" class="hash-link" aria-label="Direct link to related_incl--related_incl" title="Direct link to related_incl--related_incl"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="start_with--start_with-1">START_WITH <em>= 'START_WITH'</em><a href="#start_with--start_with-1" class="hash-link" aria-label="Direct link to start_with--start_with-1" title="Direct link to start_with--start_with-1"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ConjunctiveCriterionClass"><span class="visually-hidden">ConjunctiveCriterionClass</span><a href="#datahub.metadata.schema_classes.ConjunctiveCriterionClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ConjunctiveCriterionClass" title="Direct link to datahub.metadata.schema_classes.ConjunctiveCriterionClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ConjunctiveCriterionClass</span>(<span class="arg-name">and_</span>)<a href="#datahub.metadata.schema_classes.ConjunctiveCriterionClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A list of criterion and’d together.</p><ul><li><strong>Parameters:</strong><strong>and_</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.CriterionClass"><code>CriterionClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-and_--listcriterionclass"><em>property</em> and_ <em>: List[<a href="#datahub.metadata.schema_classes.CriterionClass">CriterionClass</a>]</em><a href="#property-and_--listcriterionclass" class="hash-link" aria-label="Direct link to property-and_--listcriterionclass" title="Direct link to property-and_--listcriterionclass"></a></h4><p>A list of and criteria the filter applies to the query</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ContainerClass"><span class="visually-hidden">ContainerClass</span><a href="#datahub.metadata.schema_classes.ContainerClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ContainerClass" title="Direct link to datahub.metadata.schema_classes.ContainerClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ContainerClass</span>(<span class="arg-name">container</span>)<a href="#datahub.metadata.schema_classes.ContainerClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Link from an asset to its parent container</p><ul><li><strong>Parameters:</strong><strong>container</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-container--str"><em>property</em> container <em>: str</em><a href="#property-container--str" class="hash-link" aria-label="Direct link to property-container--str" title="Direct link to property-container--str"></a></h4><p>The parent container of an asset</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ContainerKeyClass"><span class="visually-hidden">ContainerKeyClass</span><a href="#datahub.metadata.schema_classes.ContainerKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ContainerKeyClass" title="Direct link to datahub.metadata.schema_classes.ContainerKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ContainerKeyClass</span>(<span class="arg-name">guid</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.ContainerKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for an Asset Container</p><ul><li><strong>Parameters:</strong><strong>guid</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-guid--none--str"><em>property</em> guid <em>: None | str</em><a href="#property-guid--none--str" class="hash-link" aria-label="Direct link to property-guid--none--str" title="Direct link to property-guid--none--str"></a></h4><p>Unique guid for container</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ContainerPropertiesClass"><span class="visually-hidden">ContainerPropertiesClass</span><a href="#datahub.metadata.schema_classes.ContainerPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ContainerPropertiesClass" title="Direct link to datahub.metadata.schema_classes.ContainerPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ContainerPropertiesClass</span>(<span class="arg-name">name</span>, <span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">externalUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">qualifiedName</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">env</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.ContainerPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a Asset Container as received from a 3rd party source system</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>externalUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>qualifiedName</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>env</strong> (<code>Union</code>[<code>None</code>, <code>str</code>, <a href="#datahub.metadata.schema_classes.FabricTypeClass"><code>FabricTypeClass</code></a>]) – </li><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeStampClass"><code>TimeStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeStampClass"><code>TimeStampClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--none--timestampclass"><em>property</em> created <em>: None | <a href="#datahub.metadata.schema_classes.TimeStampClass">TimeStampClass</a></em><a href="#property-created--none--timestampclass" class="hash-link" aria-label="Direct link to property-created--none--timestampclass" title="Direct link to property-created--none--timestampclass"></a></h4><p>A timestamp documenting when the asset was created in the source Data Platform (not on DataHub)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-5"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-5" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-5" title="Direct link to property-customproperties--dictstr-str-5"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-3"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-3" class="hash-link" aria-label="Direct link to property-description--none--str-3" title="Direct link to property-description--none--str-3"></a></h4><p>Description of the Asset Container as it exists inside a source system</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-env--none--str--fabrictypeclass"><em>property</em> env <em>: None | str | <a href="#datahub.metadata.schema_classes.FabricTypeClass">FabricTypeClass</a></em><a href="#property-env--none--str--fabrictypeclass" class="hash-link" aria-label="Direct link to property-env--none--str--fabrictypeclass" title="Direct link to property-env--none--str--fabrictypeclass"></a></h4><p>Environment for this flow</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-externalurl--none--str-4"><em>property</em> externalUrl <em>: None | str</em><a href="#property-externalurl--none--str-4" class="hash-link" aria-label="Direct link to property-externalurl--none--str-4" title="Direct link to property-externalurl--none--str-4"></a></h4><p>URL where the reference exist</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--none--timestampclass"><em>property</em> lastModified <em>: None | <a href="#datahub.metadata.schema_classes.TimeStampClass">TimeStampClass</a></em><a href="#property-lastmodified--none--timestampclass" class="hash-link" aria-label="Direct link to property-lastmodified--none--timestampclass" title="Direct link to property-lastmodified--none--timestampclass"></a></h4><p>A timestamp documenting when the asset was last modified in the source Data Platform (not on DataHub)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-1"><em>property</em> name <em>: str</em><a href="#property-name--str-1" class="hash-link" aria-label="Direct link to property-name--str-1" title="Direct link to property-name--str-1"></a></h4><p>Display name of the Asset Container</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-qualifiedname--none--str"><em>property</em> qualifiedName <em>: None | str</em><a href="#property-qualifiedname--none--str" class="hash-link" aria-label="Direct link to property-qualifiedname--none--str" title="Direct link to property-qualifiedname--none--str"></a></h4><p>Fully-qualified name of the Container</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CorpGroupEditableInfoClass"><span class="visually-hidden">CorpGroupEditableInfoClass</span><a href="#datahub.metadata.schema_classes.CorpGroupEditableInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CorpGroupEditableInfoClass" title="Direct link to datahub.metadata.schema_classes.CorpGroupEditableInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CorpGroupEditableInfoClass</span>(<span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">pictureLink</span> = <span class="arg-default">None</span>, <span class="arg-name">slack</span> = <span class="arg-default">None</span>, <span class="arg-name">email</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.CorpGroupEditableInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Group information that can be edited from UI</p><ul><li><strong>Parameters:</strong><ul><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>pictureLink</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>slack</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>email</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-4"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-4" class="hash-link" aria-label="Direct link to property-description--none--str-4" title="Direct link to property-description--none--str-4"></a></h4><p>A description of the group</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-email--none--str"><em>property</em> email <em>: None | str</em><a href="#property-email--none--str" class="hash-link" aria-label="Direct link to property-email--none--str" title="Direct link to property-email--none--str"></a></h4><p>Email address to contact the group</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-picturelink--str"><em>property</em> pictureLink <em>: str</em><a href="#property-picturelink--str" class="hash-link" aria-label="Direct link to property-picturelink--str" title="Direct link to property-picturelink--str"></a></h4><p>A URL which points to a picture which user wants to set as the photo for the group</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-slack--none--str"><em>property</em> slack <em>: None | str</em><a href="#property-slack--none--str" class="hash-link" aria-label="Direct link to property-slack--none--str" title="Direct link to property-slack--none--str"></a></h4><p>Slack channel for the group</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CorpGroupInfoClass"><span class="visually-hidden">CorpGroupInfoClass</span><a href="#datahub.metadata.schema_classes.CorpGroupInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CorpGroupInfoClass" title="Direct link to datahub.metadata.schema_classes.CorpGroupInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CorpGroupInfoClass</span>(<span class="arg-name">admins</span>, <span class="arg-name">members</span>, <span class="arg-name">groups</span>, <span class="arg-name">displayName</span> = <span class="arg-default">None</span>, <span class="arg-name">email</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">slack</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.CorpGroupInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a Corp Group ingested from a third party source</p><ul><li><strong>Parameters:</strong><ul><li><strong>admins</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li><li><strong>members</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li><li><strong>groups</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li><li><strong>displayName</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>email</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>slack</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-admins--liststr"><em>property</em> admins <em>: List<!-- -->[str]</em><a href="#property-admins--liststr" class="hash-link" aria-label="Direct link to property-admins--liststr" title="Direct link to property-admins--liststr"></a></h4><p>owners of this group
|
||
Deprecated! Replaced by Ownership aspect.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--none--auditstampclass-1"><em>property</em> created <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--none--auditstampclass-1" class="hash-link" aria-label="Direct link to property-created--none--auditstampclass-1" title="Direct link to property-created--none--auditstampclass-1"></a></h4><p>Created Audit stamp</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-5"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-5" class="hash-link" aria-label="Direct link to property-description--none--str-5" title="Direct link to property-description--none--str-5"></a></h4><p>A description of the group.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-displayname--none--str"><em>property</em> displayName <em>: None | str</em><a href="#property-displayname--none--str" class="hash-link" aria-label="Direct link to property-displayname--none--str" title="Direct link to property-displayname--none--str"></a></h4><p>The name of the group.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-email--none--str-1"><em>property</em> email <em>: None | str</em><a href="#property-email--none--str-1" class="hash-link" aria-label="Direct link to property-email--none--str-1" title="Direct link to property-email--none--str-1"></a></h4><p>email of this group</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-groups--liststr"><em>property</em> groups <em>: List<!-- -->[str]</em><a href="#property-groups--liststr" class="hash-link" aria-label="Direct link to property-groups--liststr" title="Direct link to property-groups--liststr"></a></h4><p>List of groups in this group.
|
||
Deprecated! This field is unused.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-members--liststr"><em>property</em> members <em>: List<!-- -->[str]</em><a href="#property-members--liststr" class="hash-link" aria-label="Direct link to property-members--liststr" title="Direct link to property-members--liststr"></a></h4><p>List of ldap urn in this group.
|
||
Deprecated! Replaced by GroupMembership aspect.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-slack--none--str-1"><em>property</em> slack <em>: None | str</em><a href="#property-slack--none--str-1" class="hash-link" aria-label="Direct link to property-slack--none--str-1" title="Direct link to property-slack--none--str-1"></a></h4><p>Slack channel for the group</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CorpGroupKeyClass"><span class="visually-hidden">CorpGroupKeyClass</span><a href="#datahub.metadata.schema_classes.CorpGroupKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CorpGroupKeyClass" title="Direct link to datahub.metadata.schema_classes.CorpGroupKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CorpGroupKeyClass</span>(<span class="arg-name">name</span>)<a href="#datahub.metadata.schema_classes.CorpGroupKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a CorpGroup</p><ul><li><strong>Parameters:</strong><strong>name</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-2"><em>property</em> name <em>: str</em><a href="#property-name--str-2" class="hash-link" aria-label="Direct link to property-name--str-2" title="Direct link to property-name--str-2"></a></h4><p>The URL-encoded name of the AD/LDAP group. Serves as a globally unique identifier within DataHub.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CorpGroupSnapshotClass"><span class="visually-hidden">CorpGroupSnapshotClass</span><a href="#datahub.metadata.schema_classes.CorpGroupSnapshotClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CorpGroupSnapshotClass" title="Direct link to datahub.metadata.schema_classes.CorpGroupSnapshotClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CorpGroupSnapshotClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">aspects</span>)<a href="#datahub.metadata.schema_classes.CorpGroupSnapshotClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A metadata snapshot for a specific CorpGroup entity.</p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>aspects</strong> (<code>List</code>[<code>Union</code>[<a href="#datahub.metadata.schema_classes.CorpGroupKeyClass"><code>CorpGroupKeyClass</code></a>, <a href="#datahub.metadata.schema_classes.CorpGroupInfoClass"><code>CorpGroupInfoClass</code></a>, <a href="#datahub.metadata.schema_classes.GlobalTagsClass"><code>GlobalTagsClass</code></a>, <a href="#datahub.metadata.schema_classes.StatusClass"><code>StatusClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspects--listcorpgroupkeyclass--corpgroupinfoclass--globaltagsclass--statusclass"><em>property</em> aspects <em>: List[<a href="#datahub.metadata.schema_classes.CorpGroupKeyClass">CorpGroupKeyClass</a> | <a href="#datahub.metadata.schema_classes.CorpGroupInfoClass">CorpGroupInfoClass</a> | <a href="#datahub.metadata.schema_classes.GlobalTagsClass">GlobalTagsClass</a> | <a href="#datahub.metadata.schema_classes.StatusClass">StatusClass</a>]</em><a href="#property-aspects--listcorpgroupkeyclass--corpgroupinfoclass--globaltagsclass--statusclass" class="hash-link" aria-label="Direct link to property-aspects--listcorpgroupkeyclass--corpgroupinfoclass--globaltagsclass--statusclass" title="Direct link to property-aspects--listcorpgroupkeyclass--corpgroupinfoclass--globaltagsclass--statusclass"></a></h4><p>The list of metadata aspects associated with the LdapUser. Depending on the use case, this can either be all, or a selection, of supported aspects.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-1"><em>property</em> urn <em>: str</em><a href="#property-urn--str-1" class="hash-link" aria-label="Direct link to property-urn--str-1" title="Direct link to property-urn--str-1"></a></h4><p>URN for the entity the metadata snapshot is associated with.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CorpUserAppearanceSettingsClass"><span class="visually-hidden">CorpUserAppearanceSettingsClass</span><a href="#datahub.metadata.schema_classes.CorpUserAppearanceSettingsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CorpUserAppearanceSettingsClass" title="Direct link to datahub.metadata.schema_classes.CorpUserAppearanceSettingsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CorpUserAppearanceSettingsClass</span>(<span class="arg-name">showSimplifiedHomepage</span> = <span class="arg-default">None</span>, <span class="arg-name">showThemeV2</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.CorpUserAppearanceSettingsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Settings for a user around the appearance of their DataHub UI</p><ul><li><strong>Parameters:</strong><ul><li><strong>showSimplifiedHomepage</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>showThemeV2</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-showsimplifiedhomepage--none--bool"><em>property</em> showSimplifiedHomepage <em>: None | bool</em><a href="#property-showsimplifiedhomepage--none--bool" class="hash-link" aria-label="Direct link to property-showsimplifiedhomepage--none--bool" title="Direct link to property-showsimplifiedhomepage--none--bool"></a></h4><p>Flag whether the user should see a homepage with only datasets, charts and dashboards. Intended for users
|
||
who have less operational use cases for the datahub tool.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-showthemev2--none--bool"><em>property</em> showThemeV2 <em>: None | bool</em><a href="#property-showthemev2--none--bool" class="hash-link" aria-label="Direct link to property-showthemev2--none--bool" title="Direct link to property-showthemev2--none--bool"></a></h4><p>Flag controlling whether the V2 UI for DataHub is shown.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CorpUserCredentialsClass"><span class="visually-hidden">CorpUserCredentialsClass</span><a href="#datahub.metadata.schema_classes.CorpUserCredentialsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CorpUserCredentialsClass" title="Direct link to datahub.metadata.schema_classes.CorpUserCredentialsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CorpUserCredentialsClass</span>(<span class="arg-name">salt</span>, <span class="arg-name">hashedPassword</span>, <span class="arg-name">passwordResetToken</span> = <span class="arg-default">None</span>, <span class="arg-name">passwordResetTokenExpirationTimeMillis</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.CorpUserCredentialsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Corp user credentials</p><ul><li><strong>Parameters:</strong><ul><li><strong>salt</strong> (<code>str</code>)</li><li><strong>hashedPassword</strong> (<code>str</code>)</li><li><strong>passwordResetToken</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>passwordResetTokenExpirationTimeMillis</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-hashedpassword--str"><em>property</em> hashedPassword <em>: str</em><a href="#property-hashedpassword--str" class="hash-link" aria-label="Direct link to property-hashedpassword--str" title="Direct link to property-hashedpassword--str"></a></h4><p>Hashed password generated by concatenating salt and password, then hashing</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-passwordresettoken--none--str"><em>property</em> passwordResetToken <em>: None | str</em><a href="#property-passwordresettoken--none--str" class="hash-link" aria-label="Direct link to property-passwordresettoken--none--str" title="Direct link to property-passwordresettoken--none--str"></a></h4><p>Optional token needed to reset a user’s password. Can only be set by the admin.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-passwordresettokenexpirationtimemillis--none--int"><em>property</em> passwordResetTokenExpirationTimeMillis <em>: None | int</em><a href="#property-passwordresettokenexpirationtimemillis--none--int" class="hash-link" aria-label="Direct link to property-passwordresettokenexpirationtimemillis--none--int" title="Direct link to property-passwordresettokenexpirationtimemillis--none--int"></a></h4><p>When the password reset token expires.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-salt--str"><em>property</em> salt <em>: str</em><a href="#property-salt--str" class="hash-link" aria-label="Direct link to property-salt--str" title="Direct link to property-salt--str"></a></h4><p>Salt used to hash password</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CorpUserEditableInfoClass"><span class="visually-hidden">CorpUserEditableInfoClass</span><a href="#datahub.metadata.schema_classes.CorpUserEditableInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CorpUserEditableInfoClass" title="Direct link to datahub.metadata.schema_classes.CorpUserEditableInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CorpUserEditableInfoClass</span>(<span class="arg-name">aboutMe</span> = <span class="arg-default">None</span>, <span class="arg-name">teams</span> = <span class="arg-default">None</span>, <span class="arg-name">skills</span> = <span class="arg-default">None</span>, <span class="arg-name">pictureLink</span> = <span class="arg-default">None</span>, <span class="arg-name">displayName</span> = <span class="arg-default">None</span>, <span class="arg-name">title</span> = <span class="arg-default">None</span>, <span class="arg-name">platforms</span> = <span class="arg-default">None</span>, <span class="arg-name">persona</span> = <span class="arg-default">None</span>, <span class="arg-name">slack</span> = <span class="arg-default">None</span>, <span class="arg-name">phone</span> = <span class="arg-default">None</span>, <span class="arg-name">email</span> = <span class="arg-default">None</span>, <span class="arg-name">informationSources</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.CorpUserEditableInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Linkedin corp user information that can be edited from UI</p><ul><li><strong>Parameters:</strong><ul><li><strong>aboutMe</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>teams</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>skills</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>pictureLink</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>displayName</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>title</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>platforms</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>persona</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>slack</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>phone</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>email</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>informationSources</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aboutme--none--str"><em>property</em> aboutMe <em>: None | str</em><a href="#property-aboutme--none--str" class="hash-link" aria-label="Direct link to property-aboutme--none--str" title="Direct link to property-aboutme--none--str"></a></h4><p>About me section of the user</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-displayname--none--str-1"><em>property</em> displayName <em>: None | str</em><a href="#property-displayname--none--str-1" class="hash-link" aria-label="Direct link to property-displayname--none--str-1" title="Direct link to property-displayname--none--str-1"></a></h4><p>DataHub-native display name</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-email--none--str-2"><em>property</em> email <em>: None | str</em><a href="#property-email--none--str-2" class="hash-link" aria-label="Direct link to property-email--none--str-2" title="Direct link to property-email--none--str-2"></a></h4><p>Email address to contact the user</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-informationsources--none--liststr"><em>property</em> informationSources <em>: None | List<!-- -->[str]</em><a href="#property-informationsources--none--liststr" class="hash-link" aria-label="Direct link to property-informationsources--none--liststr" title="Direct link to property-informationsources--none--liststr"></a></h4><p>Information sources that have been used to populate this CorpUserEditableInfo.
|
||
These include platform resources, such as Slack members or Looker users.
|
||
They can also refer to other semantic urns in the future.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-persona--none--str"><em>property</em> persona <em>: None | str</em><a href="#property-persona--none--str" class="hash-link" aria-label="Direct link to property-persona--none--str" title="Direct link to property-persona--none--str"></a></h4><p>The user’s persona type, based on their role</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-phone--none--str"><em>property</em> phone <em>: None | str</em><a href="#property-phone--none--str" class="hash-link" aria-label="Direct link to property-phone--none--str" title="Direct link to property-phone--none--str"></a></h4><p>Phone number to contact the user</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-picturelink--str-1"><em>property</em> pictureLink <em>: str</em><a href="#property-picturelink--str-1" class="hash-link" aria-label="Direct link to property-picturelink--str-1" title="Direct link to property-picturelink--str-1"></a></h4><p>A URL which points to a picture which user wants to set as a profile photo</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-platforms--none--liststr"><em>property</em> platforms <em>: None | List<!-- -->[str]</em><a href="#property-platforms--none--liststr" class="hash-link" aria-label="Direct link to property-platforms--none--liststr" title="Direct link to property-platforms--none--liststr"></a></h4><p>The platforms that the user commonly works with</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-skills--liststr"><em>property</em> skills <em>: List<!-- -->[str]</em><a href="#property-skills--liststr" class="hash-link" aria-label="Direct link to property-skills--liststr" title="Direct link to property-skills--liststr"></a></h4><p>Skills that the user possesses e.g. Machine Learning</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-slack--none--str-2"><em>property</em> slack <em>: None | str</em><a href="#property-slack--none--str-2" class="hash-link" aria-label="Direct link to property-slack--none--str-2" title="Direct link to property-slack--none--str-2"></a></h4><p>Slack handle for the user</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-teams--liststr"><em>property</em> teams <em>: List<!-- -->[str]</em><a href="#property-teams--liststr" class="hash-link" aria-label="Direct link to property-teams--liststr" title="Direct link to property-teams--liststr"></a></h4><p>Teams that the user belongs to e.g. Metadata</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-title--none--str"><em>property</em> title <em>: None | str</em><a href="#property-title--none--str" class="hash-link" aria-label="Direct link to property-title--none--str" title="Direct link to property-title--none--str"></a></h4><p>DataHub-native Title, e.g. ‘Software Engineer’</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CorpUserHomePageSettingsClass"><span class="visually-hidden">CorpUserHomePageSettingsClass</span><a href="#datahub.metadata.schema_classes.CorpUserHomePageSettingsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CorpUserHomePageSettingsClass" title="Direct link to datahub.metadata.schema_classes.CorpUserHomePageSettingsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CorpUserHomePageSettingsClass</span>(<span class="arg-name">pageTemplate</span>)<a href="#datahub.metadata.schema_classes.CorpUserHomePageSettingsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Settings related to the home page for a user</p><ul><li><strong>Parameters:</strong><strong>pageTemplate</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-pagetemplate--str"><em>property</em> pageTemplate <em>: str</em><a href="#property-pagetemplate--str" class="hash-link" aria-label="Direct link to property-pagetemplate--str" title="Direct link to property-pagetemplate--str"></a></h4><p>The page template that will be rendered in the UI by default for this user</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CorpUserInfoClass"><span class="visually-hidden">CorpUserInfoClass</span><a href="#datahub.metadata.schema_classes.CorpUserInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CorpUserInfoClass" title="Direct link to datahub.metadata.schema_classes.CorpUserInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CorpUserInfoClass</span>(<span class="arg-name">active</span>, <span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">displayName</span> = <span class="arg-default">None</span>, <span class="arg-name">email</span> = <span class="arg-default">None</span>, <span class="arg-name">title</span> = <span class="arg-default">None</span>, <span class="arg-name">managerUrn</span> = <span class="arg-default">None</span>, <span class="arg-name">departmentId</span> = <span class="arg-default">None</span>, <span class="arg-name">departmentName</span> = <span class="arg-default">None</span>, <span class="arg-name">firstName</span> = <span class="arg-default">None</span>, <span class="arg-name">lastName</span> = <span class="arg-default">None</span>, <span class="arg-name">fullName</span> = <span class="arg-default">None</span>, <span class="arg-name">countryCode</span> = <span class="arg-default">None</span>, <span class="arg-name">system</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.CorpUserInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Linkedin corp user information</p><ul><li><strong>Parameters:</strong><ul><li><strong>active</strong> (<code>bool</code>)</li><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>displayName</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>email</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>title</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>managerUrn</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>departmentId</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>departmentName</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>firstName</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>lastName</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>fullName</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>countryCode</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>system</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-active--bool"><em>property</em> active <em>: bool</em><a href="#property-active--bool" class="hash-link" aria-label="Direct link to property-active--bool" title="Direct link to property-active--bool"></a></h4><p>//i<a href="http://www.corp.linkedin.com/wiki/cf/display/GTSD/Accessing+Active+Directory+via+LDAP+tools" target="_blank" rel="noopener noreferrer">www.corp.linkedin.com/wiki/cf/display/GTSD/Accessing+Active+Directory+via+LDAP+tools</a></p><ul><li><strong>Type:</strong>
|
||
Deprecated! Use CorpUserStatus instead. Whether the corpUser is active, ref</li><li><strong>Type:</strong>
|
||
https</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-countrycode--none--str"><em>property</em> countryCode <em>: None | str</em><a href="#property-countrycode--none--str" class="hash-link" aria-label="Direct link to property-countrycode--none--str" title="Direct link to property-countrycode--none--str"></a></h4><p>two uppercase letters country code. e.g. US</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-6"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-6" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-6" title="Direct link to property-customproperties--dictstr-str-6"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-departmentid--none--int"><em>property</em> departmentId <em>: None | int</em><a href="#property-departmentid--none--int" class="hash-link" aria-label="Direct link to property-departmentid--none--int" title="Direct link to property-departmentid--none--int"></a></h4><p>department id this user belong to</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-departmentname--none--str"><em>property</em> departmentName <em>: None | str</em><a href="#property-departmentname--none--str" class="hash-link" aria-label="Direct link to property-departmentname--none--str" title="Direct link to property-departmentname--none--str"></a></h4><p>department name this user belong to</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-displayname--none--str-2"><em>property</em> displayName <em>: None | str</em><a href="#property-displayname--none--str-2" class="hash-link" aria-label="Direct link to property-displayname--none--str-2" title="Direct link to property-displayname--none--str-2"></a></h4><p>displayName of this user , e.g. Hang Zhang(DataHQ)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-email--none--str-3"><em>property</em> email <em>: None | str</em><a href="#property-email--none--str-3" class="hash-link" aria-label="Direct link to property-email--none--str-3" title="Direct link to property-email--none--str-3"></a></h4><p>email address of this user</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-firstname--none--str"><em>property</em> firstName <em>: None | str</em><a href="#property-firstname--none--str" class="hash-link" aria-label="Direct link to property-firstname--none--str" title="Direct link to property-firstname--none--str"></a></h4><p>first name of this user</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fullname--none--str"><em>property</em> fullName <em>: None | str</em><a href="#property-fullname--none--str" class="hash-link" aria-label="Direct link to property-fullname--none--str" title="Direct link to property-fullname--none--str"></a></h4><p>Common name of this user, format is firstName + lastName (split by a whitespace)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastname--none--str"><em>property</em> lastName <em>: None | str</em><a href="#property-lastname--none--str" class="hash-link" aria-label="Direct link to property-lastname--none--str" title="Direct link to property-lastname--none--str"></a></h4><p>last name of this user</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-managerurn--none--str"><em>property</em> managerUrn <em>: None | str</em><a href="#property-managerurn--none--str" class="hash-link" aria-label="Direct link to property-managerurn--none--str" title="Direct link to property-managerurn--none--str"></a></h4><p>direct manager of this user</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-system--bool--none"><em>property</em> system <em>: bool | None</em><a href="#property-system--bool--none" class="hash-link" aria-label="Direct link to property-system--bool--none" title="Direct link to property-system--bool--none"></a></h4><p>Whether the corpUser is a system user.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-title--none--str-1"><em>property</em> title <em>: None | str</em><a href="#property-title--none--str-1" class="hash-link" aria-label="Direct link to property-title--none--str-1" title="Direct link to property-title--none--str-1"></a></h4><p>title of this user</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CorpUserKeyClass"><span class="visually-hidden">CorpUserKeyClass</span><a href="#datahub.metadata.schema_classes.CorpUserKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CorpUserKeyClass" title="Direct link to datahub.metadata.schema_classes.CorpUserKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CorpUserKeyClass</span>(<span class="arg-name">username</span>)<a href="#datahub.metadata.schema_classes.CorpUserKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a CorpUser</p><ul><li><strong>Parameters:</strong><strong>username</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-username--str"><em>property</em> username <em>: str</em><a href="#property-username--str" class="hash-link" aria-label="Direct link to property-username--str" title="Direct link to property-username--str"></a></h4><p>The name of the AD/LDAP user.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CorpUserSettingsClass"><span class="visually-hidden">CorpUserSettingsClass</span><a href="#datahub.metadata.schema_classes.CorpUserSettingsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CorpUserSettingsClass" title="Direct link to datahub.metadata.schema_classes.CorpUserSettingsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CorpUserSettingsClass</span>(<span class="arg-name">appearance</span>, <span class="arg-name">views</span> = <span class="arg-default">None</span>, <span class="arg-name">notificationSettings</span> = <span class="arg-default">None</span>, <span class="arg-name">homePage</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.CorpUserSettingsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Settings that a user can customize through the datahub ui</p><ul><li><strong>Parameters:</strong><ul><li><strong>appearance</strong> (<a href="#datahub.metadata.schema_classes.CorpUserAppearanceSettingsClass"><code>CorpUserAppearanceSettingsClass</code></a>) – </li><li><strong>views</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.CorpUserViewsSettingsClass"><code>CorpUserViewsSettingsClass</code></a>]) – </li><li><strong>notificationSettings</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.NotificationSettingsClass"><code>NotificationSettingsClass</code></a>]) – </li><li><strong>homePage</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.CorpUserHomePageSettingsClass"><code>CorpUserHomePageSettingsClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-appearance--corpuserappearancesettingsclass"><em>property</em> appearance <em>: <a href="#datahub.metadata.schema_classes.CorpUserAppearanceSettingsClass">CorpUserAppearanceSettingsClass</a></em><a href="#property-appearance--corpuserappearancesettingsclass" class="hash-link" aria-label="Direct link to property-appearance--corpuserappearancesettingsclass" title="Direct link to property-appearance--corpuserappearancesettingsclass"></a></h4><p>Settings for a user around the appearance of their DataHub U</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-homepage--none--corpuserhomepagesettingsclass"><em>property</em> homePage <em>: None | <a href="#datahub.metadata.schema_classes.CorpUserHomePageSettingsClass">CorpUserHomePageSettingsClass</a></em><a href="#property-homepage--none--corpuserhomepagesettingsclass" class="hash-link" aria-label="Direct link to property-homepage--none--corpuserhomepagesettingsclass" title="Direct link to property-homepage--none--corpuserhomepagesettingsclass"></a></h4><p>Settings related to the home page for a user</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-notificationsettings--none--notificationsettingsclass"><em>property</em> notificationSettings <em>: None | <a href="#datahub.metadata.schema_classes.NotificationSettingsClass">NotificationSettingsClass</a></em><a href="#property-notificationsettings--none--notificationsettingsclass" class="hash-link" aria-label="Direct link to property-notificationsettings--none--notificationsettingsclass" title="Direct link to property-notificationsettings--none--notificationsettingsclass"></a></h4><p>Notification settings for a user</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-views--none--corpuserviewssettingsclass"><em>property</em> views <em>: None | <a href="#datahub.metadata.schema_classes.CorpUserViewsSettingsClass">CorpUserViewsSettingsClass</a></em><a href="#property-views--none--corpuserviewssettingsclass" class="hash-link" aria-label="Direct link to property-views--none--corpuserviewssettingsclass" title="Direct link to property-views--none--corpuserviewssettingsclass"></a></h4><p>User preferences for the Views feature.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CorpUserSnapshotClass"><span class="visually-hidden">CorpUserSnapshotClass</span><a href="#datahub.metadata.schema_classes.CorpUserSnapshotClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CorpUserSnapshotClass" title="Direct link to datahub.metadata.schema_classes.CorpUserSnapshotClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CorpUserSnapshotClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">aspects</span>)<a href="#datahub.metadata.schema_classes.CorpUserSnapshotClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A metadata snapshot for a specific CorpUser entity.</p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>aspects</strong> (<code>List</code>[<code>Union</code>[<a href="#datahub.metadata.schema_classes.CorpUserKeyClass"><code>CorpUserKeyClass</code></a>, <a href="#datahub.metadata.schema_classes.CorpUserInfoClass"><code>CorpUserInfoClass</code></a>, <a href="#datahub.metadata.schema_classes.CorpUserEditableInfoClass"><code>CorpUserEditableInfoClass</code></a>, <a href="#datahub.metadata.schema_classes.CorpUserStatusClass"><code>CorpUserStatusClass</code></a>, <a href="#datahub.metadata.schema_classes.GroupMembershipClass"><code>GroupMembershipClass</code></a>, <a href="#datahub.metadata.schema_classes.GlobalTagsClass"><code>GlobalTagsClass</code></a>, <a href="#datahub.metadata.schema_classes.StatusClass"><code>StatusClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspects--listcorpuserkeyclass--corpuserinfoclass--corpusereditableinfoclass--corpuserstatusclass--groupmembershipclass--globaltagsclass--statusclass"><em>property</em> aspects <em>: List[<a href="#datahub.metadata.schema_classes.CorpUserKeyClass">CorpUserKeyClass</a> | <a href="#datahub.metadata.schema_classes.CorpUserInfoClass">CorpUserInfoClass</a> | <a href="#datahub.metadata.schema_classes.CorpUserEditableInfoClass">CorpUserEditableInfoClass</a> | <a href="#datahub.metadata.schema_classes.CorpUserStatusClass">CorpUserStatusClass</a> | <a href="#datahub.metadata.schema_classes.GroupMembershipClass">GroupMembershipClass</a> | <a href="#datahub.metadata.schema_classes.GlobalTagsClass">GlobalTagsClass</a> | <a href="#datahub.metadata.schema_classes.StatusClass">StatusClass</a>]</em><a href="#property-aspects--listcorpuserkeyclass--corpuserinfoclass--corpusereditableinfoclass--corpuserstatusclass--groupmembershipclass--globaltagsclass--statusclass" class="hash-link" aria-label="Direct link to property-aspects--listcorpuserkeyclass--corpuserinfoclass--corpusereditableinfoclass--corpuserstatusclass--groupmembershipclass--globaltagsclass--statusclass" title="Direct link to property-aspects--listcorpuserkeyclass--corpuserinfoclass--corpusereditableinfoclass--corpuserstatusclass--groupmembershipclass--globaltagsclass--statusclass"></a></h4><p>The list of metadata aspects associated with the CorpUser. Depending on the use case, this can either be all, or a selection, of supported aspects.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-2"><em>property</em> urn <em>: str</em><a href="#property-urn--str-2" class="hash-link" aria-label="Direct link to property-urn--str-2" title="Direct link to property-urn--str-2"></a></h4><p>URN for the entity the metadata snapshot is associated with.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CorpUserStatusClass"><span class="visually-hidden">CorpUserStatusClass</span><a href="#datahub.metadata.schema_classes.CorpUserStatusClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CorpUserStatusClass" title="Direct link to datahub.metadata.schema_classes.CorpUserStatusClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CorpUserStatusClass</span>(<span class="arg-name">status</span>, <span class="arg-name">lastModified</span>)<a href="#datahub.metadata.schema_classes.CorpUserStatusClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>The status of the user, e.g. provisioned, active, suspended, etc.</p><ul><li><strong>Parameters:</strong><ul><li><strong>status</strong> (<code>str</code>)</li><li><strong>lastModified</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--auditstampclass-2"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--auditstampclass-2" class="hash-link" aria-label="Direct link to property-lastmodified--auditstampclass-2" title="Direct link to property-lastmodified--auditstampclass-2"></a></h4><p>Audit stamp containing who last modified the status and when.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-status--str"><em>property</em> status <em>: str</em><a href="#property-status--str" class="hash-link" aria-label="Direct link to property-status--str" title="Direct link to property-status--str"></a></h4><p>Status of the user, e.g. PROVISIONED / ACTIVE / SUSPENDED</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CorpUserViewsSettingsClass"><span class="visually-hidden">CorpUserViewsSettingsClass</span><a href="#datahub.metadata.schema_classes.CorpUserViewsSettingsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CorpUserViewsSettingsClass" title="Direct link to datahub.metadata.schema_classes.CorpUserViewsSettingsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CorpUserViewsSettingsClass</span>(<span class="arg-name">defaultView</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.CorpUserViewsSettingsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Settings related to the ‘Views’ feature.</p><ul><li><strong>Parameters:</strong><strong>defaultView</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-defaultview--none--str"><em>property</em> defaultView <em>: None | str</em><a href="#property-defaultview--none--str" class="hash-link" aria-label="Direct link to property-defaultview--none--str" title="Direct link to property-defaultview--none--str"></a></h4><p>The default View which is selected for the user.
|
||
If none is chosen, then this value will be left blank.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CostClass"><span class="visually-hidden">CostClass</span><a href="#datahub.metadata.schema_classes.CostClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CostClass" title="Direct link to datahub.metadata.schema_classes.CostClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CostClass</span>(<span class="arg-name">costType</span>, <span class="arg-name">cost</span>)<a href="#datahub.metadata.schema_classes.CostClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>costType</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.CostTypeClass"><code>CostTypeClass</code></a>]) – </li><li><strong>cost</strong> (<a href="#datahub.metadata.schema_classes.CostCostClass"><code>CostCostClass</code></a>) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-cost--costcostclass"><em>property</em> cost <em>: <a href="#datahub.metadata.schema_classes.CostCostClass">CostCostClass</a></em><a href="#property-cost--costcostclass" class="hash-link" aria-label="Direct link to property-cost--costcostclass" title="Direct link to property-cost--costcostclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-costtype--str--costtypeclass"><em>property</em> costType <em>: str | <a href="#datahub.metadata.schema_classes.CostTypeClass">CostTypeClass</a></em><a href="#property-costtype--str--costtypeclass" class="hash-link" aria-label="Direct link to property-costtype--str--costtypeclass" title="Direct link to property-costtype--str--costtypeclass"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CostCostClass"><span class="visually-hidden">CostCostClass</span><a href="#datahub.metadata.schema_classes.CostCostClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CostCostClass" title="Direct link to datahub.metadata.schema_classes.CostCostClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CostCostClass</span>(<span class="arg-name">fieldDiscriminator</span>, <span class="arg-name">costId</span> = <span class="arg-default">None</span>, <span class="arg-name">costCode</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.CostCostClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>fieldDiscriminator</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.CostCostDiscriminatorClass"><code>CostCostDiscriminatorClass</code></a>]) – </li><li><strong>costId</strong> (<code>Optional</code>[<code>float</code>]<!-- -->)</li><li><strong>costCode</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-costcode--none--str"><em>property</em> costCode <em>: None | str</em><a href="#property-costcode--none--str" class="hash-link" aria-label="Direct link to property-costcode--none--str" title="Direct link to property-costcode--none--str"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-costid--none--float"><em>property</em> costId <em>: None | float</em><a href="#property-costid--none--float" class="hash-link" aria-label="Direct link to property-costid--none--float" title="Direct link to property-costid--none--float"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fielddiscriminator--str--costcostdiscriminatorclass"><em>property</em> fieldDiscriminator <em>: str | <a href="#datahub.metadata.schema_classes.CostCostDiscriminatorClass">CostCostDiscriminatorClass</a></em><a href="#property-fielddiscriminator--str--costcostdiscriminatorclass" class="hash-link" aria-label="Direct link to property-fielddiscriminator--str--costcostdiscriminatorclass" title="Direct link to property-fielddiscriminator--str--costcostdiscriminatorclass"></a></h4><p>Contains the name of the field that has its value set.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CostCostDiscriminatorClass"><span class="visually-hidden">CostCostDiscriminatorClass</span><a href="#datahub.metadata.schema_classes.CostCostDiscriminatorClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CostCostDiscriminatorClass" title="Direct link to datahub.metadata.schema_classes.CostCostDiscriminatorClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CostCostDiscriminatorClass</span>()<a href="#datahub.metadata.schema_classes.CostCostDiscriminatorClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="costcode--costcode">costCode <em>= 'costCode'</em><a href="#costcode--costcode" class="hash-link" aria-label="Direct link to costcode--costcode" title="Direct link to costcode--costcode"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="costid--costid">costId <em>= 'costId'</em><a href="#costid--costid" class="hash-link" aria-label="Direct link to costid--costid" title="Direct link to costid--costid"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CostTypeClass"><span class="visually-hidden">CostTypeClass</span><a href="#datahub.metadata.schema_classes.CostTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CostTypeClass" title="Direct link to datahub.metadata.schema_classes.CostTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CostTypeClass</span>()<a href="#datahub.metadata.schema_classes.CostTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>Type of Cost Code</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="org_cost_type--org_cost_type">ORG_COST_TYPE <em>= 'ORG_COST_TYPE'</em><a href="#org_cost_type--org_cost_type" class="hash-link" aria-label="Direct link to org_cost_type--org_cost_type" title="Direct link to org_cost_type--org_cost_type"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CriterionClass"><span class="visually-hidden">CriterionClass</span><a href="#datahub.metadata.schema_classes.CriterionClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CriterionClass" title="Direct link to datahub.metadata.schema_classes.CriterionClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CriterionClass</span>(<span class="arg-name">field</span>, <span class="arg-name">value</span>, <span class="arg-name">values</span> = <span class="arg-default">None</span>, <span class="arg-name">condition</span> = <span class="arg-default">None</span>, <span class="arg-name">negated</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.CriterionClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A criterion for matching a field with given value</p><ul><li><strong>Parameters:</strong><ul><li><strong>field</strong> (<code>str</code>)</li><li><strong>value</strong> (<code>str</code>)</li><li><strong>values</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>condition</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.ConditionClass"><code>ConditionClass</code></a>, <code>None</code>]) – </li><li><strong>negated</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-condition--str--conditionclass"><em>property</em> condition <em>: str | <a href="#datahub.metadata.schema_classes.ConditionClass">ConditionClass</a></em><a href="#property-condition--str--conditionclass" class="hash-link" aria-label="Direct link to property-condition--str--conditionclass" title="Direct link to property-condition--str--conditionclass"></a></h4><p>The condition for the criterion, e.g. EQUAL, START_WITH</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-field--str"><em>property</em> field <em>: str</em><a href="#property-field--str" class="hash-link" aria-label="Direct link to property-field--str" title="Direct link to property-field--str"></a></h4><p>The name of the field that the criterion refers to</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-negated--bool"><em>property</em> negated <em>: bool</em><a href="#property-negated--bool" class="hash-link" aria-label="Direct link to property-negated--bool" title="Direct link to property-negated--bool"></a></h4><p>Whether the condition should be negated</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-value--str-1"><em>property</em> value <em>: str</em><a href="#property-value--str-1" class="hash-link" aria-label="Direct link to property-value--str-1" title="Direct link to property-value--str-1"></a></h4><p>The value of the intended field</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-values--liststr"><em>property</em> values <em>: List<!-- -->[str]</em><a href="#property-values--liststr" class="hash-link" aria-label="Direct link to property-values--liststr" title="Direct link to property-values--liststr"></a></h4><p>Values. one of which the intended field should match
|
||
Note, if values is set, the above “value” field will be ignored</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.CustomAssertionInfoClass"><span class="visually-hidden">CustomAssertionInfoClass</span><a href="#datahub.metadata.schema_classes.CustomAssertionInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.CustomAssertionInfoClass" title="Direct link to datahub.metadata.schema_classes.CustomAssertionInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">CustomAssertionInfoClass</span>(<span class="arg-name">type</span>, <span class="arg-name">entity</span>, <span class="arg-name">field</span> = <span class="arg-default">None</span>, <span class="arg-name">logic</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.CustomAssertionInfoClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Attributes that are applicable to Custom Assertions</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>str</code>)</li><li><strong>entity</strong> (<code>str</code>)</li><li><strong>field</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>logic</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-entity--str"><em>property</em> entity <em>: str</em><a href="#property-entity--str" class="hash-link" aria-label="Direct link to property-entity--str" title="Direct link to property-entity--str"></a></h4><p>The entity targeted by this assertion.
|
||
This can have support more entityTypes (e.g. dataJob) in future</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-field--none--str"><em>property</em> field <em>: None | str</em><a href="#property-field--none--str" class="hash-link" aria-label="Direct link to property-field--none--str" title="Direct link to property-field--none--str"></a></h4><p>dataset schema field targeted by this assertion.</p><p>This field is expected to be provided if the assertion is on dataset field</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-logic--none--str"><em>property</em> logic <em>: None | str</em><a href="#property-logic--none--str" class="hash-link" aria-label="Direct link to property-logic--none--str" title="Direct link to property-logic--none--str"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str"><em>property</em> type <em>: str</em><a href="#property-type--str" class="hash-link" aria-label="Direct link to property-type--str" title="Direct link to property-type--str"></a></h4><p>The type of custom assertion.
|
||
This is how your assertion will appear categorized in DataHub UI.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DashboardInfoClass"><span class="visually-hidden">DashboardInfoClass</span><a href="#datahub.metadata.schema_classes.DashboardInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DashboardInfoClass" title="Direct link to datahub.metadata.schema_classes.DashboardInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DashboardInfoClass</span>(<span class="arg-name">title</span>, <span class="arg-name">description</span>, <span class="arg-name">lastModified</span>, <span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">externalUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">charts</span> = <span class="arg-default">None</span>, <span class="arg-name">chartEdges</span> = <span class="arg-default">None</span>, <span class="arg-name">datasets</span> = <span class="arg-default">None</span>, <span class="arg-name">datasetEdges</span> = <span class="arg-default">None</span>, <span class="arg-name">dashboards</span> = <span class="arg-default">None</span>, <span class="arg-name">dashboardUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">access</span> = <span class="arg-default">None</span>, <span class="arg-name">lastRefreshed</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DashboardInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a dashboard</p><ul><li><strong>Parameters:</strong><ul><li><strong>title</strong> (<code>str</code>)</li><li><strong>description</strong> (<code>str</code>)</li><li><strong>lastModified</strong> (<a href="#datahub.metadata.schema_classes.ChangeAuditStampsClass"><code>ChangeAuditStampsClass</code></a>) – </li><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>externalUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>charts</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>chartEdges</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.EdgeClass"><code>EdgeClass</code></a>]]) – </li><li><strong>datasets</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>datasetEdges</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.EdgeClass"><code>EdgeClass</code></a>]]) – </li><li><strong>dashboards</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.EdgeClass"><code>EdgeClass</code></a>]]) – </li><li><strong>dashboardUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>access</strong> (<code>Union</code>[<code>None</code>, <code>str</code>, <a href="#datahub.metadata.schema_classes.AccessLevelClass"><code>AccessLevelClass</code></a>]) – </li><li><strong>lastRefreshed</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-access--none--str--accesslevelclass-1"><em>property</em> access <em>: None | str | <a href="#datahub.metadata.schema_classes.AccessLevelClass">AccessLevelClass</a></em><a href="#property-access--none--str--accesslevelclass-1" class="hash-link" aria-label="Direct link to property-access--none--str--accesslevelclass-1" title="Direct link to property-access--none--str--accesslevelclass-1"></a></h4><p>Access level for the dashboard</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-chartedges--none--listedgeclass"><em>property</em> chartEdges <em>: None | List[<a href="#datahub.metadata.schema_classes.EdgeClass">EdgeClass</a>]</em><a href="#property-chartedges--none--listedgeclass" class="hash-link" aria-label="Direct link to property-chartedges--none--listedgeclass" title="Direct link to property-chartedges--none--listedgeclass"></a></h4><p>Charts in a dashboard</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-charts--liststr"><em>property</em> charts <em>: List<!-- -->[str]</em><a href="#property-charts--liststr" class="hash-link" aria-label="Direct link to property-charts--liststr" title="Direct link to property-charts--liststr"></a></h4><p>Charts in a dashboard
|
||
Deprecated! Use chartEdges instead.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-7"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-7" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-7" title="Direct link to property-customproperties--dictstr-str-7"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-dashboardurl--none--str"><em>property</em> dashboardUrl <em>: None | str</em><a href="#property-dashboardurl--none--str" class="hash-link" aria-label="Direct link to property-dashboardurl--none--str" title="Direct link to property-dashboardurl--none--str"></a></h4><p>URL for the dashboard. This could be used as an external link on DataHub to allow users access/view the dashboard</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-dashboards--listedgeclass"><em>property</em> dashboards <em>: List[<a href="#datahub.metadata.schema_classes.EdgeClass">EdgeClass</a>]</em><a href="#property-dashboards--listedgeclass" class="hash-link" aria-label="Direct link to property-dashboards--listedgeclass" title="Direct link to property-dashboards--listedgeclass"></a></h4><p>Dashboards included by this dashboard.
|
||
Some dashboard entities (e.g. PowerBI Apps) can contain other dashboards.</p><p>The Edge’s sourceUrn should never be set, as it will always be the base dashboard.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-datasetedges--none--listedgeclass"><em>property</em> datasetEdges <em>: None | List[<a href="#datahub.metadata.schema_classes.EdgeClass">EdgeClass</a>]</em><a href="#property-datasetedges--none--listedgeclass" class="hash-link" aria-label="Direct link to property-datasetedges--none--listedgeclass" title="Direct link to property-datasetedges--none--listedgeclass"></a></h4><p>Datasets consumed by a dashboard</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-datasets--liststr"><em>property</em> datasets <em>: List<!-- -->[str]</em><a href="#property-datasets--liststr" class="hash-link" aria-label="Direct link to property-datasets--liststr" title="Direct link to property-datasets--liststr"></a></h4><p>Datasets consumed by a dashboard
|
||
Deprecated! Use datasetEdges instead.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--str-1"><em>property</em> description <em>: str</em><a href="#property-description--str-1" class="hash-link" aria-label="Direct link to property-description--str-1" title="Direct link to property-description--str-1"></a></h4><p>Detailed description about the dashboard</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-externalurl--none--str-5"><em>property</em> externalUrl <em>: None | str</em><a href="#property-externalurl--none--str-5" class="hash-link" aria-label="Direct link to property-externalurl--none--str-5" title="Direct link to property-externalurl--none--str-5"></a></h4><p>URL where the reference exist</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--changeauditstampsclass-1"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.ChangeAuditStampsClass">ChangeAuditStampsClass</a></em><a href="#property-lastmodified--changeauditstampsclass-1" class="hash-link" aria-label="Direct link to property-lastmodified--changeauditstampsclass-1" title="Direct link to property-lastmodified--changeauditstampsclass-1"></a></h4><p>Captures information about who created/last modified/deleted this dashboard and when</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastrefreshed--none--int-1"><em>property</em> lastRefreshed <em>: None | int</em><a href="#property-lastrefreshed--none--int-1" class="hash-link" aria-label="Direct link to property-lastrefreshed--none--int-1" title="Direct link to property-lastrefreshed--none--int-1"></a></h4><p>The time when this dashboard last refreshed</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-title--str-1"><em>property</em> title <em>: str</em><a href="#property-title--str-1" class="hash-link" aria-label="Direct link to property-title--str-1" title="Direct link to property-title--str-1"></a></h4><p>Title of the dashboard</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DashboardKeyClass"><span class="visually-hidden">DashboardKeyClass</span><a href="#datahub.metadata.schema_classes.DashboardKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DashboardKeyClass" title="Direct link to datahub.metadata.schema_classes.DashboardKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DashboardKeyClass</span>(<span class="arg-name">dashboardTool</span>, <span class="arg-name">dashboardId</span>)<a href="#datahub.metadata.schema_classes.DashboardKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Dashboard</p><ul><li><strong>Parameters:</strong><ul><li><strong>dashboardTool</strong> (<code>str</code>)</li><li><strong>dashboardId</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-dashboardid--str"><em>property</em> dashboardId <em>: str</em><a href="#property-dashboardid--str" class="hash-link" aria-label="Direct link to property-dashboardid--str" title="Direct link to property-dashboardid--str"></a></h4><p>Unique id for the dashboard. This id should be globally unique for a dashboarding tool even when there are multiple deployments of it. As an example, dashboard URL could be used here for Looker such as ‘looker.linkedin.com/dashboards/1234’</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-dashboardtool--str-1"><em>property</em> dashboardTool <em>: str</em><a href="#property-dashboardtool--str-1" class="hash-link" aria-label="Direct link to property-dashboardtool--str-1" title="Direct link to property-dashboardtool--str-1"></a></h4><p>The name of the dashboard tool such as looker, redash etc.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DashboardSnapshotClass"><span class="visually-hidden">DashboardSnapshotClass</span><a href="#datahub.metadata.schema_classes.DashboardSnapshotClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DashboardSnapshotClass" title="Direct link to datahub.metadata.schema_classes.DashboardSnapshotClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DashboardSnapshotClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">aspects</span>)<a href="#datahub.metadata.schema_classes.DashboardSnapshotClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A metadata snapshot for a specific Dashboard entity.</p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>aspects</strong> (<code>List</code>[<code>Union</code>[<a href="#datahub.metadata.schema_classes.DashboardKeyClass"><code>DashboardKeyClass</code></a>, <a href="#datahub.metadata.schema_classes.DashboardInfoClass"><code>DashboardInfoClass</code></a>, <a href="#datahub.metadata.schema_classes.EditableDashboardPropertiesClass"><code>EditableDashboardPropertiesClass</code></a>, <a href="#datahub.metadata.schema_classes.OwnershipClass"><code>OwnershipClass</code></a>, <a href="#datahub.metadata.schema_classes.StatusClass"><code>StatusClass</code></a>, <a href="#datahub.metadata.schema_classes.GlobalTagsClass"><code>GlobalTagsClass</code></a>, <a href="#datahub.metadata.schema_classes.BrowsePathsClass"><code>BrowsePathsClass</code></a>, <a href="#datahub.metadata.schema_classes.GlossaryTermsClass"><code>GlossaryTermsClass</code></a>, <a href="#datahub.metadata.schema_classes.InstitutionalMemoryClass"><code>InstitutionalMemoryClass</code></a>, <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass"><code>DataPlatformInstanceClass</code></a>, <a href="#datahub.metadata.schema_classes.BrowsePathsV2Class"><code>BrowsePathsV2Class</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspects--listdashboardkeyclass--dashboardinfoclass--editabledashboardpropertiesclass--ownershipclass--statusclass--globaltagsclass--browsepathsclass--glossarytermsclass--institutionalmemoryclass--dataplatforminstanceclass--browsepathsv2class"><em>property</em> aspects <em>: List[<a href="#datahub.metadata.schema_classes.DashboardKeyClass">DashboardKeyClass</a> | <a href="#datahub.metadata.schema_classes.DashboardInfoClass">DashboardInfoClass</a> | <a href="#datahub.metadata.schema_classes.EditableDashboardPropertiesClass">EditableDashboardPropertiesClass</a> | <a href="#datahub.metadata.schema_classes.OwnershipClass">OwnershipClass</a> | <a href="#datahub.metadata.schema_classes.StatusClass">StatusClass</a> | <a href="#datahub.metadata.schema_classes.GlobalTagsClass">GlobalTagsClass</a> | <a href="#datahub.metadata.schema_classes.BrowsePathsClass">BrowsePathsClass</a> | <a href="#datahub.metadata.schema_classes.GlossaryTermsClass">GlossaryTermsClass</a> | <a href="#datahub.metadata.schema_classes.InstitutionalMemoryClass">InstitutionalMemoryClass</a> | <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass">DataPlatformInstanceClass</a> | <a href="#datahub.metadata.schema_classes.BrowsePathsV2Class">BrowsePathsV2Class</a>]</em><a href="#property-aspects--listdashboardkeyclass--dashboardinfoclass--editabledashboardpropertiesclass--ownershipclass--statusclass--globaltagsclass--browsepathsclass--glossarytermsclass--institutionalmemoryclass--dataplatforminstanceclass--browsepathsv2class" class="hash-link" aria-label="Direct link to property-aspects--listdashboardkeyclass--dashboardinfoclass--editabledashboardpropertiesclass--ownershipclass--statusclass--globaltagsclass--browsepathsclass--glossarytermsclass--institutionalmemoryclass--dataplatforminstanceclass--browsepathsv2class" title="Direct link to property-aspects--listdashboardkeyclass--dashboardinfoclass--editabledashboardpropertiesclass--ownershipclass--statusclass--globaltagsclass--browsepathsclass--glossarytermsclass--institutionalmemoryclass--dataplatforminstanceclass--browsepathsv2class"></a></h4><p>The list of metadata aspects associated with the dashboard. Depending on the use case, this can either be all, or a selection, of supported aspects.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-3"><em>property</em> urn <em>: str</em><a href="#property-urn--str-3" class="hash-link" aria-label="Direct link to property-urn--str-3" title="Direct link to property-urn--str-3"></a></h4><p>URN for the entity the metadata snapshot is associated with.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DashboardUsageStatisticsClass"><span class="visually-hidden">DashboardUsageStatisticsClass</span><a href="#datahub.metadata.schema_classes.DashboardUsageStatisticsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DashboardUsageStatisticsClass" title="Direct link to datahub.metadata.schema_classes.DashboardUsageStatisticsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DashboardUsageStatisticsClass</span>(<span class="arg-name">timestampMillis</span>, <span class="arg-name">eventGranularity</span> = <span class="arg-default">None</span>, <span class="arg-name">partitionSpec</span> = <span class="arg-default">None</span>, <span class="arg-name">messageId</span> = <span class="arg-default">None</span>, <span class="arg-name">viewsCount</span> = <span class="arg-default">None</span>, <span class="arg-name">executionsCount</span> = <span class="arg-default">None</span>, <span class="arg-name">uniqueUserCount</span> = <span class="arg-default">None</span>, <span class="arg-name">userCounts</span> = <span class="arg-default">None</span>, <span class="arg-name">favoritesCount</span> = <span class="arg-default">None</span>, <span class="arg-name">lastViewedAt</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DashboardUsageStatisticsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Experimental (Subject to breaking change) – Stats corresponding to dashboard’s usage.</p><p>If this aspect represents the latest snapshot of the statistics about a Dashboard, the eventGranularity field should be null.
|
||
If this aspect represents a bucketed window of usage statistics (e.g. over a day), then the eventGranularity field should be set accordingly.</p><ul><li><strong>Parameters:</strong><ul><li><strong>timestampMillis</strong> (<code>int</code>)</li><li><strong>eventGranularity</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeWindowSizeClass"><code>TimeWindowSizeClass</code></a>]) – </li><li><strong>partitionSpec</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.PartitionSpecClass"><code>PartitionSpecClass</code></a>]) – </li><li><strong>messageId</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>viewsCount</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>executionsCount</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>uniqueUserCount</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>userCounts</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.DashboardUserUsageCountsClass"><code>DashboardUserUsageCountsClass</code></a>]]) – </li><li><strong>favoritesCount</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>lastViewedAt</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="aspect_type--classvarstr--timeseries-2">ASPECT_TYPE <em>: <code>ClassVar</code>[<code>str</code>]</em> <em>= 'timeseries'</em><a href="#aspect_type--classvarstr--timeseries-2" class="hash-link" aria-label="Direct link to aspect_type--classvarstr--timeseries-2" title="Direct link to aspect_type--classvarstr--timeseries-2"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-eventgranularity--none--timewindowsizeclass-2"><em>property</em> eventGranularity <em>: None | <a href="#datahub.metadata.schema_classes.TimeWindowSizeClass">TimeWindowSizeClass</a></em><a href="#property-eventgranularity--none--timewindowsizeclass-2" class="hash-link" aria-label="Direct link to property-eventgranularity--none--timewindowsizeclass-2" title="Direct link to property-eventgranularity--none--timewindowsizeclass-2"></a></h4><p>Granularity of the event if applicable</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-executionscount--none--int"><em>property</em> executionsCount <em>: None | int</em><a href="#property-executionscount--none--int" class="hash-link" aria-label="Direct link to property-executionscount--none--int" title="Direct link to property-executionscount--none--int"></a></h4><p>The total number of dashboard executions (refreshes / syncs)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-favoritescount--none--int"><em>property</em> favoritesCount <em>: None | int</em><a href="#property-favoritescount--none--int" class="hash-link" aria-label="Direct link to property-favoritescount--none--int" title="Direct link to property-favoritescount--none--int"></a></h4><p>The total number of times that the dashboard has been favorited</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastviewedat--none--int"><em>property</em> lastViewedAt <em>: None | int</em><a href="#property-lastviewedat--none--int" class="hash-link" aria-label="Direct link to property-lastviewedat--none--int" title="Direct link to property-lastviewedat--none--int"></a></h4><p>Last viewed at</p><p>This should not be set in cases where statistics are windowed.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-messageid--none--str-2"><em>property</em> messageId <em>: None | str</em><a href="#property-messageid--none--str-2" class="hash-link" aria-label="Direct link to property-messageid--none--str-2" title="Direct link to property-messageid--none--str-2"></a></h4><p>The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-partitionspec--partitionspecclass--none-2"><em>property</em> partitionSpec <em>: <a href="#datahub.metadata.schema_classes.PartitionSpecClass">PartitionSpecClass</a> | None</em><a href="#property-partitionspec--partitionspecclass--none-2" class="hash-link" aria-label="Direct link to property-partitionspec--partitionspecclass--none-2" title="Direct link to property-partitionspec--partitionspecclass--none-2"></a></h4><p>The optional partition specification.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-timestampmillis--int-2"><em>property</em> timestampMillis <em>: int</em><a href="#property-timestampmillis--int-2" class="hash-link" aria-label="Direct link to property-timestampmillis--int-2" title="Direct link to property-timestampmillis--int-2"></a></h4><p>The event timestamp field as epoch at UTC in milli seconds.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-uniqueusercount--none--int-1"><em>property</em> uniqueUserCount <em>: None | int</em><a href="#property-uniqueusercount--none--int-1" class="hash-link" aria-label="Direct link to property-uniqueusercount--none--int-1" title="Direct link to property-uniqueusercount--none--int-1"></a></h4><p>Unique user count</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-usercounts--none--listdashboarduserusagecountsclass"><em>property</em> userCounts <em>: None | List[<a href="#datahub.metadata.schema_classes.DashboardUserUsageCountsClass">DashboardUserUsageCountsClass</a>]</em><a href="#property-usercounts--none--listdashboarduserusagecountsclass" class="hash-link" aria-label="Direct link to property-usercounts--none--listdashboarduserusagecountsclass" title="Direct link to property-usercounts--none--listdashboarduserusagecountsclass"></a></h4><p>Users within this bucket, with frequency counts</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-viewscount--none--int-2"><em>property</em> viewsCount <em>: None | int</em><a href="#property-viewscount--none--int-2" class="hash-link" aria-label="Direct link to property-viewscount--none--int-2" title="Direct link to property-viewscount--none--int-2"></a></h4><p>The total number of times dashboard has been viewed</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DashboardUserUsageCountsClass"><span class="visually-hidden">DashboardUserUsageCountsClass</span><a href="#datahub.metadata.schema_classes.DashboardUserUsageCountsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DashboardUserUsageCountsClass" title="Direct link to datahub.metadata.schema_classes.DashboardUserUsageCountsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DashboardUserUsageCountsClass</span>(<span class="arg-name">user</span>, <span class="arg-name">viewsCount</span> = <span class="arg-default">None</span>, <span class="arg-name">executionsCount</span> = <span class="arg-default">None</span>, <span class="arg-name">usageCount</span> = <span class="arg-default">None</span>, <span class="arg-name">userEmail</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DashboardUserUsageCountsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Records a single user’s usage counts for a given resource</p><ul><li><strong>Parameters:</strong><ul><li><strong>user</strong> (<code>str</code>)</li><li><strong>viewsCount</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>executionsCount</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>usageCount</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>userEmail</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-executionscount--none--int-1"><em>property</em> executionsCount <em>: None | int</em><a href="#property-executionscount--none--int-1" class="hash-link" aria-label="Direct link to property-executionscount--none--int-1" title="Direct link to property-executionscount--none--int-1"></a></h4><p>The number of times the user has executed (refreshed) the dashboard</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-usagecount--none--int"><em>property</em> usageCount <em>: None | int</em><a href="#property-usagecount--none--int" class="hash-link" aria-label="Direct link to property-usagecount--none--int" title="Direct link to property-usagecount--none--int"></a></h4><p>Normalized numeric metric representing user’s dashboard usage – the number of times the user executed or viewed the dashboard.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-user--str-1"><em>property</em> user <em>: str</em><a href="#property-user--str-1" class="hash-link" aria-label="Direct link to property-user--str-1" title="Direct link to property-user--str-1"></a></h4><p>The unique id of the user.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-useremail--none--str"><em>property</em> userEmail <em>: None | str</em><a href="#property-useremail--none--str" class="hash-link" aria-label="Direct link to property-useremail--none--str" title="Direct link to property-useremail--none--str"></a></h4><p>If user_email is set, we attempt to resolve the user’s urn upon ingest</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-viewscount--none--int-3"><em>property</em> viewsCount <em>: None | int</em><a href="#property-viewscount--none--int-3" class="hash-link" aria-label="Direct link to property-viewscount--none--int-3" title="Direct link to property-viewscount--none--int-3"></a></h4><p>The number of times the user has viewed the dashboard</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataContractKeyClass"><span class="visually-hidden">DataContractKeyClass</span><a href="#datahub.metadata.schema_classes.DataContractKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataContractKeyClass" title="Direct link to datahub.metadata.schema_classes.DataContractKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataContractKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.DataContractKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Data Contract</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-3"><em>property</em> id <em>: str</em><a href="#property-id--str-3" class="hash-link" aria-label="Direct link to property-id--str-3" title="Direct link to property-id--str-3"></a></h4><p>Unique id for the contract</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataContractPropertiesClass"><span class="visually-hidden">DataContractPropertiesClass</span><a href="#datahub.metadata.schema_classes.DataContractPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataContractPropertiesClass" title="Direct link to datahub.metadata.schema_classes.DataContractPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataContractPropertiesClass</span>(<span class="arg-name">entity</span>, <span class="arg-name">schema</span> = <span class="arg-default">None</span>, <span class="arg-name">freshness</span> = <span class="arg-default">None</span>, <span class="arg-name">dataQuality</span> = <span class="arg-default">None</span>, <span class="arg-name">rawContract</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataContractPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a data contract</p><ul><li><strong>Parameters:</strong><ul><li><strong>entity</strong> (<code>str</code>)</li><li><strong>schema</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.SchemaContractClass"><code>SchemaContractClass</code></a>]]) – </li><li><strong>freshness</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.FreshnessContractClass"><code>FreshnessContractClass</code></a>]]) – </li><li><strong>dataQuality</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.DataQualityContractClass"><code>DataQualityContractClass</code></a>]]) – </li><li><strong>rawContract</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-dataquality--none--listdataqualitycontractclass"><em>property</em> dataQuality <em>: None | List[<a href="#datahub.metadata.schema_classes.DataQualityContractClass">DataQualityContractClass</a>]</em><a href="#property-dataquality--none--listdataqualitycontractclass" class="hash-link" aria-label="Direct link to property-dataquality--none--listdataqualitycontractclass" title="Direct link to property-dataquality--none--listdataqualitycontractclass"></a></h4><p>An optional set of Data Quality contracts, e.g. table and column level contract constraints.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-entity--str-1"><em>property</em> entity <em>: str</em><a href="#property-entity--str-1" class="hash-link" aria-label="Direct link to property-entity--str-1" title="Direct link to property-entity--str-1"></a></h4><p>The entity that this contract is associated with. Currently, we only support Dataset contracts, but
|
||
in the future we may also support Data Product level contracts.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-freshness--none--listfreshnesscontractclass"><em>property</em> freshness <em>: None | List[<a href="#datahub.metadata.schema_classes.FreshnessContractClass">FreshnessContractClass</a>]</em><a href="#property-freshness--none--listfreshnesscontractclass" class="hash-link" aria-label="Direct link to property-freshness--none--listfreshnesscontractclass" title="Direct link to property-freshness--none--listfreshnesscontractclass"></a></h4><p>An optional set of FRESHNESS contracts. If this is a dataset contract, there will only be one.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-rawcontract--none--str"><em>property</em> rawContract <em>: None | str</em><a href="#property-rawcontract--none--str" class="hash-link" aria-label="Direct link to property-rawcontract--none--str" title="Direct link to property-rawcontract--none--str"></a></h4><p>YAML-formatted contract definition</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-schema--none--listschemacontractclass"><em>property</em> schema <em>: None | List[<a href="#datahub.metadata.schema_classes.SchemaContractClass">SchemaContractClass</a>]</em><a href="#property-schema--none--listschemacontractclass" class="hash-link" aria-label="Direct link to property-schema--none--listschemacontractclass" title="Direct link to property-schema--none--listschemacontractclass"></a></h4><p>An optional set of schema contracts. If this is a dataset contract, there will only be one.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataContractStateClass"><span class="visually-hidden">DataContractStateClass</span><a href="#datahub.metadata.schema_classes.DataContractStateClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataContractStateClass" title="Direct link to datahub.metadata.schema_classes.DataContractStateClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataContractStateClass</span>()<a href="#datahub.metadata.schema_classes.DataContractStateClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="active--active">ACTIVE <em>= 'ACTIVE'</em><a href="#active--active" class="hash-link" aria-label="Direct link to active--active" title="Direct link to active--active"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="pending--pending">PENDING <em>= 'PENDING'</em><a href="#pending--pending" class="hash-link" aria-label="Direct link to pending--pending" title="Direct link to pending--pending"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataContractStatusClass"><span class="visually-hidden">DataContractStatusClass</span><a href="#datahub.metadata.schema_classes.DataContractStatusClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataContractStatusClass" title="Direct link to datahub.metadata.schema_classes.DataContractStatusClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataContractStatusClass</span>(<span class="arg-name">state</span>, <span class="arg-name">customProperties</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataContractStatusClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about the status of a data contract</p><ul><li><strong>Parameters:</strong><ul><li><strong>state</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.DataContractStateClass"><code>DataContractStateClass</code></a>]) – </li><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-8"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-8" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-8" title="Direct link to property-customproperties--dictstr-str-8"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-state--str--datacontractstateclass"><em>property</em> state <em>: str | <a href="#datahub.metadata.schema_classes.DataContractStateClass">DataContractStateClass</a></em><a href="#property-state--str--datacontractstateclass" class="hash-link" aria-label="Direct link to property-state--str--datacontractstateclass" title="Direct link to property-state--str--datacontractstateclass"></a></h4><p>The latest state of the data contract</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataFlowInfoClass"><span class="visually-hidden">DataFlowInfoClass</span><a href="#datahub.metadata.schema_classes.DataFlowInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataFlowInfoClass" title="Direct link to datahub.metadata.schema_classes.DataFlowInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataFlowInfoClass</span>(<span class="arg-name">name</span>, <span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">externalUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">project</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>, <span class="arg-name">env</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataFlowInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a Data processing flow</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>externalUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>project</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeStampClass"><code>TimeStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeStampClass"><code>TimeStampClass</code></a>]) – </li><li><strong>env</strong> (<code>Union</code>[<code>None</code>, <code>str</code>, <a href="#datahub.metadata.schema_classes.FabricTypeClass"><code>FabricTypeClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--none--timestampclass-1"><em>property</em> created <em>: None | <a href="#datahub.metadata.schema_classes.TimeStampClass">TimeStampClass</a></em><a href="#property-created--none--timestampclass-1" class="hash-link" aria-label="Direct link to property-created--none--timestampclass-1" title="Direct link to property-created--none--timestampclass-1"></a></h4><p>A timestamp documenting when the asset was created in the source Data Platform (not on DataHub)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-9"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-9" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-9" title="Direct link to property-customproperties--dictstr-str-9"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-6"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-6" class="hash-link" aria-label="Direct link to property-description--none--str-6" title="Direct link to property-description--none--str-6"></a></h4><p>Flow description</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-env--none--str--fabrictypeclass-1"><em>property</em> env <em>: None | str | <a href="#datahub.metadata.schema_classes.FabricTypeClass">FabricTypeClass</a></em><a href="#property-env--none--str--fabrictypeclass-1" class="hash-link" aria-label="Direct link to property-env--none--str--fabrictypeclass-1" title="Direct link to property-env--none--str--fabrictypeclass-1"></a></h4><p>Environment for this flow</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-externalurl--none--str-6"><em>property</em> externalUrl <em>: None | str</em><a href="#property-externalurl--none--str-6" class="hash-link" aria-label="Direct link to property-externalurl--none--str-6" title="Direct link to property-externalurl--none--str-6"></a></h4><p>URL where the reference exist</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--none--timestampclass-1"><em>property</em> lastModified <em>: None | <a href="#datahub.metadata.schema_classes.TimeStampClass">TimeStampClass</a></em><a href="#property-lastmodified--none--timestampclass-1" class="hash-link" aria-label="Direct link to property-lastmodified--none--timestampclass-1" title="Direct link to property-lastmodified--none--timestampclass-1"></a></h4><p>A timestamp documenting when the asset was last modified in the source Data Platform (not on DataHub)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-3"><em>property</em> name <em>: str</em><a href="#property-name--str-3" class="hash-link" aria-label="Direct link to property-name--str-3" title="Direct link to property-name--str-3"></a></h4><p>Flow name</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-project--none--str"><em>property</em> project <em>: None | str</em><a href="#property-project--none--str" class="hash-link" aria-label="Direct link to property-project--none--str" title="Direct link to property-project--none--str"></a></h4><p>Optional project/namespace associated with the flow</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataFlowKeyClass"><span class="visually-hidden">DataFlowKeyClass</span><a href="#datahub.metadata.schema_classes.DataFlowKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataFlowKeyClass" title="Direct link to datahub.metadata.schema_classes.DataFlowKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataFlowKeyClass</span>(<span class="arg-name">orchestrator</span>, <span class="arg-name">flowId</span>, <span class="arg-name">cluster</span>)<a href="#datahub.metadata.schema_classes.DataFlowKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Data Flow</p><ul><li><strong>Parameters:</strong><ul><li><strong>orchestrator</strong> (<code>str</code>)</li><li><strong>flowId</strong> (<code>str</code>)</li><li><strong>cluster</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-cluster--str"><em>property</em> cluster <em>: str</em><a href="#property-cluster--str" class="hash-link" aria-label="Direct link to property-cluster--str" title="Direct link to property-cluster--str"></a></h4><p>Cluster where the flow is executed</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-flowid--str"><em>property</em> flowId <em>: str</em><a href="#property-flowid--str" class="hash-link" aria-label="Direct link to property-flowid--str" title="Direct link to property-flowid--str"></a></h4><p>Unique Identifier of the data flow</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-orchestrator--str"><em>property</em> orchestrator <em>: str</em><a href="#property-orchestrator--str" class="hash-link" aria-label="Direct link to property-orchestrator--str" title="Direct link to property-orchestrator--str"></a></h4><p>Workflow manager like azkaban, airflow which orchestrates the flow</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataFlowSnapshotClass"><span class="visually-hidden">DataFlowSnapshotClass</span><a href="#datahub.metadata.schema_classes.DataFlowSnapshotClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataFlowSnapshotClass" title="Direct link to datahub.metadata.schema_classes.DataFlowSnapshotClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataFlowSnapshotClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">aspects</span>)<a href="#datahub.metadata.schema_classes.DataFlowSnapshotClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A metadata snapshot for a specific DataFlow entity.</p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>aspects</strong> (<code>List</code>[<code>Union</code>[<a href="#datahub.metadata.schema_classes.DataFlowKeyClass"><code>DataFlowKeyClass</code></a>, <a href="#datahub.metadata.schema_classes.DataFlowInfoClass"><code>DataFlowInfoClass</code></a>, <a href="#datahub.metadata.schema_classes.EditableDataFlowPropertiesClass"><code>EditableDataFlowPropertiesClass</code></a>, <a href="#datahub.metadata.schema_classes.OwnershipClass"><code>OwnershipClass</code></a>, <a href="#datahub.metadata.schema_classes.StatusClass"><code>StatusClass</code></a>, <a href="#datahub.metadata.schema_classes.GlobalTagsClass"><code>GlobalTagsClass</code></a>, <a href="#datahub.metadata.schema_classes.BrowsePathsClass"><code>BrowsePathsClass</code></a>, <a href="#datahub.metadata.schema_classes.GlossaryTermsClass"><code>GlossaryTermsClass</code></a>, <a href="#datahub.metadata.schema_classes.InstitutionalMemoryClass"><code>InstitutionalMemoryClass</code></a>, <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass"><code>DataPlatformInstanceClass</code></a>, <a href="#datahub.metadata.schema_classes.BrowsePathsV2Class"><code>BrowsePathsV2Class</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspects--listdataflowkeyclass--dataflowinfoclass--editabledataflowpropertiesclass--ownershipclass--statusclass--globaltagsclass--browsepathsclass--glossarytermsclass--institutionalmemoryclass--dataplatforminstanceclass--browsepathsv2class"><em>property</em> aspects <em>: List[<a href="#datahub.metadata.schema_classes.DataFlowKeyClass">DataFlowKeyClass</a> | <a href="#datahub.metadata.schema_classes.DataFlowInfoClass">DataFlowInfoClass</a> | <a href="#datahub.metadata.schema_classes.EditableDataFlowPropertiesClass">EditableDataFlowPropertiesClass</a> | <a href="#datahub.metadata.schema_classes.OwnershipClass">OwnershipClass</a> | <a href="#datahub.metadata.schema_classes.StatusClass">StatusClass</a> | <a href="#datahub.metadata.schema_classes.GlobalTagsClass">GlobalTagsClass</a> | <a href="#datahub.metadata.schema_classes.BrowsePathsClass">BrowsePathsClass</a> | <a href="#datahub.metadata.schema_classes.GlossaryTermsClass">GlossaryTermsClass</a> | <a href="#datahub.metadata.schema_classes.InstitutionalMemoryClass">InstitutionalMemoryClass</a> | <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass">DataPlatformInstanceClass</a> | <a href="#datahub.metadata.schema_classes.BrowsePathsV2Class">BrowsePathsV2Class</a>]</em><a href="#property-aspects--listdataflowkeyclass--dataflowinfoclass--editabledataflowpropertiesclass--ownershipclass--statusclass--globaltagsclass--browsepathsclass--glossarytermsclass--institutionalmemoryclass--dataplatforminstanceclass--browsepathsv2class" class="hash-link" aria-label="Direct link to property-aspects--listdataflowkeyclass--dataflowinfoclass--editabledataflowpropertiesclass--ownershipclass--statusclass--globaltagsclass--browsepathsclass--glossarytermsclass--institutionalmemoryclass--dataplatforminstanceclass--browsepathsv2class" title="Direct link to property-aspects--listdataflowkeyclass--dataflowinfoclass--editabledataflowpropertiesclass--ownershipclass--statusclass--globaltagsclass--browsepathsclass--glossarytermsclass--institutionalmemoryclass--dataplatforminstanceclass--browsepathsv2class"></a></h4><p>The list of metadata aspects associated with the data flow. Depending on the use case, this can either be all, or a selection, of supported aspects.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-4"><em>property</em> urn <em>: str</em><a href="#property-urn--str-4" class="hash-link" aria-label="Direct link to property-urn--str-4" title="Direct link to property-urn--str-4"></a></h4><p>URN for the entity the metadata snapshot is associated with.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubAccessTokenInfoClass"><span class="visually-hidden">DataHubAccessTokenInfoClass</span><a href="#datahub.metadata.schema_classes.DataHubAccessTokenInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubAccessTokenInfoClass" title="Direct link to datahub.metadata.schema_classes.DataHubAccessTokenInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubAccessTokenInfoClass</span>(<span class="arg-name">name</span>, <span class="arg-name">actorUrn</span>, <span class="arg-name">ownerUrn</span>, <span class="arg-name">createdAt</span>, <span class="arg-name">expiresAt</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataHubAccessTokenInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a DataHub Access Token</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>actorUrn</strong> (<code>str</code>)</li><li><strong>ownerUrn</strong> (<code>str</code>)</li><li><strong>createdAt</strong> (<code>int</code>)</li><li><strong>expiresAt</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-actorurn--str"><em>property</em> actorUrn <em>: str</em><a href="#property-actorurn--str" class="hash-link" aria-label="Direct link to property-actorurn--str" title="Direct link to property-actorurn--str"></a></h4><p>Urn of the actor to which this access token belongs to.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-createdat--int"><em>property</em> createdAt <em>: int</em><a href="#property-createdat--int" class="hash-link" aria-label="Direct link to property-createdat--int" title="Direct link to property-createdat--int"></a></h4><p>When the token was created.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-7"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-7" class="hash-link" aria-label="Direct link to property-description--none--str-7" title="Direct link to property-description--none--str-7"></a></h4><p>Description of the token if defined.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-expiresat--none--int"><em>property</em> expiresAt <em>: None | int</em><a href="#property-expiresat--none--int" class="hash-link" aria-label="Direct link to property-expiresat--none--int" title="Direct link to property-expiresat--none--int"></a></h4><p>When the token expires.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-4"><em>property</em> name <em>: str</em><a href="#property-name--str-4" class="hash-link" aria-label="Direct link to property-name--str-4" title="Direct link to property-name--str-4"></a></h4><p>User defined name for the access token if defined.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-ownerurn--str"><em>property</em> ownerUrn <em>: str</em><a href="#property-ownerurn--str" class="hash-link" aria-label="Direct link to property-ownerurn--str" title="Direct link to property-ownerurn--str"></a></h4><p>Urn of the actor which created this access token.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubAccessTokenKeyClass"><span class="visually-hidden">DataHubAccessTokenKeyClass</span><a href="#datahub.metadata.schema_classes.DataHubAccessTokenKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubAccessTokenKeyClass" title="Direct link to datahub.metadata.schema_classes.DataHubAccessTokenKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubAccessTokenKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.DataHubAccessTokenKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a DataHub Access Token</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-4"><em>property</em> id <em>: str</em><a href="#property-id--str-4" class="hash-link" aria-label="Direct link to property-id--str-4" title="Direct link to property-id--str-4"></a></h4><p>Access token’s SHA-256 hashed JWT signature</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubActionKeyClass"><span class="visually-hidden">DataHubActionKeyClass</span><a href="#datahub.metadata.schema_classes.DataHubActionKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubActionKeyClass" title="Direct link to datahub.metadata.schema_classes.DataHubActionKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubActionKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.DataHubActionKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a DataHub Action Pipeline</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-5"><em>property</em> id <em>: str</em><a href="#property-id--str-5" class="hash-link" aria-label="Direct link to property-id--str-5" title="Direct link to property-id--str-5"></a></h4><p>A unique id for the Action, either generated or provided</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubActorFilterClass"><span class="visually-hidden">DataHubActorFilterClass</span><a href="#datahub.metadata.schema_classes.DataHubActorFilterClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubActorFilterClass" title="Direct link to datahub.metadata.schema_classes.DataHubActorFilterClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubActorFilterClass</span>(<span class="arg-name">users</span> = <span class="arg-default">None</span>, <span class="arg-name">groups</span> = <span class="arg-default">None</span>, <span class="arg-name">resourceOwners</span> = <span class="arg-default">None</span>, <span class="arg-name">resourceOwnersTypes</span> = <span class="arg-default">None</span>, <span class="arg-name">allUsers</span> = <span class="arg-default">None</span>, <span class="arg-name">allGroups</span> = <span class="arg-default">None</span>, <span class="arg-name">roles</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataHubActorFilterClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Information used to filter DataHub actors.</p><ul><li><strong>Parameters:</strong><ul><li><strong>users</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>groups</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>resourceOwners</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>resourceOwnersTypes</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>allUsers</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>allGroups</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>roles</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-allgroups--bool"><em>property</em> allGroups <em>: bool</em><a href="#property-allgroups--bool" class="hash-link" aria-label="Direct link to property-allgroups--bool" title="Direct link to property-allgroups--bool"></a></h4><p>Whether the filter should apply to all groups.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-allusers--bool"><em>property</em> allUsers <em>: bool</em><a href="#property-allusers--bool" class="hash-link" aria-label="Direct link to property-allusers--bool" title="Direct link to property-allusers--bool"></a></h4><p>Whether the filter should apply to all users.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-groups--none--liststr"><em>property</em> groups <em>: None | List<!-- -->[str]</em><a href="#property-groups--none--liststr" class="hash-link" aria-label="Direct link to property-groups--none--liststr" title="Direct link to property-groups--none--liststr"></a></h4><p>A specific set of groups to apply the policy to (disjunctive)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-resourceowners--bool"><em>property</em> resourceOwners <em>: bool</em><a href="#property-resourceowners--bool" class="hash-link" aria-label="Direct link to property-resourceowners--bool" title="Direct link to property-resourceowners--bool"></a></h4><p>Whether the filter should return true for owners of a particular resource.
|
||
Only applies to policies of type ‘Metadata’, which have a resource associated with them.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-resourceownerstypes--none--liststr"><em>property</em> resourceOwnersTypes <em>: None | List<!-- -->[str]</em><a href="#property-resourceownerstypes--none--liststr" class="hash-link" aria-label="Direct link to property-resourceownerstypes--none--liststr" title="Direct link to property-resourceownerstypes--none--liststr"></a></h4><p>Define type of ownership for the policy</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-roles--none--liststr"><em>property</em> roles <em>: None | List<!-- -->[str]</em><a href="#property-roles--none--liststr" class="hash-link" aria-label="Direct link to property-roles--none--liststr" title="Direct link to property-roles--none--liststr"></a></h4><p>A specific set of roles to apply the policy to (disjunctive).</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-users--none--liststr"><em>property</em> users <em>: None | List<!-- -->[str]</em><a href="#property-users--none--liststr" class="hash-link" aria-label="Direct link to property-users--none--liststr" title="Direct link to property-users--none--liststr"></a></h4><p>A specific set of users to apply the policy to (disjunctive)</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubConnectionDetailsClass"><span class="visually-hidden">DataHubConnectionDetailsClass</span><a href="#datahub.metadata.schema_classes.DataHubConnectionDetailsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubConnectionDetailsClass" title="Direct link to datahub.metadata.schema_classes.DataHubConnectionDetailsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubConnectionDetailsClass</span>(<span class="arg-name">type</span>, <span class="arg-name">name</span> = <span class="arg-default">None</span>, <span class="arg-name">json</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataHubConnectionDetailsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a connection to an external platform.</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.DataHubConnectionDetailsTypeClass"><code>DataHubConnectionDetailsTypeClass</code></a>]) – </li><li><strong>name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>json</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.DataHubJsonConnectionClass"><code>DataHubJsonConnectionClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-json--none--datahubjsonconnectionclass"><em>property</em> json <em>: None | <a href="#datahub.metadata.schema_classes.DataHubJsonConnectionClass">DataHubJsonConnectionClass</a></em><a href="#property-json--none--datahubjsonconnectionclass" class="hash-link" aria-label="Direct link to property-json--none--datahubjsonconnectionclass" title="Direct link to property-json--none--datahubjsonconnectionclass"></a></h4><p>An JSON payload containing raw connection details.
|
||
This will be present if the type is JSON.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--none--str-1"><em>property</em> name <em>: None | str</em><a href="#property-name--none--str-1" class="hash-link" aria-label="Direct link to property-name--none--str-1" title="Direct link to property-name--none--str-1"></a></h4><p>Display name of the connection</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--datahubconnectiondetailstypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.DataHubConnectionDetailsTypeClass">DataHubConnectionDetailsTypeClass</a></em><a href="#property-type--str--datahubconnectiondetailstypeclass" class="hash-link" aria-label="Direct link to property-type--str--datahubconnectiondetailstypeclass" title="Direct link to property-type--str--datahubconnectiondetailstypeclass"></a></h4><p>The type of the connection. This defines the schema / encoding of the connection details.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubConnectionDetailsTypeClass"><span class="visually-hidden">DataHubConnectionDetailsTypeClass</span><a href="#datahub.metadata.schema_classes.DataHubConnectionDetailsTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubConnectionDetailsTypeClass" title="Direct link to datahub.metadata.schema_classes.DataHubConnectionDetailsTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubConnectionDetailsTypeClass</span>()<a href="#datahub.metadata.schema_classes.DataHubConnectionDetailsTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="json--json">JSON <em>= 'JSON'</em><a href="#json--json" class="hash-link" aria-label="Direct link to json--json" title="Direct link to json--json"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubConnectionKeyClass"><span class="visually-hidden">DataHubConnectionKeyClass</span><a href="#datahub.metadata.schema_classes.DataHubConnectionKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubConnectionKeyClass" title="Direct link to datahub.metadata.schema_classes.DataHubConnectionKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubConnectionKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.DataHubConnectionKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Connection</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-6"><em>property</em> id <em>: str</em><a href="#property-id--str-6" class="hash-link" aria-label="Direct link to property-id--str-6" title="Direct link to property-id--str-6"></a></h4><p>A unique identifier for the connection.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubIngestionSourceConfigClass"><span class="visually-hidden">DataHubIngestionSourceConfigClass</span><a href="#datahub.metadata.schema_classes.DataHubIngestionSourceConfigClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubIngestionSourceConfigClass" title="Direct link to datahub.metadata.schema_classes.DataHubIngestionSourceConfigClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubIngestionSourceConfigClass</span>(<span class="arg-name">recipe</span>, <span class="arg-name">version</span> = <span class="arg-default">None</span>, <span class="arg-name">executorId</span> = <span class="arg-default">None</span>, <span class="arg-name">debugMode</span> = <span class="arg-default">None</span>, <span class="arg-name">extraArgs</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataHubIngestionSourceConfigClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>recipe</strong> (<code>str</code>)</li><li><strong>version</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>executorId</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>debugMode</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>extraArgs</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-debugmode--none--bool"><em>property</em> debugMode <em>: None | bool</em><a href="#property-debugmode--none--bool" class="hash-link" aria-label="Direct link to property-debugmode--none--bool" title="Direct link to property-debugmode--none--bool"></a></h4><p>Whether or not to run this ingestion source in debug mode</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-executorid--none--str"><em>property</em> executorId <em>: None | str</em><a href="#property-executorid--none--str" class="hash-link" aria-label="Direct link to property-executorid--none--str" title="Direct link to property-executorid--none--str"></a></h4><p>The id of the executor to use to execute the ingestion run</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-extraargs--none--dictstr-str"><em>property</em> extraArgs <em>: None | Dict<!-- -->[str, str]</em><a href="#property-extraargs--none--dictstr-str" class="hash-link" aria-label="Direct link to property-extraargs--none--dictstr-str" title="Direct link to property-extraargs--none--dictstr-str"></a></h4><p>Extra arguments for the ingestion run.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-recipe--str"><em>property</em> recipe <em>: str</em><a href="#property-recipe--str" class="hash-link" aria-label="Direct link to property-recipe--str" title="Direct link to property-recipe--str"></a></h4><p>The JSON recipe to use for ingestion</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-version--none--str"><em>property</em> version <em>: None | str</em><a href="#property-version--none--str" class="hash-link" aria-label="Direct link to property-version--none--str" title="Direct link to property-version--none--str"></a></h4><p>The PyPI version of the datahub CLI to use when executing a recipe</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubIngestionSourceInfoClass"><span class="visually-hidden">DataHubIngestionSourceInfoClass</span><a href="#datahub.metadata.schema_classes.DataHubIngestionSourceInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubIngestionSourceInfoClass" title="Direct link to datahub.metadata.schema_classes.DataHubIngestionSourceInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubIngestionSourceInfoClass</span>(<span class="arg-name">name</span>, <span class="arg-name">type</span>, <span class="arg-name">config</span>, <span class="arg-name">platform</span> = <span class="arg-default">None</span>, <span class="arg-name">schedule</span> = <span class="arg-default">None</span>, <span class="arg-name">source</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataHubIngestionSourceInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Info about a DataHub ingestion source</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>type</strong> (<code>str</code>)</li><li><strong>config</strong> (<a href="#datahub.metadata.schema_classes.DataHubIngestionSourceConfigClass"><code>DataHubIngestionSourceConfigClass</code></a>) – </li><li><strong>platform</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>schedule</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.DataHubIngestionSourceScheduleClass"><code>DataHubIngestionSourceScheduleClass</code></a>]) – </li><li><strong>source</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.DataHubIngestionSourceSourceClass"><code>DataHubIngestionSourceSourceClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-config--datahubingestionsourceconfigclass"><em>property</em> config <em>: <a href="#datahub.metadata.schema_classes.DataHubIngestionSourceConfigClass">DataHubIngestionSourceConfigClass</a></em><a href="#property-config--datahubingestionsourceconfigclass" class="hash-link" aria-label="Direct link to property-config--datahubingestionsourceconfigclass" title="Direct link to property-config--datahubingestionsourceconfigclass"></a></h4><p>Parameters associated with the Ingestion Source</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-5"><em>property</em> name <em>: str</em><a href="#property-name--str-5" class="hash-link" aria-label="Direct link to property-name--str-5" title="Direct link to property-name--str-5"></a></h4><p>The display name of the ingestion source</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-platform--none--str"><em>property</em> platform <em>: None | str</em><a href="#property-platform--none--str" class="hash-link" aria-label="Direct link to property-platform--none--str" title="Direct link to property-platform--none--str"></a></h4><p>Data Platform URN associated with the source</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-schedule--none--datahubingestionsourcescheduleclass"><em>property</em> schedule <em>: None | <a href="#datahub.metadata.schema_classes.DataHubIngestionSourceScheduleClass">DataHubIngestionSourceScheduleClass</a></em><a href="#property-schedule--none--datahubingestionsourcescheduleclass" class="hash-link" aria-label="Direct link to property-schedule--none--datahubingestionsourcescheduleclass" title="Direct link to property-schedule--none--datahubingestionsourcescheduleclass"></a></h4><p>The schedule on which the ingestion source is executed</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-source--none--datahubingestionsourcesourceclass"><em>property</em> source <em>: None | <a href="#datahub.metadata.schema_classes.DataHubIngestionSourceSourceClass">DataHubIngestionSourceSourceClass</a></em><a href="#property-source--none--datahubingestionsourcesourceclass" class="hash-link" aria-label="Direct link to property-source--none--datahubingestionsourcesourceclass" title="Direct link to property-source--none--datahubingestionsourcesourceclass"></a></h4><p>The source or origin of the Ingestion Source</p><p>Currently CLI and UI do not provide an explicit source.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str-1"><em>property</em> type <em>: str</em><a href="#property-type--str-1" class="hash-link" aria-label="Direct link to property-type--str-1" title="Direct link to property-type--str-1"></a></h4><p>The type of the source itself, e.g. mysql, bigquery, bigquery-usage. Should match the recipe.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubIngestionSourceKeyClass"><span class="visually-hidden">DataHubIngestionSourceKeyClass</span><a href="#datahub.metadata.schema_classes.DataHubIngestionSourceKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubIngestionSourceKeyClass" title="Direct link to datahub.metadata.schema_classes.DataHubIngestionSourceKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubIngestionSourceKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.DataHubIngestionSourceKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a DataHub ingestion source</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-7"><em>property</em> id <em>: str</em><a href="#property-id--str-7" class="hash-link" aria-label="Direct link to property-id--str-7" title="Direct link to property-id--str-7"></a></h4><p>A unique id for the Ingestion Source, either generated or provided</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubIngestionSourceScheduleClass"><span class="visually-hidden">DataHubIngestionSourceScheduleClass</span><a href="#datahub.metadata.schema_classes.DataHubIngestionSourceScheduleClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubIngestionSourceScheduleClass" title="Direct link to datahub.metadata.schema_classes.DataHubIngestionSourceScheduleClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubIngestionSourceScheduleClass</span>(<span class="arg-name">interval</span>, <span class="arg-name">timezone</span>)<a href="#datahub.metadata.schema_classes.DataHubIngestionSourceScheduleClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>The schedule associated with an ingestion source.</p><ul><li><strong>Parameters:</strong><ul><li><strong>interval</strong> (<code>str</code>)</li><li><strong>timezone</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-interval--str"><em>property</em> interval <em>: str</em><a href="#property-interval--str" class="hash-link" aria-label="Direct link to property-interval--str" title="Direct link to property-interval--str"></a></h4><p>A cron-formatted execution interval, as a cron string, e.g. <!-- -->*<!-- --> <!-- -->*<!-- --> <!-- -->*<!-- --> <!-- -->*<!-- --> <!-- -->*</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-timezone--str"><em>property</em> timezone <em>: str</em><a href="#property-timezone--str" class="hash-link" aria-label="Direct link to property-timezone--str" title="Direct link to property-timezone--str"></a></h4><p>Timezone in which the cron interval applies, e.g. America/Los Angeles</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubIngestionSourceSourceClass"><span class="visually-hidden">DataHubIngestionSourceSourceClass</span><a href="#datahub.metadata.schema_classes.DataHubIngestionSourceSourceClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubIngestionSourceSourceClass" title="Direct link to datahub.metadata.schema_classes.DataHubIngestionSourceSourceClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubIngestionSourceSourceClass</span>(<span class="arg-name">type</span>)<a href="#datahub.metadata.schema_classes.DataHubIngestionSourceSourceClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.DataHubIngestionSourceSourceTypeClass"><code>DataHubIngestionSourceSourceTypeClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--datahubingestionsourcesourcetypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.DataHubIngestionSourceSourceTypeClass">DataHubIngestionSourceSourceTypeClass</a></em><a href="#property-type--str--datahubingestionsourcesourcetypeclass" class="hash-link" aria-label="Direct link to property-type--str--datahubingestionsourcesourcetypeclass" title="Direct link to property-type--str--datahubingestionsourcesourcetypeclass"></a></h4><p>The source type of the ingestion source</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubIngestionSourceSourceTypeClass"><span class="visually-hidden">DataHubIngestionSourceSourceTypeClass</span><a href="#datahub.metadata.schema_classes.DataHubIngestionSourceSourceTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubIngestionSourceSourceTypeClass" title="Direct link to datahub.metadata.schema_classes.DataHubIngestionSourceSourceTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubIngestionSourceSourceTypeClass</span>()<a href="#datahub.metadata.schema_classes.DataHubIngestionSourceSourceTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="system--system">SYSTEM <em>= 'SYSTEM'</em><a href="#system--system" class="hash-link" aria-label="Direct link to system--system" title="Direct link to system--system"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubJsonConnectionClass"><span class="visually-hidden">DataHubJsonConnectionClass</span><a href="#datahub.metadata.schema_classes.DataHubJsonConnectionClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubJsonConnectionClass" title="Direct link to datahub.metadata.schema_classes.DataHubJsonConnectionClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubJsonConnectionClass</span>(<span class="arg-name">encryptedBlob</span>)<a href="#datahub.metadata.schema_classes.DataHubJsonConnectionClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A set of connection details consisting of an encrypted JSON blob.</p><ul><li><strong>Parameters:</strong><strong>encryptedBlob</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-encryptedblob--str"><em>property</em> encryptedBlob <em>: str</em><a href="#property-encryptedblob--str" class="hash-link" aria-label="Direct link to property-encryptedblob--str" title="Direct link to property-encryptedblob--str"></a></h4><p>The encrypted JSON connection details.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubOpenAPISchemaKeyClass"><span class="visually-hidden">DataHubOpenAPISchemaKeyClass</span><a href="#datahub.metadata.schema_classes.DataHubOpenAPISchemaKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubOpenAPISchemaKeyClass" title="Direct link to datahub.metadata.schema_classes.DataHubOpenAPISchemaKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubOpenAPISchemaKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.DataHubOpenAPISchemaKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Query</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-8"><em>property</em> id <em>: str</em><a href="#property-id--str-8" class="hash-link" aria-label="Direct link to property-id--str-8" title="Direct link to property-id--str-8"></a></h4><p>A unique id for the DataHub OpenAPI schema.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubPageModuleKeyClass"><span class="visually-hidden">DataHubPageModuleKeyClass</span><a href="#datahub.metadata.schema_classes.DataHubPageModuleKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubPageModuleKeyClass" title="Direct link to datahub.metadata.schema_classes.DataHubPageModuleKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubPageModuleKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.DataHubPageModuleKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a DataHubPageModule</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-9"><em>property</em> id <em>: str</em><a href="#property-id--str-9" class="hash-link" aria-label="Direct link to property-id--str-9" title="Direct link to property-id--str-9"></a></h4><p>Unique id for the module.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubPageModuleParamsClass"><span class="visually-hidden">DataHubPageModuleParamsClass</span><a href="#datahub.metadata.schema_classes.DataHubPageModuleParamsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubPageModuleParamsClass" title="Direct link to datahub.metadata.schema_classes.DataHubPageModuleParamsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubPageModuleParamsClass</span>(<span class="arg-name">linkParams</span> = <span class="arg-default">None</span>, <span class="arg-name">richTextParams</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataHubPageModuleParamsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>The specific parameters stored for a module</p><ul><li><strong>Parameters:</strong><ul><li><strong>linkParams</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.LinkModuleParamsClass"><code>LinkModuleParamsClass</code></a>]) – </li><li><strong>richTextParams</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.RichTextModuleParamsClass"><code>RichTextModuleParamsClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-linkparams--none--linkmoduleparamsclass"><em>property</em> linkParams <em>: None | <a href="#datahub.metadata.schema_classes.LinkModuleParamsClass">LinkModuleParamsClass</a></em><a href="#property-linkparams--none--linkmoduleparamsclass" class="hash-link" aria-label="Direct link to property-linkparams--none--linkmoduleparamsclass" title="Direct link to property-linkparams--none--linkmoduleparamsclass"></a></h4><p>The params required if the module is type LINK</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-richtextparams--none--richtextmoduleparamsclass"><em>property</em> richTextParams <em>: None | <a href="#datahub.metadata.schema_classes.RichTextModuleParamsClass">RichTextModuleParamsClass</a></em><a href="#property-richtextparams--none--richtextmoduleparamsclass" class="hash-link" aria-label="Direct link to property-richtextparams--none--richtextmoduleparamsclass" title="Direct link to property-richtextparams--none--richtextmoduleparamsclass"></a></h4><p>The params required if the module is type RICH_TEXT</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubPageModulePropertiesClass"><span class="visually-hidden">DataHubPageModulePropertiesClass</span><a href="#datahub.metadata.schema_classes.DataHubPageModulePropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubPageModulePropertiesClass" title="Direct link to datahub.metadata.schema_classes.DataHubPageModulePropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubPageModulePropertiesClass</span>(<span class="arg-name">name</span>, <span class="arg-name">type</span>, <span class="arg-name">visibility</span>, <span class="arg-name">params</span>, <span class="arg-name">created</span>, <span class="arg-name">lastModified</span>)<a href="#datahub.metadata.schema_classes.DataHubPageModulePropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>The main properties of a DataHub page module</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.DataHubPageModuleTypeClass"><code>DataHubPageModuleTypeClass</code></a>]) – </li><li><strong>visibility</strong> (<a href="#datahub.metadata.schema_classes.DataHubPageModuleVisibilityClass"><code>DataHubPageModuleVisibilityClass</code></a>) – </li><li><strong>params</strong> (<a href="#datahub.metadata.schema_classes.DataHubPageModuleParamsClass"><code>DataHubPageModuleParamsClass</code></a>) – </li><li><strong>created</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li><li><strong>lastModified</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--auditstampclass-2"><em>property</em> created <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--auditstampclass-2" class="hash-link" aria-label="Direct link to property-created--auditstampclass-2" title="Direct link to property-created--auditstampclass-2"></a></h4><p>Audit stamp for when and by whom this template was created</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--auditstampclass-3"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--auditstampclass-3" class="hash-link" aria-label="Direct link to property-lastmodified--auditstampclass-3" title="Direct link to property-lastmodified--auditstampclass-3"></a></h4><p>Audit stamp for when and by whom this template was last updated</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-6"><em>property</em> name <em>: str</em><a href="#property-name--str-6" class="hash-link" aria-label="Direct link to property-name--str-6" title="Direct link to property-name--str-6"></a></h4><p>The display name of this module</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-params--datahubpagemoduleparamsclass"><em>property</em> params <em>: <a href="#datahub.metadata.schema_classes.DataHubPageModuleParamsClass">DataHubPageModuleParamsClass</a></em><a href="#property-params--datahubpagemoduleparamsclass" class="hash-link" aria-label="Direct link to property-params--datahubpagemoduleparamsclass" title="Direct link to property-params--datahubpagemoduleparamsclass"></a></h4><p>The specific parameters stored for this module</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--datahubpagemoduletypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.DataHubPageModuleTypeClass">DataHubPageModuleTypeClass</a></em><a href="#property-type--str--datahubpagemoduletypeclass" class="hash-link" aria-label="Direct link to property-type--str--datahubpagemoduletypeclass" title="Direct link to property-type--str--datahubpagemoduletypeclass"></a></h4><p>The type of this module - the purpose it serves</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-visibility--datahubpagemodulevisibilityclass"><em>property</em> visibility <em>: <a href="#datahub.metadata.schema_classes.DataHubPageModuleVisibilityClass">DataHubPageModuleVisibilityClass</a></em><a href="#property-visibility--datahubpagemodulevisibilityclass" class="hash-link" aria-label="Direct link to property-visibility--datahubpagemodulevisibilityclass" title="Direct link to property-visibility--datahubpagemodulevisibilityclass"></a></h4><p>Info about the visibility of this module</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubPageModuleTypeClass"><span class="visually-hidden">DataHubPageModuleTypeClass</span><a href="#datahub.metadata.schema_classes.DataHubPageModuleTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubPageModuleTypeClass" title="Direct link to datahub.metadata.schema_classes.DataHubPageModuleTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubPageModuleTypeClass</span>()<a href="#datahub.metadata.schema_classes.DataHubPageModuleTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>Enum containing the types of page modules that there are</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="asset_collection--asset_collection">ASSET_COLLECTION <em>= 'ASSET_COLLECTION'</em><a href="#asset_collection--asset_collection" class="hash-link" aria-label="Direct link to asset_collection--asset_collection" title="Direct link to asset_collection--asset_collection"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="domains--domains">DOMAINS <em>= 'DOMAINS'</em><a href="#domains--domains" class="hash-link" aria-label="Direct link to domains--domains" title="Direct link to domains--domains"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="hierarchy--hierarchy">HIERARCHY <em>= 'HIERARCHY'</em><a href="#hierarchy--hierarchy" class="hash-link" aria-label="Direct link to hierarchy--hierarchy" title="Direct link to hierarchy--hierarchy"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="link--link">LINK <em>= 'LINK'</em><a href="#link--link" class="hash-link" aria-label="Direct link to link--link" title="Direct link to link--link"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="owned_assets--owned_assets">OWNED_ASSETS <em>= 'OWNED_ASSETS'</em><a href="#owned_assets--owned_assets" class="hash-link" aria-label="Direct link to owned_assets--owned_assets" title="Direct link to owned_assets--owned_assets"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="rich_text--rich_text">RICH_TEXT <em>= 'RICH_TEXT'</em><a href="#rich_text--rich_text" class="hash-link" aria-label="Direct link to rich_text--rich_text" title="Direct link to rich_text--rich_text"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="subscribed_assets--subscribed_assets">SUBSCRIBED_ASSETS <em>= 'SUBSCRIBED_ASSETS'</em><a href="#subscribed_assets--subscribed_assets" class="hash-link" aria-label="Direct link to subscribed_assets--subscribed_assets" title="Direct link to subscribed_assets--subscribed_assets"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubPageModuleVisibilityClass"><span class="visually-hidden">DataHubPageModuleVisibilityClass</span><a href="#datahub.metadata.schema_classes.DataHubPageModuleVisibilityClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubPageModuleVisibilityClass" title="Direct link to datahub.metadata.schema_classes.DataHubPageModuleVisibilityClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubPageModuleVisibilityClass</span>(<span class="arg-name">scope</span>)<a href="#datahub.metadata.schema_classes.DataHubPageModuleVisibilityClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Info about the visibility of this module</p><ul><li><strong>Parameters:</strong><strong>scope</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.PageModuleScopeClass"><code>PageModuleScopeClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-scope--str--pagemodulescopeclass"><em>property</em> scope <em>: str | <a href="#datahub.metadata.schema_classes.PageModuleScopeClass">PageModuleScopeClass</a></em><a href="#property-scope--str--pagemodulescopeclass" class="hash-link" aria-label="Direct link to property-scope--str--pagemodulescopeclass" title="Direct link to property-scope--str--pagemodulescopeclass"></a></h4><p>Audit stamp for when and by whom this module was created</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubPageTemplateKeyClass"><span class="visually-hidden">DataHubPageTemplateKeyClass</span><a href="#datahub.metadata.schema_classes.DataHubPageTemplateKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubPageTemplateKeyClass" title="Direct link to datahub.metadata.schema_classes.DataHubPageTemplateKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubPageTemplateKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.DataHubPageTemplateKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a DataHubPageTemplate</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-10"><em>property</em> id <em>: str</em><a href="#property-id--str-10" class="hash-link" aria-label="Direct link to property-id--str-10" title="Direct link to property-id--str-10"></a></h4><p>Unique id for the template.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubPageTemplatePropertiesClass"><span class="visually-hidden">DataHubPageTemplatePropertiesClass</span><a href="#datahub.metadata.schema_classes.DataHubPageTemplatePropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubPageTemplatePropertiesClass" title="Direct link to datahub.metadata.schema_classes.DataHubPageTemplatePropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubPageTemplatePropertiesClass</span>(<span class="arg-name">rows</span>, <span class="arg-name">surface</span>, <span class="arg-name">visibility</span>, <span class="arg-name">created</span>, <span class="arg-name">lastModified</span>)<a href="#datahub.metadata.schema_classes.DataHubPageTemplatePropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>The main properties of a DataHub page template</p><ul><li><strong>Parameters:</strong><ul><li><strong>rows</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.DataHubPageTemplateRowClass"><code>DataHubPageTemplateRowClass</code></a>]) – </li><li><strong>surface</strong> (<a href="#datahub.metadata.schema_classes.DataHubPageTemplateSurfaceClass"><code>DataHubPageTemplateSurfaceClass</code></a>) – </li><li><strong>visibility</strong> (<a href="#datahub.metadata.schema_classes.DataHubPageTemplateVisibilityClass"><code>DataHubPageTemplateVisibilityClass</code></a>) – </li><li><strong>created</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li><li><strong>lastModified</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--auditstampclass-3"><em>property</em> created <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--auditstampclass-3" class="hash-link" aria-label="Direct link to property-created--auditstampclass-3" title="Direct link to property-created--auditstampclass-3"></a></h4><p>Audit stamp for when and by whom this template was created</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--auditstampclass-4"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--auditstampclass-4" class="hash-link" aria-label="Direct link to property-lastmodified--auditstampclass-4" title="Direct link to property-lastmodified--auditstampclass-4"></a></h4><p>Audit stamp for when and by whom this template was last updated</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-rows--listdatahubpagetemplaterowclass"><em>property</em> rows <em>: List[<a href="#datahub.metadata.schema_classes.DataHubPageTemplateRowClass">DataHubPageTemplateRowClass</a>]</em><a href="#property-rows--listdatahubpagetemplaterowclass" class="hash-link" aria-label="Direct link to property-rows--listdatahubpagetemplaterowclass" title="Direct link to property-rows--listdatahubpagetemplaterowclass"></a></h4><p>The rows of modules contained in this template</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-surface--datahubpagetemplatesurfaceclass"><em>property</em> surface <em>: <a href="#datahub.metadata.schema_classes.DataHubPageTemplateSurfaceClass">DataHubPageTemplateSurfaceClass</a></em><a href="#property-surface--datahubpagetemplatesurfaceclass" class="hash-link" aria-label="Direct link to property-surface--datahubpagetemplatesurfaceclass" title="Direct link to property-surface--datahubpagetemplatesurfaceclass"></a></h4><p>Info about the surface area of the product that this template is deployed in</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-visibility--datahubpagetemplatevisibilityclass"><em>property</em> visibility <em>: <a href="#datahub.metadata.schema_classes.DataHubPageTemplateVisibilityClass">DataHubPageTemplateVisibilityClass</a></em><a href="#property-visibility--datahubpagetemplatevisibilityclass" class="hash-link" aria-label="Direct link to property-visibility--datahubpagetemplatevisibilityclass" title="Direct link to property-visibility--datahubpagetemplatevisibilityclass"></a></h4><p>Info about the visibility of this template</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubPageTemplateRowClass"><span class="visually-hidden">DataHubPageTemplateRowClass</span><a href="#datahub.metadata.schema_classes.DataHubPageTemplateRowClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubPageTemplateRowClass" title="Direct link to datahub.metadata.schema_classes.DataHubPageTemplateRowClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubPageTemplateRowClass</span>(<span class="arg-name">modules</span>)<a href="#datahub.metadata.schema_classes.DataHubPageTemplateRowClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A row of modules contained in a template</p><ul><li><strong>Parameters:</strong><strong>modules</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-modules--liststr"><em>property</em> modules <em>: List<!-- -->[str]</em><a href="#property-modules--liststr" class="hash-link" aria-label="Direct link to property-modules--liststr" title="Direct link to property-modules--liststr"></a></h4><p>The modules that exist in this template row</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubPageTemplateSurfaceClass"><span class="visually-hidden">DataHubPageTemplateSurfaceClass</span><a href="#datahub.metadata.schema_classes.DataHubPageTemplateSurfaceClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubPageTemplateSurfaceClass" title="Direct link to datahub.metadata.schema_classes.DataHubPageTemplateSurfaceClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubPageTemplateSurfaceClass</span>(<span class="arg-name">surfaceType</span>)<a href="#datahub.metadata.schema_classes.DataHubPageTemplateSurfaceClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Info about the surface area of the product that this template is deployed in</p><ul><li><strong>Parameters:</strong><strong>surfaceType</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.PageTemplateSurfaceTypeClass"><code>PageTemplateSurfaceTypeClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-surfacetype--str--pagetemplatesurfacetypeclass"><em>property</em> surfaceType <em>: str | <a href="#datahub.metadata.schema_classes.PageTemplateSurfaceTypeClass">PageTemplateSurfaceTypeClass</a></em><a href="#property-surfacetype--str--pagetemplatesurfacetypeclass" class="hash-link" aria-label="Direct link to property-surfacetype--str--pagetemplatesurfacetypeclass" title="Direct link to property-surfacetype--str--pagetemplatesurfacetypeclass"></a></h4><p>Where exactly is this template being used</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubPageTemplateVisibilityClass"><span class="visually-hidden">DataHubPageTemplateVisibilityClass</span><a href="#datahub.metadata.schema_classes.DataHubPageTemplateVisibilityClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubPageTemplateVisibilityClass" title="Direct link to datahub.metadata.schema_classes.DataHubPageTemplateVisibilityClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubPageTemplateVisibilityClass</span>(<span class="arg-name">scope</span>)<a href="#datahub.metadata.schema_classes.DataHubPageTemplateVisibilityClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Info about the visibility of this template</p><ul><li><strong>Parameters:</strong><strong>scope</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.PageTemplateScopeClass"><code>PageTemplateScopeClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-scope--str--pagetemplatescopeclass"><em>property</em> scope <em>: str | <a href="#datahub.metadata.schema_classes.PageTemplateScopeClass">PageTemplateScopeClass</a></em><a href="#property-scope--str--pagetemplatescopeclass" class="hash-link" aria-label="Direct link to property-scope--str--pagetemplatescopeclass" title="Direct link to property-scope--str--pagetemplatescopeclass"></a></h4><p>The scope of this template and who can use/see it</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubPersonaInfoClass"><span class="visually-hidden">DataHubPersonaInfoClass</span><a href="#datahub.metadata.schema_classes.DataHubPersonaInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubPersonaInfoClass" title="Direct link to datahub.metadata.schema_classes.DataHubPersonaInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubPersonaInfoClass</span>()<a href="#datahub.metadata.schema_classes.DataHubPersonaInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Placeholder aspect for persona type info</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubPersonaKeyClass"><span class="visually-hidden">DataHubPersonaKeyClass</span><a href="#datahub.metadata.schema_classes.DataHubPersonaKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubPersonaKeyClass" title="Direct link to datahub.metadata.schema_classes.DataHubPersonaKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubPersonaKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.DataHubPersonaKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a persona type</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-11"><em>property</em> id <em>: str</em><a href="#property-id--str-11" class="hash-link" aria-label="Direct link to property-id--str-11" title="Direct link to property-id--str-11"></a></h4><p>A unique id for the persona type</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubPolicyInfoClass"><span class="visually-hidden">DataHubPolicyInfoClass</span><a href="#datahub.metadata.schema_classes.DataHubPolicyInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubPolicyInfoClass" title="Direct link to datahub.metadata.schema_classes.DataHubPolicyInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubPolicyInfoClass</span>(<span class="arg-name">displayName</span>, <span class="arg-name">description</span>, <span class="arg-name">type</span>, <span class="arg-name">state</span>, <span class="arg-name">privileges</span>, <span class="arg-name">actors</span>, <span class="arg-name">resources</span> = <span class="arg-default">None</span>, <span class="arg-name">editable</span> = <span class="arg-default">None</span>, <span class="arg-name">lastUpdatedTimestamp</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataHubPolicyInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a DataHub (UI) access policy.</p><ul><li><strong>Parameters:</strong><ul><li><strong>displayName</strong> (<code>str</code>)</li><li><strong>description</strong> (<code>str</code>)</li><li><strong>type</strong> (<code>str</code>)</li><li><strong>state</strong> (<code>str</code>)</li><li><strong>privileges</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li><li><strong>actors</strong> (<a href="#datahub.metadata.schema_classes.DataHubActorFilterClass"><code>DataHubActorFilterClass</code></a>) – </li><li><strong>resources</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.DataHubResourceFilterClass"><code>DataHubResourceFilterClass</code></a>]) – </li><li><strong>editable</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>lastUpdatedTimestamp</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-actors--datahubactorfilterclass"><em>property</em> actors <em>: <a href="#datahub.metadata.schema_classes.DataHubActorFilterClass">DataHubActorFilterClass</a></em><a href="#property-actors--datahubactorfilterclass" class="hash-link" aria-label="Direct link to property-actors--datahubactorfilterclass" title="Direct link to property-actors--datahubactorfilterclass"></a></h4><p>The actors that the policy applies to.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--str-2"><em>property</em> description <em>: str</em><a href="#property-description--str-2" class="hash-link" aria-label="Direct link to property-description--str-2" title="Direct link to property-description--str-2"></a></h4><p>Description of the Policy</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-displayname--str"><em>property</em> displayName <em>: str</em><a href="#property-displayname--str" class="hash-link" aria-label="Direct link to property-displayname--str" title="Direct link to property-displayname--str"></a></h4><p>Display name of the Policy</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-editable--bool"><em>property</em> editable <em>: bool</em><a href="#property-editable--bool" class="hash-link" aria-label="Direct link to property-editable--bool" title="Direct link to property-editable--bool"></a></h4><p>Whether the policy should be editable via the UI</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastupdatedtimestamp--none--int"><em>property</em> lastUpdatedTimestamp <em>: None | int</em><a href="#property-lastupdatedtimestamp--none--int" class="hash-link" aria-label="Direct link to property-lastupdatedtimestamp--none--int" title="Direct link to property-lastupdatedtimestamp--none--int"></a></h4><p>Timestamp when the policy was last updated</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-privileges--liststr"><em>property</em> privileges <em>: List<!-- -->[str]</em><a href="#property-privileges--liststr" class="hash-link" aria-label="Direct link to property-privileges--liststr" title="Direct link to property-privileges--liststr"></a></h4><p>The privileges that the policy grants.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-resources--none--datahubresourcefilterclass"><em>property</em> resources <em>: None | <a href="#datahub.metadata.schema_classes.DataHubResourceFilterClass">DataHubResourceFilterClass</a></em><a href="#property-resources--none--datahubresourcefilterclass" class="hash-link" aria-label="Direct link to property-resources--none--datahubresourcefilterclass" title="Direct link to property-resources--none--datahubresourcefilterclass"></a></h4><p>The resource that the policy applies to. Not required for some ‘Platform’ privileges.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-state--str"><em>property</em> state <em>: str</em><a href="#property-state--str" class="hash-link" aria-label="Direct link to property-state--str" title="Direct link to property-state--str"></a></h4><p>The state of policy, ACTIVE or INACTIVE</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str-2"><em>property</em> type <em>: str</em><a href="#property-type--str-2" class="hash-link" aria-label="Direct link to property-type--str-2" title="Direct link to property-type--str-2"></a></h4><p>The type of policy</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubPolicyKeyClass"><span class="visually-hidden">DataHubPolicyKeyClass</span><a href="#datahub.metadata.schema_classes.DataHubPolicyKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubPolicyKeyClass" title="Direct link to datahub.metadata.schema_classes.DataHubPolicyKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubPolicyKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.DataHubPolicyKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a DataHub Policy</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-12"><em>property</em> id <em>: str</em><a href="#property-id--str-12" class="hash-link" aria-label="Direct link to property-id--str-12" title="Direct link to property-id--str-12"></a></h4><p>A unique id for the DataHub access policy record. Generated on the server side at policy creation time.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubPolicySnapshotClass"><span class="visually-hidden">DataHubPolicySnapshotClass</span><a href="#datahub.metadata.schema_classes.DataHubPolicySnapshotClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubPolicySnapshotClass" title="Direct link to datahub.metadata.schema_classes.DataHubPolicySnapshotClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubPolicySnapshotClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">aspects</span>)<a href="#datahub.metadata.schema_classes.DataHubPolicySnapshotClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A metadata snapshot for DataHub Access Policy data.</p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>aspects</strong> (<code>List</code>[<code>Union</code>[<a href="#datahub.metadata.schema_classes.DataHubPolicyKeyClass"><code>DataHubPolicyKeyClass</code></a>, <a href="#datahub.metadata.schema_classes.DataHubPolicyInfoClass"><code>DataHubPolicyInfoClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspects--listdatahubpolicykeyclass--datahubpolicyinfoclass"><em>property</em> aspects <em>: List[<a href="#datahub.metadata.schema_classes.DataHubPolicyKeyClass">DataHubPolicyKeyClass</a> | <a href="#datahub.metadata.schema_classes.DataHubPolicyInfoClass">DataHubPolicyInfoClass</a>]</em><a href="#property-aspects--listdatahubpolicykeyclass--datahubpolicyinfoclass" class="hash-link" aria-label="Direct link to property-aspects--listdatahubpolicykeyclass--datahubpolicyinfoclass" title="Direct link to property-aspects--listdatahubpolicykeyclass--datahubpolicyinfoclass"></a></h4><p>The list of metadata aspects associated with the DataHub access policy.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-5"><em>property</em> urn <em>: str</em><a href="#property-urn--str-5" class="hash-link" aria-label="Direct link to property-urn--str-5" title="Direct link to property-urn--str-5"></a></h4><p>URN for the entity the metadata snapshot is associated with.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubResourceFilterClass"><span class="visually-hidden">DataHubResourceFilterClass</span><a href="#datahub.metadata.schema_classes.DataHubResourceFilterClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubResourceFilterClass" title="Direct link to datahub.metadata.schema_classes.DataHubResourceFilterClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubResourceFilterClass</span>(<span class="arg-name">type</span> = <span class="arg-default">None</span>, <span class="arg-name">resources</span> = <span class="arg-default">None</span>, <span class="arg-name">allResources</span> = <span class="arg-default">None</span>, <span class="arg-name">filter</span> = <span class="arg-default">None</span>, <span class="arg-name">privilegeConstraints</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataHubResourceFilterClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Information used to filter DataHub resource.</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>resources</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>allResources</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>filter</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.PolicyMatchFilterClass"><code>PolicyMatchFilterClass</code></a>]) – </li><li><strong>privilegeConstraints</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.PolicyMatchFilterClass"><code>PolicyMatchFilterClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-allresources--bool"><em>property</em> allResources <em>: bool</em><a href="#property-allresources--bool" class="hash-link" aria-label="Direct link to property-allresources--bool" title="Direct link to property-allresources--bool"></a></h4><p>Whether the policy should be applied to all assets matching the filter.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-filter--none--policymatchfilterclass"><em>property</em> filter <em>: None | <a href="#datahub.metadata.schema_classes.PolicyMatchFilterClass">PolicyMatchFilterClass</a></em><a href="#property-filter--none--policymatchfilterclass" class="hash-link" aria-label="Direct link to property-filter--none--policymatchfilterclass" title="Direct link to property-filter--none--policymatchfilterclass"></a></h4><p>Filter to apply privileges to</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-privilegeconstraints--none--policymatchfilterclass"><em>property</em> privilegeConstraints <em>: None | <a href="#datahub.metadata.schema_classes.PolicyMatchFilterClass">PolicyMatchFilterClass</a></em><a href="#property-privilegeconstraints--none--policymatchfilterclass" class="hash-link" aria-label="Direct link to property-privilegeconstraints--none--policymatchfilterclass" title="Direct link to property-privilegeconstraints--none--policymatchfilterclass"></a></h4><p>Constraints around what sub-resources operations are allowed to modify, i.e. NOT_EQUALS - cannot modify a particular defined tag, EQUALS - can only modify a particular defined tag, STARTS_WITH - can only modify a tag starting with xyz</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-resources--none--liststr"><em>property</em> resources <em>: None | List<!-- -->[str]</em><a href="#property-resources--none--liststr" class="hash-link" aria-label="Direct link to property-resources--none--liststr" title="Direct link to property-resources--none--liststr"></a></h4><p>A specific set of resources to apply the policy to, e.g. asset urns</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--none--str"><em>property</em> type <em>: None | str</em><a href="#property-type--none--str" class="hash-link" aria-label="Direct link to property-type--none--str" title="Direct link to property-type--none--str"></a></h4><p>The type of resource that the policy applies to. This will most often be a data asset entity name, for
|
||
example ‘dataset’. It is not strictly required because in the future we will want to support filtering a resource
|
||
by domain, as well.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubRetentionConfigClass"><span class="visually-hidden">DataHubRetentionConfigClass</span><a href="#datahub.metadata.schema_classes.DataHubRetentionConfigClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubRetentionConfigClass" title="Direct link to datahub.metadata.schema_classes.DataHubRetentionConfigClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubRetentionConfigClass</span>(<span class="arg-name">retention</span>)<a href="#datahub.metadata.schema_classes.DataHubRetentionConfigClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><ul><li><strong>Parameters:</strong><strong>retention</strong> (<a href="#datahub.metadata.schema_classes.RetentionClass"><code>RetentionClass</code></a>) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-retention--retentionclass"><em>property</em> retention <em>: <a href="#datahub.metadata.schema_classes.RetentionClass">RetentionClass</a></em><a href="#property-retention--retentionclass" class="hash-link" aria-label="Direct link to property-retention--retentionclass" title="Direct link to property-retention--retentionclass"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubRetentionKeyClass"><span class="visually-hidden">DataHubRetentionKeyClass</span><a href="#datahub.metadata.schema_classes.DataHubRetentionKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubRetentionKeyClass" title="Direct link to datahub.metadata.schema_classes.DataHubRetentionKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubRetentionKeyClass</span>(<span class="arg-name">entityName</span>, <span class="arg-name">aspectName</span>)<a href="#datahub.metadata.schema_classes.DataHubRetentionKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a DataHub Retention</p><ul><li><strong>Parameters:</strong><ul><li><strong>entityName</strong> (<code>str</code>)</li><li><strong>aspectName</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspectname--str"><em>property</em> aspectName <em>: str</em><a href="#property-aspectname--str" class="hash-link" aria-label="Direct link to property-aspectname--str" title="Direct link to property-aspectname--str"></a></h4><p>Aspect name to apply retention to. <!-- -->*<!-- --> (or empty) for applying defaults.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-entityname--str"><em>property</em> entityName <em>: str</em><a href="#property-entityname--str" class="hash-link" aria-label="Direct link to property-entityname--str" title="Direct link to property-entityname--str"></a></h4><p>Entity name to apply retention to. <!-- -->*<!-- --> (or empty) for applying defaults.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubRetentionSnapshotClass"><span class="visually-hidden">DataHubRetentionSnapshotClass</span><a href="#datahub.metadata.schema_classes.DataHubRetentionSnapshotClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubRetentionSnapshotClass" title="Direct link to datahub.metadata.schema_classes.DataHubRetentionSnapshotClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubRetentionSnapshotClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">aspects</span>)<a href="#datahub.metadata.schema_classes.DataHubRetentionSnapshotClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A metadata snapshot for DataHub Access Policy data.</p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>aspects</strong> (<code>List</code>[<code>Union</code>[<a href="#datahub.metadata.schema_classes.DataHubRetentionKeyClass"><code>DataHubRetentionKeyClass</code></a>, <a href="#datahub.metadata.schema_classes.DataHubRetentionConfigClass"><code>DataHubRetentionConfigClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspects--listdatahubretentionkeyclass--datahubretentionconfigclass"><em>property</em> aspects <em>: List[<a href="#datahub.metadata.schema_classes.DataHubRetentionKeyClass">DataHubRetentionKeyClass</a> | <a href="#datahub.metadata.schema_classes.DataHubRetentionConfigClass">DataHubRetentionConfigClass</a>]</em><a href="#property-aspects--listdatahubretentionkeyclass--datahubretentionconfigclass" class="hash-link" aria-label="Direct link to property-aspects--listdatahubretentionkeyclass--datahubretentionconfigclass" title="Direct link to property-aspects--listdatahubretentionkeyclass--datahubretentionconfigclass"></a></h4><p>The list of metadata aspects associated with the DataHub access policy.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-6"><em>property</em> urn <em>: str</em><a href="#property-urn--str-6" class="hash-link" aria-label="Direct link to property-urn--str-6" title="Direct link to property-urn--str-6"></a></h4><p>URN for the entity the metadata snapshot is associated with.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubRoleInfoClass"><span class="visually-hidden">DataHubRoleInfoClass</span><a href="#datahub.metadata.schema_classes.DataHubRoleInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubRoleInfoClass" title="Direct link to datahub.metadata.schema_classes.DataHubRoleInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubRoleInfoClass</span>(<span class="arg-name">name</span>, <span class="arg-name">description</span>, <span class="arg-name">editable</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataHubRoleInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a DataHub Role.</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>description</strong> (<code>str</code>)</li><li><strong>editable</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--str-3"><em>property</em> description <em>: str</em><a href="#property-description--str-3" class="hash-link" aria-label="Direct link to property-description--str-3" title="Direct link to property-description--str-3"></a></h4><p>Description of the Role</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-editable--bool-1"><em>property</em> editable <em>: bool</em><a href="#property-editable--bool-1" class="hash-link" aria-label="Direct link to property-editable--bool-1" title="Direct link to property-editable--bool-1"></a></h4><p>Whether the role should be editable via the UI</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-7"><em>property</em> name <em>: str</em><a href="#property-name--str-7" class="hash-link" aria-label="Direct link to property-name--str-7" title="Direct link to property-name--str-7"></a></h4><p>Name of the Role</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubRoleKeyClass"><span class="visually-hidden">DataHubRoleKeyClass</span><a href="#datahub.metadata.schema_classes.DataHubRoleKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubRoleKeyClass" title="Direct link to datahub.metadata.schema_classes.DataHubRoleKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubRoleKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.DataHubRoleKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a DataHub Role</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-13"><em>property</em> id <em>: str</em><a href="#property-id--str-13" class="hash-link" aria-label="Direct link to property-id--str-13" title="Direct link to property-id--str-13"></a></h4><p>A unique id for the DataHub role record. Generated on the server side at role creation time.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubSearchConfigClass"><span class="visually-hidden">DataHubSearchConfigClass</span><a href="#datahub.metadata.schema_classes.DataHubSearchConfigClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubSearchConfigClass" title="Direct link to datahub.metadata.schema_classes.DataHubSearchConfigClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubSearchConfigClass</span>(<span class="arg-name">fieldName</span> = <span class="arg-default">None</span>, <span class="arg-name">fieldType</span> = <span class="arg-default">None</span>, <span class="arg-name">queryByDefault</span> = <span class="arg-default">None</span>, <span class="arg-name">enableAutocomplete</span> = <span class="arg-default">None</span>, <span class="arg-name">addToFilters</span> = <span class="arg-default">None</span>, <span class="arg-name">addHasValuesToFilters</span> = <span class="arg-default">None</span>, <span class="arg-name">filterNameOverride</span> = <span class="arg-default">None</span>, <span class="arg-name">hasValuesFilterNameOverride</span> = <span class="arg-default">None</span>, <span class="arg-name">boostScore</span> = <span class="arg-default">None</span>, <span class="arg-name">hasValuesFieldName</span> = <span class="arg-default">None</span>, <span class="arg-name">numValuesFieldName</span> = <span class="arg-default">None</span>, <span class="arg-name">weightsPerFieldValue</span> = <span class="arg-default">None</span>, <span class="arg-name">fieldNameAliases</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataHubSearchConfigClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Configuration for how any given field should be indexed and matched in the DataHub search index.</p><ul><li><strong>Parameters:</strong><ul><li><strong>fieldName</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>fieldType</strong> (<code>Union</code>[<code>None</code>, <code>str</code>, <a href="#datahub.metadata.schema_classes.SearchFieldTypeClass"><code>SearchFieldTypeClass</code></a>]) – </li><li><strong>queryByDefault</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>enableAutocomplete</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>addToFilters</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>addHasValuesToFilters</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>filterNameOverride</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>hasValuesFilterNameOverride</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>boostScore</strong> (<code>Optional</code>[<code>float</code>]<!-- -->)</li><li><strong>hasValuesFieldName</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>numValuesFieldName</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>weightsPerFieldValue</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>float</code>]<!-- -->])</li><li><strong>fieldNameAliases</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-addhasvaluestofilters--bool"><em>property</em> addHasValuesToFilters <em>: bool</em><a href="#property-addhasvaluestofilters--bool" class="hash-link" aria-label="Direct link to property-addhasvaluestofilters--bool" title="Direct link to property-addhasvaluestofilters--bool"></a></h4><p>Whether or not to add the “has values” to filters.
|
||
check if this is conditional on addToFilters being true</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-addtofilters--bool"><em>property</em> addToFilters <em>: bool</em><a href="#property-addtofilters--bool" class="hash-link" aria-label="Direct link to property-addtofilters--bool" title="Direct link to property-addtofilters--bool"></a></h4><p>Whether or not to add field to filters.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-boostscore--float"><em>property</em> boostScore <em>: float</em><a href="#property-boostscore--float" class="hash-link" aria-label="Direct link to property-boostscore--float" title="Direct link to property-boostscore--float"></a></h4><p>Boost multiplier to the match score. Matches on fields with higher boost score ranks higher</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-enableautocomplete--bool"><em>property</em> enableAutocomplete <em>: bool</em><a href="#property-enableautocomplete--bool" class="hash-link" aria-label="Direct link to property-enableautocomplete--bool" title="Direct link to property-enableautocomplete--bool"></a></h4><p>Whether we should use the field for default autocomplete</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fieldname--none--str"><em>property</em> fieldName <em>: None | str</em><a href="#property-fieldname--none--str" class="hash-link" aria-label="Direct link to property-fieldname--none--str" title="Direct link to property-fieldname--none--str"></a></h4><p>Name of the field in the search index. Defaults to the field name otherwise</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fieldnamealiases--none--liststr"><em>property</em> fieldNameAliases <em>: None | List<!-- -->[str]</em><a href="#property-fieldnamealiases--none--liststr" class="hash-link" aria-label="Direct link to property-fieldnamealiases--none--liststr" title="Direct link to property-fieldnamealiases--none--liststr"></a></h4><p>(Optional) Aliases for this given field that can be used for sorting etc.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fieldtype--none--str--searchfieldtypeclass"><em>property</em> fieldType <em>: None | str | <a href="#datahub.metadata.schema_classes.SearchFieldTypeClass">SearchFieldTypeClass</a></em><a href="#property-fieldtype--none--str--searchfieldtypeclass" class="hash-link" aria-label="Direct link to property-fieldtype--none--str--searchfieldtypeclass" title="Direct link to property-fieldtype--none--str--searchfieldtypeclass"></a></h4><p>Type of the field. Defines how the field is indexed and matched</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-filternameoverride--none--str"><em>property</em> filterNameOverride <em>: None | str</em><a href="#property-filternameoverride--none--str" class="hash-link" aria-label="Direct link to property-filternameoverride--none--str" title="Direct link to property-filternameoverride--none--str"></a></h4><p>Display name of the filter</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-hasvaluesfieldname--none--str"><em>property</em> hasValuesFieldName <em>: None | str</em><a href="#property-hasvaluesfieldname--none--str" class="hash-link" aria-label="Direct link to property-hasvaluesfieldname--none--str" title="Direct link to property-hasvaluesfieldname--none--str"></a></h4><p>If set, add a index field of the given name that checks whether the field exists</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-hasvaluesfilternameoverride--none--str"><em>property</em> hasValuesFilterNameOverride <em>: None | str</em><a href="#property-hasvaluesfilternameoverride--none--str" class="hash-link" aria-label="Direct link to property-hasvaluesfilternameoverride--none--str" title="Direct link to property-hasvaluesfilternameoverride--none--str"></a></h4><p>Display name of the has values filter</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-numvaluesfieldname--none--str"><em>property</em> numValuesFieldName <em>: None | str</em><a href="#property-numvaluesfieldname--none--str" class="hash-link" aria-label="Direct link to property-numvaluesfieldname--none--str" title="Direct link to property-numvaluesfieldname--none--str"></a></h4><p>If set, add a index field of the given name that checks the number of elements</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-querybydefault--bool"><em>property</em> queryByDefault <em>: bool</em><a href="#property-querybydefault--bool" class="hash-link" aria-label="Direct link to property-querybydefault--bool" title="Direct link to property-querybydefault--bool"></a></h4><p>Whether we should match the field for the default search query</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-weightsperfieldvalue--none--dictstr-float"><em>property</em> weightsPerFieldValue <em>: None | Dict<!-- -->[str, float]</em><a href="#property-weightsperfieldvalue--none--dictstr-float" class="hash-link" aria-label="Direct link to property-weightsperfieldvalue--none--dictstr-float" title="Direct link to property-weightsperfieldvalue--none--dictstr-float"></a></h4><p>(Optional) Weights to apply to score for a given value</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubSecretKeyClass"><span class="visually-hidden">DataHubSecretKeyClass</span><a href="#datahub.metadata.schema_classes.DataHubSecretKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubSecretKeyClass" title="Direct link to datahub.metadata.schema_classes.DataHubSecretKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubSecretKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.DataHubSecretKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a DataHub Secret</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-14"><em>property</em> id <em>: str</em><a href="#property-id--str-14" class="hash-link" aria-label="Direct link to property-id--str-14" title="Direct link to property-id--str-14"></a></h4><p>A unique id for the Secret</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubSecretValueClass"><span class="visually-hidden">DataHubSecretValueClass</span><a href="#datahub.metadata.schema_classes.DataHubSecretValueClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubSecretValueClass" title="Direct link to datahub.metadata.schema_classes.DataHubSecretValueClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubSecretValueClass</span>(<span class="arg-name">name</span>, <span class="arg-name">value</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataHubSecretValueClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>The value of a DataHub Secret</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>value</strong> (<code>str</code>)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--none--auditstampclass-2"><em>property</em> created <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--none--auditstampclass-2" class="hash-link" aria-label="Direct link to property-created--none--auditstampclass-2" title="Direct link to property-created--none--auditstampclass-2"></a></h4><p>Created Audit stamp</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-8"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-8" class="hash-link" aria-label="Direct link to property-description--none--str-8" title="Direct link to property-description--none--str-8"></a></h4><p>Description of the secret</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-8"><em>property</em> name <em>: str</em><a href="#property-name--str-8" class="hash-link" aria-label="Direct link to property-name--str-8" title="Direct link to property-name--str-8"></a></h4><p>The display name for the secret</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-value--str-2"><em>property</em> value <em>: str</em><a href="#property-value--str-2" class="hash-link" aria-label="Direct link to property-value--str-2" title="Direct link to property-value--str-2"></a></h4><p>The AES-encrypted value of the DataHub secret.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubStepStateKeyClass"><span class="visually-hidden">DataHubStepStateKeyClass</span><a href="#datahub.metadata.schema_classes.DataHubStepStateKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubStepStateKeyClass" title="Direct link to datahub.metadata.schema_classes.DataHubStepStateKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubStepStateKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.DataHubStepStateKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a DataHub Step State</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-15"><em>property</em> id <em>: str</em><a href="#property-id--str-15" class="hash-link" aria-label="Direct link to property-id--str-15" title="Direct link to property-id--str-15"></a></h4><p>A unique id for the state</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubStepStatePropertiesClass"><span class="visually-hidden">DataHubStepStatePropertiesClass</span><a href="#datahub.metadata.schema_classes.DataHubStepStatePropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubStepStatePropertiesClass" title="Direct link to datahub.metadata.schema_classes.DataHubStepStatePropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubStepStatePropertiesClass</span>(<span class="arg-name">lastModified</span>, <span class="arg-name">properties</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataHubStepStatePropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>The properties associated with a DataHub step state</p><ul><li><strong>Parameters:</strong><ul><li><strong>lastModified</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li><li><strong>properties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--auditstampclass-5"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--auditstampclass-5" class="hash-link" aria-label="Direct link to property-lastmodified--auditstampclass-5" title="Direct link to property-lastmodified--auditstampclass-5"></a></h4><p>Audit stamp describing the last person to update it.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-properties--dictstr-str"><em>property</em> properties <em>: Dict<!-- -->[str, str]</em><a href="#property-properties--dictstr-str" class="hash-link" aria-label="Direct link to property-properties--dictstr-str" title="Direct link to property-properties--dictstr-str"></a></h4><p>Description of the secret</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubUpgradeKeyClass"><span class="visually-hidden">DataHubUpgradeKeyClass</span><a href="#datahub.metadata.schema_classes.DataHubUpgradeKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubUpgradeKeyClass" title="Direct link to datahub.metadata.schema_classes.DataHubUpgradeKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubUpgradeKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.DataHubUpgradeKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a DataHubUpgrade</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-16"><em>property</em> id <em>: str</em><a href="#property-id--str-16" class="hash-link" aria-label="Direct link to property-id--str-16" title="Direct link to property-id--str-16"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubUpgradeRequestClass"><span class="visually-hidden">DataHubUpgradeRequestClass</span><a href="#datahub.metadata.schema_classes.DataHubUpgradeRequestClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubUpgradeRequestClass" title="Direct link to datahub.metadata.schema_classes.DataHubUpgradeRequestClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubUpgradeRequestClass</span>(<span class="arg-name">timestampMs</span>, <span class="arg-name">version</span>)<a href="#datahub.metadata.schema_classes.DataHubUpgradeRequestClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information collected when kicking off a DataHubUpgrade</p><ul><li><strong>Parameters:</strong><ul><li><strong>timestampMs</strong> (<code>int</code>)</li><li><strong>version</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-timestampms--int"><em>property</em> timestampMs <em>: int</em><a href="#property-timestampms--int" class="hash-link" aria-label="Direct link to property-timestampms--int" title="Direct link to property-timestampms--int"></a></h4><p>Timestamp when we started this DataHubUpgrade</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-version--str"><em>property</em> version <em>: str</em><a href="#property-version--str" class="hash-link" aria-label="Direct link to property-version--str" title="Direct link to property-version--str"></a></h4><p>Version of this upgrade</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubUpgradeResultClass"><span class="visually-hidden">DataHubUpgradeResultClass</span><a href="#datahub.metadata.schema_classes.DataHubUpgradeResultClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubUpgradeResultClass" title="Direct link to datahub.metadata.schema_classes.DataHubUpgradeResultClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubUpgradeResultClass</span>(<span class="arg-name">timestampMs</span>, <span class="arg-name">state</span> = <span class="arg-default">None</span>, <span class="arg-name">result</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataHubUpgradeResultClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information collected when a DataHubUpgrade successfully finishes</p><ul><li><strong>Parameters:</strong><ul><li><strong>timestampMs</strong> (<code>int</code>)</li><li><strong>state</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.DataHubUpgradeStateClass"><code>DataHubUpgradeStateClass</code></a>, <code>None</code>]) – </li><li><strong>result</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-result--none--dictstr-str"><em>property</em> result <em>: None | Dict<!-- -->[str, str]</em><a href="#property-result--none--dictstr-str" class="hash-link" aria-label="Direct link to property-result--none--dictstr-str" title="Direct link to property-result--none--dictstr-str"></a></h4><p>Result map to place helpful information about this upgrade job</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-state--str--datahubupgradestateclass--none"><em>property</em> state <em>: str | <a href="#datahub.metadata.schema_classes.DataHubUpgradeStateClass">DataHubUpgradeStateClass</a> | None</em><a href="#property-state--str--datahubupgradestateclass--none" class="hash-link" aria-label="Direct link to property-state--str--datahubupgradestateclass--none" title="Direct link to property-state--str--datahubupgradestateclass--none"></a></h4><p>Upgrade state UpgradeResult.Result</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-timestampms--int-1"><em>property</em> timestampMs <em>: int</em><a href="#property-timestampms--int-1" class="hash-link" aria-label="Direct link to property-timestampms--int-1" title="Direct link to property-timestampms--int-1"></a></h4><p>Timestamp when we started this DataHubUpgrade</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubUpgradeStateClass"><span class="visually-hidden">DataHubUpgradeStateClass</span><a href="#datahub.metadata.schema_classes.DataHubUpgradeStateClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubUpgradeStateClass" title="Direct link to datahub.metadata.schema_classes.DataHubUpgradeStateClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubUpgradeStateClass</span>()<a href="#datahub.metadata.schema_classes.DataHubUpgradeStateClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="aborted--aborted">ABORTED <em>= 'ABORTED'</em><a href="#aborted--aborted" class="hash-link" aria-label="Direct link to aborted--aborted" title="Direct link to aborted--aborted"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="failed--failed">FAILED <em>= 'FAILED'</em><a href="#failed--failed" class="hash-link" aria-label="Direct link to failed--failed" title="Direct link to failed--failed"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="in_progress--in_progress">IN_PROGRESS <em>= 'IN_PROGRESS'</em><a href="#in_progress--in_progress" class="hash-link" aria-label="Direct link to in_progress--in_progress" title="Direct link to in_progress--in_progress"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="succeeded--succeeded">SUCCEEDED <em>= 'SUCCEEDED'</em><a href="#succeeded--succeeded" class="hash-link" aria-label="Direct link to succeeded--succeeded" title="Direct link to succeeded--succeeded"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubViewDefinitionClass"><span class="visually-hidden">DataHubViewDefinitionClass</span><a href="#datahub.metadata.schema_classes.DataHubViewDefinitionClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubViewDefinitionClass" title="Direct link to datahub.metadata.schema_classes.DataHubViewDefinitionClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubViewDefinitionClass</span>(<span class="arg-name">entityTypes</span>, <span class="arg-name">filter</span>)<a href="#datahub.metadata.schema_classes.DataHubViewDefinitionClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A View definition.</p><ul><li><strong>Parameters:</strong><ul><li><strong>entityTypes</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li><li><strong>filter</strong> (<a href="#datahub.metadata.schema_classes.FilterClass"><code>FilterClass</code></a>) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-entitytypes--liststr"><em>property</em> entityTypes <em>: List<!-- -->[str]</em><a href="#property-entitytypes--liststr" class="hash-link" aria-label="Direct link to property-entitytypes--liststr" title="Direct link to property-entitytypes--liststr"></a></h4><p>The Entity Types in the scope of the View.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-filter--filterclass"><em>property</em> filter <em>: <a href="#datahub.metadata.schema_classes.FilterClass">FilterClass</a></em><a href="#property-filter--filterclass" class="hash-link" aria-label="Direct link to property-filter--filterclass" title="Direct link to property-filter--filterclass"></a></h4><p>The filter criteria, which represents the view itself</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubViewInfoClass"><span class="visually-hidden">DataHubViewInfoClass</span><a href="#datahub.metadata.schema_classes.DataHubViewInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubViewInfoClass" title="Direct link to datahub.metadata.schema_classes.DataHubViewInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubViewInfoClass</span>(<span class="arg-name">name</span>, <span class="arg-name">type</span>, <span class="arg-name">definition</span>, <span class="arg-name">created</span>, <span class="arg-name">lastModified</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataHubViewInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a DataHub View. – TODO: Understand whether an entity type filter is required.</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.DataHubViewTypeClass"><code>DataHubViewTypeClass</code></a>]) – </li><li><strong>definition</strong> (<a href="#datahub.metadata.schema_classes.DataHubViewDefinitionClass"><code>DataHubViewDefinitionClass</code></a>) – </li><li><strong>created</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li><li><strong>lastModified</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--auditstampclass-4"><em>property</em> created <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--auditstampclass-4" class="hash-link" aria-label="Direct link to property-created--auditstampclass-4" title="Direct link to property-created--auditstampclass-4"></a></h4><p>Audit stamp capturing the time and actor who created the View.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-definition--datahubviewdefinitionclass"><em>property</em> definition <em>: <a href="#datahub.metadata.schema_classes.DataHubViewDefinitionClass">DataHubViewDefinitionClass</a></em><a href="#property-definition--datahubviewdefinitionclass" class="hash-link" aria-label="Direct link to property-definition--datahubviewdefinitionclass" title="Direct link to property-definition--datahubviewdefinitionclass"></a></h4><p>The view itself</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-9"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-9" class="hash-link" aria-label="Direct link to property-description--none--str-9" title="Direct link to property-description--none--str-9"></a></h4><p>Description of the view</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--auditstampclass-6"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--auditstampclass-6" class="hash-link" aria-label="Direct link to property-lastmodified--auditstampclass-6" title="Direct link to property-lastmodified--auditstampclass-6"></a></h4><p>Audit stamp capturing the time and actor who last modified the View.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-9"><em>property</em> name <em>: str</em><a href="#property-name--str-9" class="hash-link" aria-label="Direct link to property-name--str-9" title="Direct link to property-name--str-9"></a></h4><p>The name of the View</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--datahubviewtypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.DataHubViewTypeClass">DataHubViewTypeClass</a></em><a href="#property-type--str--datahubviewtypeclass" class="hash-link" aria-label="Direct link to property-type--str--datahubviewtypeclass" title="Direct link to property-type--str--datahubviewtypeclass"></a></h4><p>The type of View</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubViewKeyClass"><span class="visually-hidden">DataHubViewKeyClass</span><a href="#datahub.metadata.schema_classes.DataHubViewKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubViewKeyClass" title="Direct link to datahub.metadata.schema_classes.DataHubViewKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubViewKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.DataHubViewKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a DataHub View</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-17"><em>property</em> id <em>: str</em><a href="#property-id--str-17" class="hash-link" aria-label="Direct link to property-id--str-17" title="Direct link to property-id--str-17"></a></h4><p>A unique id for the View</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataHubViewTypeClass"><span class="visually-hidden">DataHubViewTypeClass</span><a href="#datahub.metadata.schema_classes.DataHubViewTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataHubViewTypeClass" title="Direct link to datahub.metadata.schema_classes.DataHubViewTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataHubViewTypeClass</span>()<a href="#datahub.metadata.schema_classes.DataHubViewTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="global--global">GLOBAL <em>= 'GLOBAL'</em><a href="#global--global" class="hash-link" aria-label="Direct link to global--global" title="Direct link to global--global"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="personal--personal">PERSONAL <em>= 'PERSONAL'</em><a href="#personal--personal" class="hash-link" aria-label="Direct link to personal--personal" title="Direct link to personal--personal"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataJobInfoClass"><span class="visually-hidden">DataJobInfoClass</span><a href="#datahub.metadata.schema_classes.DataJobInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataJobInfoClass" title="Direct link to datahub.metadata.schema_classes.DataJobInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataJobInfoClass</span>(<span class="arg-name">name</span>, <span class="arg-name">type</span>, <span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">externalUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">flowUrn</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>, <span class="arg-name">status</span> = <span class="arg-default">None</span>, <span class="arg-name">env</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataJobInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a Data processing job</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.AzkabanJobTypeClass"><code>AzkabanJobTypeClass</code></a>]) – </li><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>externalUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>flowUrn</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeStampClass"><code>TimeStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeStampClass"><code>TimeStampClass</code></a>]) – </li><li><strong>status</strong> (<code>Union</code>[<code>None</code>, <code>str</code>, <a href="#datahub.metadata.schema_classes.JobStatusClass"><code>JobStatusClass</code></a>]) – </li><li><strong>env</strong> (<code>Union</code>[<code>None</code>, <code>str</code>, <a href="#datahub.metadata.schema_classes.FabricTypeClass"><code>FabricTypeClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--none--timestampclass-2"><em>property</em> created <em>: None | <a href="#datahub.metadata.schema_classes.TimeStampClass">TimeStampClass</a></em><a href="#property-created--none--timestampclass-2" class="hash-link" aria-label="Direct link to property-created--none--timestampclass-2" title="Direct link to property-created--none--timestampclass-2"></a></h4><p>A timestamp documenting when the asset was created in the source Data Platform (not on DataHub)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-10"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-10" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-10" title="Direct link to property-customproperties--dictstr-str-10"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-10"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-10" class="hash-link" aria-label="Direct link to property-description--none--str-10" title="Direct link to property-description--none--str-10"></a></h4><p>Job description</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-env--none--str--fabrictypeclass-2"><em>property</em> env <em>: None | str | <a href="#datahub.metadata.schema_classes.FabricTypeClass">FabricTypeClass</a></em><a href="#property-env--none--str--fabrictypeclass-2" class="hash-link" aria-label="Direct link to property-env--none--str--fabrictypeclass-2" title="Direct link to property-env--none--str--fabrictypeclass-2"></a></h4><p>Environment for this job</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-externalurl--none--str-7"><em>property</em> externalUrl <em>: None | str</em><a href="#property-externalurl--none--str-7" class="hash-link" aria-label="Direct link to property-externalurl--none--str-7" title="Direct link to property-externalurl--none--str-7"></a></h4><p>URL where the reference exist</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-flowurn--none--str"><em>property</em> flowUrn <em>: None | str</em><a href="#property-flowurn--none--str" class="hash-link" aria-label="Direct link to property-flowurn--none--str" title="Direct link to property-flowurn--none--str"></a></h4><p>DataFlow urn that this job is part of</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--none--timestampclass-2"><em>property</em> lastModified <em>: None | <a href="#datahub.metadata.schema_classes.TimeStampClass">TimeStampClass</a></em><a href="#property-lastmodified--none--timestampclass-2" class="hash-link" aria-label="Direct link to property-lastmodified--none--timestampclass-2" title="Direct link to property-lastmodified--none--timestampclass-2"></a></h4><p>A timestamp documenting when the asset was last modified in the source Data Platform (not on DataHub)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-10"><em>property</em> name <em>: str</em><a href="#property-name--str-10" class="hash-link" aria-label="Direct link to property-name--str-10" title="Direct link to property-name--str-10"></a></h4><p>Job name</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-status--none--str--jobstatusclass"><em>property</em> status <em>: None | str | <a href="#datahub.metadata.schema_classes.JobStatusClass">JobStatusClass</a></em><a href="#property-status--none--str--jobstatusclass" class="hash-link" aria-label="Direct link to property-status--none--str--jobstatusclass" title="Direct link to property-status--none--str--jobstatusclass"></a></h4><p>Status of the job - Deprecated for Data Process Instance model.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--azkabanjobtypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.AzkabanJobTypeClass">AzkabanJobTypeClass</a></em><a href="#property-type--str--azkabanjobtypeclass" class="hash-link" aria-label="Direct link to property-type--str--azkabanjobtypeclass" title="Direct link to property-type--str--azkabanjobtypeclass"></a></h4><p>Datajob type
|
||
*NOTE<!-- -->*<!-- -->*: AzkabanJobType is deprecated. Please use strings instead.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataJobInputOutputClass"><span class="visually-hidden">DataJobInputOutputClass</span><a href="#datahub.metadata.schema_classes.DataJobInputOutputClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataJobInputOutputClass" title="Direct link to datahub.metadata.schema_classes.DataJobInputOutputClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataJobInputOutputClass</span>(<span class="arg-name">inputDatasets</span>, <span class="arg-name">outputDatasets</span>, <span class="arg-name">inputDatasetEdges</span> = <span class="arg-default">None</span>, <span class="arg-name">outputDatasetEdges</span> = <span class="arg-default">None</span>, <span class="arg-name">inputDatajobs</span> = <span class="arg-default">None</span>, <span class="arg-name">inputDatajobEdges</span> = <span class="arg-default">None</span>, <span class="arg-name">inputDatasetFields</span> = <span class="arg-default">None</span>, <span class="arg-name">outputDatasetFields</span> = <span class="arg-default">None</span>, <span class="arg-name">fineGrainedLineages</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataJobInputOutputClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about the inputs and outputs of a Data processing job</p><ul><li><strong>Parameters:</strong><ul><li><strong>inputDatasets</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li><li><strong>outputDatasets</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li><li><strong>inputDatasetEdges</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.EdgeClass"><code>EdgeClass</code></a>]]) – </li><li><strong>outputDatasetEdges</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.EdgeClass"><code>EdgeClass</code></a>]]) – </li><li><strong>inputDatajobs</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>inputDatajobEdges</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.EdgeClass"><code>EdgeClass</code></a>]]) – </li><li><strong>inputDatasetFields</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>outputDatasetFields</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>fineGrainedLineages</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.FineGrainedLineageClass"><code>FineGrainedLineageClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-finegrainedlineages--none--listfinegrainedlineageclass"><em>property</em> fineGrainedLineages <em>: None | List[<a href="#datahub.metadata.schema_classes.FineGrainedLineageClass">FineGrainedLineageClass</a>]</em><a href="#property-finegrainedlineages--none--listfinegrainedlineageclass" class="hash-link" aria-label="Direct link to property-finegrainedlineages--none--listfinegrainedlineageclass" title="Direct link to property-finegrainedlineages--none--listfinegrainedlineageclass"></a></h4><p>Fine-grained column-level lineages
|
||
Not currently supported in the UI
|
||
Use UpstreamLineage aspect for datasets to express Column Level Lineage for the UI</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-inputdatajobedges--none--listedgeclass"><em>property</em> inputDatajobEdges <em>: None | List[<a href="#datahub.metadata.schema_classes.EdgeClass">EdgeClass</a>]</em><a href="#property-inputdatajobedges--none--listedgeclass" class="hash-link" aria-label="Direct link to property-inputdatajobedges--none--listedgeclass" title="Direct link to property-inputdatajobedges--none--listedgeclass"></a></h4><p>Input datajobs that this data job depends on</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-inputdatajobs--none--liststr"><em>property</em> inputDatajobs <em>: None | List<!-- -->[str]</em><a href="#property-inputdatajobs--none--liststr" class="hash-link" aria-label="Direct link to property-inputdatajobs--none--liststr" title="Direct link to property-inputdatajobs--none--liststr"></a></h4><p>Input datajobs that this data job depends on
|
||
Deprecated! Use inputDatajobEdges instead.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-inputdatasetedges--none--listedgeclass"><em>property</em> inputDatasetEdges <em>: None | List[<a href="#datahub.metadata.schema_classes.EdgeClass">EdgeClass</a>]</em><a href="#property-inputdatasetedges--none--listedgeclass" class="hash-link" aria-label="Direct link to property-inputdatasetedges--none--listedgeclass" title="Direct link to property-inputdatasetedges--none--listedgeclass"></a></h4><p>Input datasets consumed by the data job during processing</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-inputdatasetfields--none--liststr"><em>property</em> inputDatasetFields <em>: None | List<!-- -->[str]</em><a href="#property-inputdatasetfields--none--liststr" class="hash-link" aria-label="Direct link to property-inputdatasetfields--none--liststr" title="Direct link to property-inputdatasetfields--none--liststr"></a></h4><p>Fields of the input datasets used by this job</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-inputdatasets--liststr"><em>property</em> inputDatasets <em>: List<!-- -->[str]</em><a href="#property-inputdatasets--liststr" class="hash-link" aria-label="Direct link to property-inputdatasets--liststr" title="Direct link to property-inputdatasets--liststr"></a></h4><p>Input datasets consumed by the data job during processing
|
||
Deprecated! Use inputDatasetEdges instead.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-outputdatasetedges--none--listedgeclass"><em>property</em> outputDatasetEdges <em>: None | List[<a href="#datahub.metadata.schema_classes.EdgeClass">EdgeClass</a>]</em><a href="#property-outputdatasetedges--none--listedgeclass" class="hash-link" aria-label="Direct link to property-outputdatasetedges--none--listedgeclass" title="Direct link to property-outputdatasetedges--none--listedgeclass"></a></h4><p>Output datasets produced by the data job during processing</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-outputdatasetfields--none--liststr"><em>property</em> outputDatasetFields <em>: None | List<!-- -->[str]</em><a href="#property-outputdatasetfields--none--liststr" class="hash-link" aria-label="Direct link to property-outputdatasetfields--none--liststr" title="Direct link to property-outputdatasetfields--none--liststr"></a></h4><p>Fields of the output datasets this job writes to</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-outputdatasets--liststr"><em>property</em> outputDatasets <em>: List<!-- -->[str]</em><a href="#property-outputdatasets--liststr" class="hash-link" aria-label="Direct link to property-outputdatasets--liststr" title="Direct link to property-outputdatasets--liststr"></a></h4><p>Output datasets produced by the data job during processing
|
||
Deprecated! Use outputDatasetEdges instead.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataJobKeyClass"><span class="visually-hidden">DataJobKeyClass</span><a href="#datahub.metadata.schema_classes.DataJobKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataJobKeyClass" title="Direct link to datahub.metadata.schema_classes.DataJobKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataJobKeyClass</span>(<span class="arg-name">flow</span>, <span class="arg-name">jobId</span>)<a href="#datahub.metadata.schema_classes.DataJobKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Data Job</p><ul><li><strong>Parameters:</strong><ul><li><strong>flow</strong> (<code>str</code>)</li><li><strong>jobId</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-flow--str"><em>property</em> flow <em>: str</em><a href="#property-flow--str" class="hash-link" aria-label="Direct link to property-flow--str" title="Direct link to property-flow--str"></a></h4><p>Standardized data processing flow urn representing the flow for the job</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-jobid--str"><em>property</em> jobId <em>: str</em><a href="#property-jobid--str" class="hash-link" aria-label="Direct link to property-jobid--str" title="Direct link to property-jobid--str"></a></h4><p>Unique Identifier of the data job</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataJobSnapshotClass"><span class="visually-hidden">DataJobSnapshotClass</span><a href="#datahub.metadata.schema_classes.DataJobSnapshotClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataJobSnapshotClass" title="Direct link to datahub.metadata.schema_classes.DataJobSnapshotClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataJobSnapshotClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">aspects</span>)<a href="#datahub.metadata.schema_classes.DataJobSnapshotClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A metadata snapshot for a specific DataJob entity.</p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>aspects</strong> (<code>List</code>[<code>Union</code>[<a href="#datahub.metadata.schema_classes.DataJobKeyClass"><code>DataJobKeyClass</code></a>, <a href="#datahub.metadata.schema_classes.DataJobInfoClass"><code>DataJobInfoClass</code></a>, <a href="#datahub.metadata.schema_classes.DataJobInputOutputClass"><code>DataJobInputOutputClass</code></a>, <a href="#datahub.metadata.schema_classes.EditableDataJobPropertiesClass"><code>EditableDataJobPropertiesClass</code></a>, <a href="#datahub.metadata.schema_classes.OwnershipClass"><code>OwnershipClass</code></a>, <a href="#datahub.metadata.schema_classes.StatusClass"><code>StatusClass</code></a>, <a href="#datahub.metadata.schema_classes.GlobalTagsClass"><code>GlobalTagsClass</code></a>, <a href="#datahub.metadata.schema_classes.BrowsePathsClass"><code>BrowsePathsClass</code></a>, <a href="#datahub.metadata.schema_classes.GlossaryTermsClass"><code>GlossaryTermsClass</code></a>, <a href="#datahub.metadata.schema_classes.InstitutionalMemoryClass"><code>InstitutionalMemoryClass</code></a>, <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass"><code>DataPlatformInstanceClass</code></a>, <a href="#datahub.metadata.schema_classes.BrowsePathsV2Class"><code>BrowsePathsV2Class</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspects--listdatajobkeyclass--datajobinfoclass--datajobinputoutputclass--editabledatajobpropertiesclass--ownershipclass--statusclass--globaltagsclass--browsepathsclass--glossarytermsclass--institutionalmemoryclass--dataplatforminstanceclass--browsepathsv2class"><em>property</em> aspects <em>: List[<a href="#datahub.metadata.schema_classes.DataJobKeyClass">DataJobKeyClass</a> | <a href="#datahub.metadata.schema_classes.DataJobInfoClass">DataJobInfoClass</a> | <a href="#datahub.metadata.schema_classes.DataJobInputOutputClass">DataJobInputOutputClass</a> | <a href="#datahub.metadata.schema_classes.EditableDataJobPropertiesClass">EditableDataJobPropertiesClass</a> | <a href="#datahub.metadata.schema_classes.OwnershipClass">OwnershipClass</a> | <a href="#datahub.metadata.schema_classes.StatusClass">StatusClass</a> | <a href="#datahub.metadata.schema_classes.GlobalTagsClass">GlobalTagsClass</a> | <a href="#datahub.metadata.schema_classes.BrowsePathsClass">BrowsePathsClass</a> | <a href="#datahub.metadata.schema_classes.GlossaryTermsClass">GlossaryTermsClass</a> | <a href="#datahub.metadata.schema_classes.InstitutionalMemoryClass">InstitutionalMemoryClass</a> | <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass">DataPlatformInstanceClass</a> | <a href="#datahub.metadata.schema_classes.BrowsePathsV2Class">BrowsePathsV2Class</a>]</em><a href="#property-aspects--listdatajobkeyclass--datajobinfoclass--datajobinputoutputclass--editabledatajobpropertiesclass--ownershipclass--statusclass--globaltagsclass--browsepathsclass--glossarytermsclass--institutionalmemoryclass--dataplatforminstanceclass--browsepathsv2class" class="hash-link" aria-label="Direct link to property-aspects--listdatajobkeyclass--datajobinfoclass--datajobinputoutputclass--editabledatajobpropertiesclass--ownershipclass--statusclass--globaltagsclass--browsepathsclass--glossarytermsclass--institutionalmemoryclass--dataplatforminstanceclass--browsepathsv2class" title="Direct link to property-aspects--listdatajobkeyclass--datajobinfoclass--datajobinputoutputclass--editabledatajobpropertiesclass--ownershipclass--statusclass--globaltagsclass--browsepathsclass--glossarytermsclass--institutionalmemoryclass--dataplatforminstanceclass--browsepathsv2class"></a></h4><p>The list of metadata aspects associated with the data job. Depending on the use case, this can either be all, or a selection, of supported aspects.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-7"><em>property</em> urn <em>: str</em><a href="#property-urn--str-7" class="hash-link" aria-label="Direct link to property-urn--str-7" title="Direct link to property-urn--str-7"></a></h4><p>URN for the entity the metadata snapshot is associated with.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataPlatformInfoClass"><span class="visually-hidden">DataPlatformInfoClass</span><a href="#datahub.metadata.schema_classes.DataPlatformInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataPlatformInfoClass" title="Direct link to datahub.metadata.schema_classes.DataPlatformInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataPlatformInfoClass</span>(<span class="arg-name">name</span>, <span class="arg-name">type</span>, <span class="arg-name">datasetNameDelimiter</span>, <span class="arg-name">displayName</span> = <span class="arg-default">None</span>, <span class="arg-name">logoUrl</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataPlatformInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a data platform</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.PlatformTypeClass"><code>PlatformTypeClass</code></a>]) – </li><li><strong>datasetNameDelimiter</strong> (<code>str</code>)</li><li><strong>displayName</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>logoUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-datasetnamedelimiter--str"><em>property</em> datasetNameDelimiter <em>: str</em><a href="#property-datasetnamedelimiter--str" class="hash-link" aria-label="Direct link to property-datasetnamedelimiter--str" title="Direct link to property-datasetnamedelimiter--str"></a></h4><p>The delimiter in the dataset names on the data platform, e.g. ‘/’ for HDFS and ‘.’ for Oracle</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-displayname--none--str-3"><em>property</em> displayName <em>: None | str</em><a href="#property-displayname--none--str-3" class="hash-link" aria-label="Direct link to property-displayname--none--str-3" title="Direct link to property-displayname--none--str-3"></a></h4><p>The name that will be used for displaying a platform type.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-logourl--none--str"><em>property</em> logoUrl <em>: None | str</em><a href="#property-logourl--none--str" class="hash-link" aria-label="Direct link to property-logourl--none--str" title="Direct link to property-logourl--none--str"></a></h4><p>The URL for a logo associated with the platform</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-11"><em>property</em> name <em>: str</em><a href="#property-name--str-11" class="hash-link" aria-label="Direct link to property-name--str-11" title="Direct link to property-name--str-11"></a></h4><p>Name of the data platform</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--platformtypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.PlatformTypeClass">PlatformTypeClass</a></em><a href="#property-type--str--platformtypeclass" class="hash-link" aria-label="Direct link to property-type--str--platformtypeclass" title="Direct link to property-type--str--platformtypeclass"></a></h4><p>Platform type this data platform describes</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataPlatformInstanceClass"><span class="visually-hidden">DataPlatformInstanceClass</span><a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataPlatformInstanceClass" title="Direct link to datahub.metadata.schema_classes.DataPlatformInstanceClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataPlatformInstanceClass</span>(<span class="arg-name">platform</span>, <span class="arg-name">instance</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>The specific instance of the data platform that this entity belongs to</p><ul><li><strong>Parameters:</strong><ul><li><strong>platform</strong> (<code>str</code>)</li><li><strong>instance</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-instance--none--str"><em>property</em> instance <em>: None | str</em><a href="#property-instance--none--str" class="hash-link" aria-label="Direct link to property-instance--none--str" title="Direct link to property-instance--none--str"></a></h4><p>Instance of the data platform (e.g. db instance)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-platform--str"><em>property</em> platform <em>: str</em><a href="#property-platform--str" class="hash-link" aria-label="Direct link to property-platform--str" title="Direct link to property-platform--str"></a></h4><p>Data Platform</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataPlatformInstanceKeyClass"><span class="visually-hidden">DataPlatformInstanceKeyClass</span><a href="#datahub.metadata.schema_classes.DataPlatformInstanceKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataPlatformInstanceKeyClass" title="Direct link to datahub.metadata.schema_classes.DataPlatformInstanceKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataPlatformInstanceKeyClass</span>(<span class="arg-name">platform</span>, <span class="arg-name">instance</span>)<a href="#datahub.metadata.schema_classes.DataPlatformInstanceKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Dataset</p><ul><li><strong>Parameters:</strong><ul><li><strong>platform</strong> (<code>str</code>)</li><li><strong>instance</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-instance--str"><em>property</em> instance <em>: str</em><a href="#property-instance--str" class="hash-link" aria-label="Direct link to property-instance--str" title="Direct link to property-instance--str"></a></h4><p>Unique instance id</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-platform--str-1"><em>property</em> platform <em>: str</em><a href="#property-platform--str-1" class="hash-link" aria-label="Direct link to property-platform--str-1" title="Direct link to property-platform--str-1"></a></h4><p>Data platform urn associated with the instance</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataPlatformInstancePropertiesClass"><span class="visually-hidden">DataPlatformInstancePropertiesClass</span><a href="#datahub.metadata.schema_classes.DataPlatformInstancePropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataPlatformInstancePropertiesClass" title="Direct link to datahub.metadata.schema_classes.DataPlatformInstancePropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataPlatformInstancePropertiesClass</span>(<span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">externalUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">name</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataPlatformInstancePropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties associated with a Data Platform Instance</p><ul><li><strong>Parameters:</strong><ul><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>externalUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-11"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-11" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-11" title="Direct link to property-customproperties--dictstr-str-11"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-11"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-11" class="hash-link" aria-label="Direct link to property-description--none--str-11" title="Direct link to property-description--none--str-11"></a></h4><p>Documentation of the Data Platform Instance</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-externalurl--none--str-8"><em>property</em> externalUrl <em>: None | str</em><a href="#property-externalurl--none--str-8" class="hash-link" aria-label="Direct link to property-externalurl--none--str-8" title="Direct link to property-externalurl--none--str-8"></a></h4><p>URL where the reference exist</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--none--str-2"><em>property</em> name <em>: None | str</em><a href="#property-name--none--str-2" class="hash-link" aria-label="Direct link to property-name--none--str-2" title="Direct link to property-name--none--str-2"></a></h4><p>Display name of the Data Platform Instance</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataPlatformKeyClass"><span class="visually-hidden">DataPlatformKeyClass</span><a href="#datahub.metadata.schema_classes.DataPlatformKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataPlatformKeyClass" title="Direct link to datahub.metadata.schema_classes.DataPlatformKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataPlatformKeyClass</span>(<span class="arg-name">platformName</span>)<a href="#datahub.metadata.schema_classes.DataPlatformKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Data Platform</p><ul><li><strong>Parameters:</strong><strong>platformName</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-platformname--str"><em>property</em> platformName <em>: str</em><a href="#property-platformname--str" class="hash-link" aria-label="Direct link to property-platformname--str" title="Direct link to property-platformname--str"></a></h4><p>Data platform name i.e. hdfs, oracle, espresso</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataPlatformSnapshotClass"><span class="visually-hidden">DataPlatformSnapshotClass</span><a href="#datahub.metadata.schema_classes.DataPlatformSnapshotClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataPlatformSnapshotClass" title="Direct link to datahub.metadata.schema_classes.DataPlatformSnapshotClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataPlatformSnapshotClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">aspects</span>)<a href="#datahub.metadata.schema_classes.DataPlatformSnapshotClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A metadata snapshot for a specific dataplatform entity.</p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>aspects</strong> (<code>List</code>[<code>Union</code>[<a href="#datahub.metadata.schema_classes.DataPlatformKeyClass"><code>DataPlatformKeyClass</code></a>, <a href="#datahub.metadata.schema_classes.DataPlatformInfoClass"><code>DataPlatformInfoClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspects--listdataplatformkeyclass--dataplatforminfoclass"><em>property</em> aspects <em>: List[<a href="#datahub.metadata.schema_classes.DataPlatformKeyClass">DataPlatformKeyClass</a> | <a href="#datahub.metadata.schema_classes.DataPlatformInfoClass">DataPlatformInfoClass</a>]</em><a href="#property-aspects--listdataplatformkeyclass--dataplatforminfoclass" class="hash-link" aria-label="Direct link to property-aspects--listdataplatformkeyclass--dataplatforminfoclass" title="Direct link to property-aspects--listdataplatformkeyclass--dataplatforminfoclass"></a></h4><p>The list of metadata aspects associated with the data platform. Depending on the use case, this can either be all, or a selection, of supported aspects.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-8"><em>property</em> urn <em>: str</em><a href="#property-urn--str-8" class="hash-link" aria-label="Direct link to property-urn--str-8" title="Direct link to property-urn--str-8"></a></h4><p>URN for the entity the metadata snapshot is associated with.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataProcessInfoClass"><span class="visually-hidden">DataProcessInfoClass</span><a href="#datahub.metadata.schema_classes.DataProcessInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataProcessInfoClass" title="Direct link to datahub.metadata.schema_classes.DataProcessInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataProcessInfoClass</span>(<span class="arg-name">inputs</span> = <span class="arg-default">None</span>, <span class="arg-name">outputs</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataProcessInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>The inputs and outputs of this data process</p><ul><li><strong>Parameters:</strong><ul><li><strong>inputs</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>outputs</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-inputs--none--liststr-1"><em>property</em> inputs <em>: None | List<!-- -->[str]</em><a href="#property-inputs--none--liststr-1" class="hash-link" aria-label="Direct link to property-inputs--none--liststr-1" title="Direct link to property-inputs--none--liststr-1"></a></h4><p>the inputs of the data process</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-outputs--none--liststr"><em>property</em> outputs <em>: None | List<!-- -->[str]</em><a href="#property-outputs--none--liststr" class="hash-link" aria-label="Direct link to property-outputs--none--liststr" title="Direct link to property-outputs--none--liststr"></a></h4><p>the outputs of the data process</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataProcessInstanceInputClass"><span class="visually-hidden">DataProcessInstanceInputClass</span><a href="#datahub.metadata.schema_classes.DataProcessInstanceInputClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataProcessInstanceInputClass" title="Direct link to datahub.metadata.schema_classes.DataProcessInstanceInputClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataProcessInstanceInputClass</span>(<span class="arg-name">inputs</span>, <span class="arg-name">inputEdges</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataProcessInstanceInputClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about the inputs datasets of a Data process</p><ul><li><strong>Parameters:</strong><ul><li><strong>inputs</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li><li><strong>inputEdges</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.EdgeClass"><code>EdgeClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-inputedges--none--listedgeclass-1"><em>property</em> inputEdges <em>: None | List[<a href="#datahub.metadata.schema_classes.EdgeClass">EdgeClass</a>]</em><a href="#property-inputedges--none--listedgeclass-1" class="hash-link" aria-label="Direct link to property-inputedges--none--listedgeclass-1" title="Direct link to property-inputedges--none--listedgeclass-1"></a></h4><p>Input assets consumed by the data process instance, with additional metadata.
|
||
Counts as lineage.
|
||
Will eventually deprecate the inputs field.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-inputs--liststr"><em>property</em> inputs <em>: List<!-- -->[str]</em><a href="#property-inputs--liststr" class="hash-link" aria-label="Direct link to property-inputs--liststr" title="Direct link to property-inputs--liststr"></a></h4><p>Input assets consumed</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataProcessInstanceKeyClass"><span class="visually-hidden">DataProcessInstanceKeyClass</span><a href="#datahub.metadata.schema_classes.DataProcessInstanceKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataProcessInstanceKeyClass" title="Direct link to datahub.metadata.schema_classes.DataProcessInstanceKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataProcessInstanceKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.DataProcessInstanceKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for an Asset DataProcessInstance</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-18"><em>property</em> id <em>: str</em><a href="#property-id--str-18" class="hash-link" aria-label="Direct link to property-id--str-18" title="Direct link to property-id--str-18"></a></h4><p>A unique id for the DataProcessInstance . Should be separate from the name used for displaying a DataProcessInstance.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataProcessInstanceOutputClass"><span class="visually-hidden">DataProcessInstanceOutputClass</span><a href="#datahub.metadata.schema_classes.DataProcessInstanceOutputClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataProcessInstanceOutputClass" title="Direct link to datahub.metadata.schema_classes.DataProcessInstanceOutputClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataProcessInstanceOutputClass</span>(<span class="arg-name">outputs</span>, <span class="arg-name">outputEdges</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataProcessInstanceOutputClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about the outputs of a Data process</p><ul><li><strong>Parameters:</strong><ul><li><strong>outputs</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li><li><strong>outputEdges</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.EdgeClass"><code>EdgeClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-outputedges--none--listedgeclass"><em>property</em> outputEdges <em>: None | List[<a href="#datahub.metadata.schema_classes.EdgeClass">EdgeClass</a>]</em><a href="#property-outputedges--none--listedgeclass" class="hash-link" aria-label="Direct link to property-outputedges--none--listedgeclass" title="Direct link to property-outputedges--none--listedgeclass"></a></h4><p>Output assets produced by the data process instance during processing, with additional metadata.
|
||
Counts as lineage.
|
||
Will eventually deprecate the outputs field.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-outputs--liststr"><em>property</em> outputs <em>: List<!-- -->[str]</em><a href="#property-outputs--liststr" class="hash-link" aria-label="Direct link to property-outputs--liststr" title="Direct link to property-outputs--liststr"></a></h4><p>Output assets produced</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataProcessInstancePropertiesClass"><span class="visually-hidden">DataProcessInstancePropertiesClass</span><a href="#datahub.metadata.schema_classes.DataProcessInstancePropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataProcessInstancePropertiesClass" title="Direct link to datahub.metadata.schema_classes.DataProcessInstancePropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataProcessInstancePropertiesClass</span>(<span class="arg-name">name</span>, <span class="arg-name">created</span>, <span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">externalUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">type</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataProcessInstancePropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>The inputs and outputs of this data process</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>created</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>externalUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>type</strong> (<code>Union</code>[<code>None</code>, <code>str</code>, <a href="#datahub.metadata.schema_classes.DataProcessTypeClass"><code>DataProcessTypeClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--auditstampclass-5"><em>property</em> created <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--auditstampclass-5" class="hash-link" aria-label="Direct link to property-created--auditstampclass-5" title="Direct link to property-created--auditstampclass-5"></a></h4><p>Audit stamp containing who reported the lineage and when</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-12"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-12" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-12" title="Direct link to property-customproperties--dictstr-str-12"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-externalurl--none--str-9"><em>property</em> externalUrl <em>: None | str</em><a href="#property-externalurl--none--str-9" class="hash-link" aria-label="Direct link to property-externalurl--none--str-9" title="Direct link to property-externalurl--none--str-9"></a></h4><p>URL where the reference exist</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-12"><em>property</em> name <em>: str</em><a href="#property-name--str-12" class="hash-link" aria-label="Direct link to property-name--str-12" title="Direct link to property-name--str-12"></a></h4><p>Process name</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--none--str--dataprocesstypeclass"><em>property</em> type <em>: None | str | <a href="#datahub.metadata.schema_classes.DataProcessTypeClass">DataProcessTypeClass</a></em><a href="#property-type--none--str--dataprocesstypeclass" class="hash-link" aria-label="Direct link to property-type--none--str--dataprocesstypeclass" title="Direct link to property-type--none--str--dataprocesstypeclass"></a></h4><p>Process type</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataProcessInstanceRelationshipsClass"><span class="visually-hidden">DataProcessInstanceRelationshipsClass</span><a href="#datahub.metadata.schema_classes.DataProcessInstanceRelationshipsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataProcessInstanceRelationshipsClass" title="Direct link to datahub.metadata.schema_classes.DataProcessInstanceRelationshipsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataProcessInstanceRelationshipsClass</span>(<span class="arg-name">upstreamInstances</span>, <span class="arg-name">parentTemplate</span> = <span class="arg-default">None</span>, <span class="arg-name">parentInstance</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataProcessInstanceRelationshipsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about Data process relationships</p><ul><li><strong>Parameters:</strong><ul><li><strong>upstreamInstances</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li><li><strong>parentTemplate</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>parentInstance</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-parentinstance--none--str"><em>property</em> parentInstance <em>: None | str</em><a href="#property-parentinstance--none--str" class="hash-link" aria-label="Direct link to property-parentinstance--none--str" title="Direct link to property-parentinstance--none--str"></a></h4><p>The parent DataProcessInstance where it belongs to.
|
||
If it is a Airflow Task then it should belong to an Airflow Dag run as well
|
||
which will be another DataProcessInstance</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-parenttemplate--none--str"><em>property</em> parentTemplate <em>: None | str</em><a href="#property-parenttemplate--none--str" class="hash-link" aria-label="Direct link to property-parenttemplate--none--str" title="Direct link to property-parenttemplate--none--str"></a></h4><p>The parent entity whose run instance it is</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-upstreaminstances--liststr"><em>property</em> upstreamInstances <em>: List<!-- -->[str]</em><a href="#property-upstreaminstances--liststr" class="hash-link" aria-label="Direct link to property-upstreaminstances--liststr" title="Direct link to property-upstreaminstances--liststr"></a></h4><p>Input DataProcessInstance which triggered this dataprocess instance</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataProcessInstanceRunEventClass"><span class="visually-hidden">DataProcessInstanceRunEventClass</span><a href="#datahub.metadata.schema_classes.DataProcessInstanceRunEventClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataProcessInstanceRunEventClass" title="Direct link to datahub.metadata.schema_classes.DataProcessInstanceRunEventClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataProcessInstanceRunEventClass</span>(<span class="arg-name">timestampMillis</span>, <span class="arg-name">status</span>, <span class="arg-name">eventGranularity</span> = <span class="arg-default">None</span>, <span class="arg-name">partitionSpec</span> = <span class="arg-default">None</span>, <span class="arg-name">messageId</span> = <span class="arg-default">None</span>, <span class="arg-name">externalUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">attempt</span> = <span class="arg-default">None</span>, <span class="arg-name">result</span> = <span class="arg-default">None</span>, <span class="arg-name">durationMillis</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataProcessInstanceRunEventClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>An event representing the current status of data process run.
|
||
DataProcessRunEvent should be used for reporting the status of a dataProcess’ run.</p><ul><li><strong>Parameters:</strong><ul><li><strong>timestampMillis</strong> (<code>int</code>)</li><li><strong>status</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.DataProcessRunStatusClass"><code>DataProcessRunStatusClass</code></a>]) – </li><li><strong>eventGranularity</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeWindowSizeClass"><code>TimeWindowSizeClass</code></a>]) – </li><li><strong>partitionSpec</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.PartitionSpecClass"><code>PartitionSpecClass</code></a>]) – </li><li><strong>messageId</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>externalUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>attempt</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>result</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.DataProcessInstanceRunResultClass"><code>DataProcessInstanceRunResultClass</code></a>]) – </li><li><strong>durationMillis</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="aspect_type--classvarstr--timeseries-3">ASPECT_TYPE <em>: <code>ClassVar</code>[<code>str</code>]</em> <em>= 'timeseries'</em><a href="#aspect_type--classvarstr--timeseries-3" class="hash-link" aria-label="Direct link to aspect_type--classvarstr--timeseries-3" title="Direct link to aspect_type--classvarstr--timeseries-3"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-attempt--none--int"><em>property</em> attempt <em>: None | int</em><a href="#property-attempt--none--int" class="hash-link" aria-label="Direct link to property-attempt--none--int" title="Direct link to property-attempt--none--int"></a></h4><p>Return the try number that this Instance Run is in</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-durationmillis--none--int"><em>property</em> durationMillis <em>: None | int</em><a href="#property-durationmillis--none--int" class="hash-link" aria-label="Direct link to property-durationmillis--none--int" title="Direct link to property-durationmillis--none--int"></a></h4><p>The duration of the run in milliseconds.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-eventgranularity--none--timewindowsizeclass-3"><em>property</em> eventGranularity <em>: None | <a href="#datahub.metadata.schema_classes.TimeWindowSizeClass">TimeWindowSizeClass</a></em><a href="#property-eventgranularity--none--timewindowsizeclass-3" class="hash-link" aria-label="Direct link to property-eventgranularity--none--timewindowsizeclass-3" title="Direct link to property-eventgranularity--none--timewindowsizeclass-3"></a></h4><p>Granularity of the event if applicable</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-externalurl--none--str-10"><em>property</em> externalUrl <em>: None | str</em><a href="#property-externalurl--none--str-10" class="hash-link" aria-label="Direct link to property-externalurl--none--str-10" title="Direct link to property-externalurl--none--str-10"></a></h4><p>URL where the reference exist</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-messageid--none--str-3"><em>property</em> messageId <em>: None | str</em><a href="#property-messageid--none--str-3" class="hash-link" aria-label="Direct link to property-messageid--none--str-3" title="Direct link to property-messageid--none--str-3"></a></h4><p>The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-partitionspec--partitionspecclass--none-3"><em>property</em> partitionSpec <em>: <a href="#datahub.metadata.schema_classes.PartitionSpecClass">PartitionSpecClass</a> | None</em><a href="#property-partitionspec--partitionspecclass--none-3" class="hash-link" aria-label="Direct link to property-partitionspec--partitionspecclass--none-3" title="Direct link to property-partitionspec--partitionspecclass--none-3"></a></h4><p>The optional partition specification.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-result--none--dataprocessinstancerunresultclass"><em>property</em> result <em>: None | <a href="#datahub.metadata.schema_classes.DataProcessInstanceRunResultClass">DataProcessInstanceRunResultClass</a></em><a href="#property-result--none--dataprocessinstancerunresultclass" class="hash-link" aria-label="Direct link to property-result--none--dataprocessinstancerunresultclass" title="Direct link to property-result--none--dataprocessinstancerunresultclass"></a></h4><p>The final result of the Data Processing run.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-status--str--dataprocessrunstatusclass"><em>property</em> status <em>: str | <a href="#datahub.metadata.schema_classes.DataProcessRunStatusClass">DataProcessRunStatusClass</a></em><a href="#property-status--str--dataprocessrunstatusclass" class="hash-link" aria-label="Direct link to property-status--str--dataprocessrunstatusclass" title="Direct link to property-status--str--dataprocessrunstatusclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-timestampmillis--int-3"><em>property</em> timestampMillis <em>: int</em><a href="#property-timestampmillis--int-3" class="hash-link" aria-label="Direct link to property-timestampmillis--int-3" title="Direct link to property-timestampmillis--int-3"></a></h4><p>The event timestamp field as epoch at UTC in milli seconds.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataProcessInstanceRunResultClass"><span class="visually-hidden">DataProcessInstanceRunResultClass</span><a href="#datahub.metadata.schema_classes.DataProcessInstanceRunResultClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataProcessInstanceRunResultClass" title="Direct link to datahub.metadata.schema_classes.DataProcessInstanceRunResultClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataProcessInstanceRunResultClass</span>(<span class="arg-name">type</span>, <span class="arg-name">nativeResultType</span>)<a href="#datahub.metadata.schema_classes.DataProcessInstanceRunResultClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.RunResultTypeClass"><code>RunResultTypeClass</code></a>]) – </li><li><strong>nativeResultType</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-nativeresulttype--str"><em>property</em> nativeResultType <em>: str</em><a href="#property-nativeresulttype--str" class="hash-link" aria-label="Direct link to property-nativeresulttype--str" title="Direct link to property-nativeresulttype--str"></a></h4><p>It identifies the system where the native result comes from like Airflow, Azkaban, etc..</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--runresulttypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.RunResultTypeClass">RunResultTypeClass</a></em><a href="#property-type--str--runresulttypeclass" class="hash-link" aria-label="Direct link to property-type--str--runresulttypeclass" title="Direct link to property-type--str--runresulttypeclass"></a></h4><p>The final result, e.g. SUCCESS, FAILURE, SKIPPED, or UP_FOR_RETRY.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataProcessKeyClass"><span class="visually-hidden">DataProcessKeyClass</span><a href="#datahub.metadata.schema_classes.DataProcessKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataProcessKeyClass" title="Direct link to datahub.metadata.schema_classes.DataProcessKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataProcessKeyClass</span>(<span class="arg-name">name</span>, <span class="arg-name">orchestrator</span>, <span class="arg-name">origin</span>)<a href="#datahub.metadata.schema_classes.DataProcessKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Data Process</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>orchestrator</strong> (<code>str</code>)</li><li><strong>origin</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.FabricTypeClass"><code>FabricTypeClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-13"><em>property</em> name <em>: str</em><a href="#property-name--str-13" class="hash-link" aria-label="Direct link to property-name--str-13" title="Direct link to property-name--str-13"></a></h4><p>Process name i.e. an ETL job name</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-orchestrator--str-1"><em>property</em> orchestrator <em>: str</em><a href="#property-orchestrator--str-1" class="hash-link" aria-label="Direct link to property-orchestrator--str-1" title="Direct link to property-orchestrator--str-1"></a></h4><p>Standardized Orchestrator where data process is defined.
|
||
TODO: Migrate towards something that can be validated like DataPlatform urn</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-origin--str--fabrictypeclass"><em>property</em> origin <em>: str | <a href="#datahub.metadata.schema_classes.FabricTypeClass">FabricTypeClass</a></em><a href="#property-origin--str--fabrictypeclass" class="hash-link" aria-label="Direct link to property-origin--str--fabrictypeclass" title="Direct link to property-origin--str--fabrictypeclass"></a></h4><p>Fabric type where dataset belongs to or where it was generated.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataProcessRunStatusClass"><span class="visually-hidden">DataProcessRunStatusClass</span><a href="#datahub.metadata.schema_classes.DataProcessRunStatusClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataProcessRunStatusClass" title="Direct link to datahub.metadata.schema_classes.DataProcessRunStatusClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataProcessRunStatusClass</span>()<a href="#datahub.metadata.schema_classes.DataProcessRunStatusClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="complete--complete-1">COMPLETE <em>= 'COMPLETE'</em><a href="#complete--complete-1" class="hash-link" aria-label="Direct link to complete--complete-1" title="Direct link to complete--complete-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="started--started">STARTED <em>= 'STARTED'</em><a href="#started--started" class="hash-link" aria-label="Direct link to started--started" title="Direct link to started--started"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataProcessSnapshotClass"><span class="visually-hidden">DataProcessSnapshotClass</span><a href="#datahub.metadata.schema_classes.DataProcessSnapshotClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataProcessSnapshotClass" title="Direct link to datahub.metadata.schema_classes.DataProcessSnapshotClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataProcessSnapshotClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">aspects</span>)<a href="#datahub.metadata.schema_classes.DataProcessSnapshotClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A metadata snapshot for a specific Data process entity.</p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>aspects</strong> (<code>List</code>[<code>Union</code>[<a href="#datahub.metadata.schema_classes.DataProcessKeyClass"><code>DataProcessKeyClass</code></a>, <a href="#datahub.metadata.schema_classes.OwnershipClass"><code>OwnershipClass</code></a>, <a href="#datahub.metadata.schema_classes.DataProcessInfoClass"><code>DataProcessInfoClass</code></a>, <a href="#datahub.metadata.schema_classes.StatusClass"><code>StatusClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspects--listdataprocesskeyclass--ownershipclass--dataprocessinfoclass--statusclass"><em>property</em> aspects <em>: List[<a href="#datahub.metadata.schema_classes.DataProcessKeyClass">DataProcessKeyClass</a> | <a href="#datahub.metadata.schema_classes.OwnershipClass">OwnershipClass</a> | <a href="#datahub.metadata.schema_classes.DataProcessInfoClass">DataProcessInfoClass</a> | <a href="#datahub.metadata.schema_classes.StatusClass">StatusClass</a>]</em><a href="#property-aspects--listdataprocesskeyclass--ownershipclass--dataprocessinfoclass--statusclass" class="hash-link" aria-label="Direct link to property-aspects--listdataprocesskeyclass--ownershipclass--dataprocessinfoclass--statusclass" title="Direct link to property-aspects--listdataprocesskeyclass--ownershipclass--dataprocessinfoclass--statusclass"></a></h4><p>The list of metadata aspects associated with the data process. Depending on the use case, this can either be all, or a selection, of supported aspects.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-9"><em>property</em> urn <em>: str</em><a href="#property-urn--str-9" class="hash-link" aria-label="Direct link to property-urn--str-9" title="Direct link to property-urn--str-9"></a></h4><p>URN for the entity the metadata snapshot is associated with.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataProcessTypeClass"><span class="visually-hidden">DataProcessTypeClass</span><a href="#datahub.metadata.schema_classes.DataProcessTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataProcessTypeClass" title="Direct link to datahub.metadata.schema_classes.DataProcessTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataProcessTypeClass</span>()<a href="#datahub.metadata.schema_classes.DataProcessTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="batch_ad_hoc--batch_ad_hoc">BATCH_AD_HOC <em>= 'BATCH_AD_HOC'</em><a href="#batch_ad_hoc--batch_ad_hoc" class="hash-link" aria-label="Direct link to batch_ad_hoc--batch_ad_hoc" title="Direct link to batch_ad_hoc--batch_ad_hoc"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="batch_scheduled--batch_scheduled">BATCH_SCHEDULED <em>= 'BATCH_SCHEDULED'</em><a href="#batch_scheduled--batch_scheduled" class="hash-link" aria-label="Direct link to batch_scheduled--batch_scheduled" title="Direct link to batch_scheduled--batch_scheduled"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="streaming--streaming">STREAMING <em>= 'STREAMING'</em><a href="#streaming--streaming" class="hash-link" aria-label="Direct link to streaming--streaming" title="Direct link to streaming--streaming"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataProductAssociationClass"><span class="visually-hidden">DataProductAssociationClass</span><a href="#datahub.metadata.schema_classes.DataProductAssociationClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataProductAssociationClass" title="Direct link to datahub.metadata.schema_classes.DataProductAssociationClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataProductAssociationClass</span>(<span class="arg-name">destinationUrn</span>, <span class="arg-name">sourceUrn</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>, <span class="arg-name">properties</span> = <span class="arg-default">None</span>, <span class="arg-name">outputPort</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataProductAssociationClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Represents an association of assets to a Data Product.</p><ul><li><strong>Parameters:</strong><ul><li><strong>destinationUrn</strong> (<code>str</code>)</li><li><strong>sourceUrn</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>properties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>outputPort</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--none--auditstampclass-3"><em>property</em> created <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--none--auditstampclass-3" class="hash-link" aria-label="Direct link to property-created--none--auditstampclass-3" title="Direct link to property-created--none--auditstampclass-3"></a></h4><p>Audit stamp containing who created this relationship edge and when</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-destinationurn--str"><em>property</em> destinationUrn <em>: str</em><a href="#property-destinationurn--str" class="hash-link" aria-label="Direct link to property-destinationurn--str" title="Direct link to property-destinationurn--str"></a></h4><p>Urn of the destination of this relationship edge.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--none--auditstampclass"><em>property</em> lastModified <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--none--auditstampclass" class="hash-link" aria-label="Direct link to property-lastmodified--none--auditstampclass" title="Direct link to property-lastmodified--none--auditstampclass"></a></h4><p>Audit stamp containing who last modified this relationship edge and when</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-outputport--bool"><em>property</em> outputPort <em>: bool</em><a href="#property-outputport--bool" class="hash-link" aria-label="Direct link to property-outputport--bool" title="Direct link to property-outputport--bool"></a></h4><p>If set to true, this asset is an output port of the Data Product.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-properties--none--dictstr-str-1"><em>property</em> properties <em>: None | Dict<!-- -->[str, str]</em><a href="#property-properties--none--dictstr-str-1" class="hash-link" aria-label="Direct link to property-properties--none--dictstr-str-1" title="Direct link to property-properties--none--dictstr-str-1"></a></h4><p>A generic properties bag that allows us to store specific information on this graph edge.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-sourceurn--none--str"><em>property</em> sourceUrn <em>: None | str</em><a href="#property-sourceurn--none--str" class="hash-link" aria-label="Direct link to property-sourceurn--none--str" title="Direct link to property-sourceurn--none--str"></a></h4><p>Urn of the source of this relationship edge.
|
||
If not specified, assumed to be the entity that this aspect belongs to.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataProductKeyClass"><span class="visually-hidden">DataProductKeyClass</span><a href="#datahub.metadata.schema_classes.DataProductKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataProductKeyClass" title="Direct link to datahub.metadata.schema_classes.DataProductKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataProductKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.DataProductKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Query</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-19"><em>property</em> id <em>: str</em><a href="#property-id--str-19" class="hash-link" aria-label="Direct link to property-id--str-19" title="Direct link to property-id--str-19"></a></h4><p>A unique id for the Data Product.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataProductPropertiesClass"><span class="visually-hidden">DataProductPropertiesClass</span><a href="#datahub.metadata.schema_classes.DataProductPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataProductPropertiesClass" title="Direct link to datahub.metadata.schema_classes.DataProductPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataProductPropertiesClass</span>(<span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">externalUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">name</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">assets</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataProductPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>The main properties of a Data Product</p><ul><li><strong>Parameters:</strong><ul><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>externalUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>assets</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.DataProductAssociationClass"><code>DataProductAssociationClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-assets--none--listdataproductassociationclass"><em>property</em> assets <em>: None | List[<a href="#datahub.metadata.schema_classes.DataProductAssociationClass">DataProductAssociationClass</a>]</em><a href="#property-assets--none--listdataproductassociationclass" class="hash-link" aria-label="Direct link to property-assets--none--listdataproductassociationclass" title="Direct link to property-assets--none--listdataproductassociationclass"></a></h4><p>A list of assets that are part of this Data Product</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-13"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-13" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-13" title="Direct link to property-customproperties--dictstr-str-13"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-12"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-12" class="hash-link" aria-label="Direct link to property-description--none--str-12" title="Direct link to property-description--none--str-12"></a></h4><p>Documentation of the data product</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-externalurl--none--str-11"><em>property</em> externalUrl <em>: None | str</em><a href="#property-externalurl--none--str-11" class="hash-link" aria-label="Direct link to property-externalurl--none--str-11" title="Direct link to property-externalurl--none--str-11"></a></h4><p>URL where the reference exist</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--none--str-3"><em>property</em> name <em>: None | str</em><a href="#property-name--none--str-3" class="hash-link" aria-label="Direct link to property-name--none--str-3" title="Direct link to property-name--none--str-3"></a></h4><p>Display name of the Data Product</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataQualityContractClass"><span class="visually-hidden">DataQualityContractClass</span><a href="#datahub.metadata.schema_classes.DataQualityContractClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataQualityContractClass" title="Direct link to datahub.metadata.schema_classes.DataQualityContractClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataQualityContractClass</span>(<span class="arg-name">assertion</span>)<a href="#datahub.metadata.schema_classes.DataQualityContractClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A data quality contract pertaining to a physical data asset
|
||
Data Quality contracts are used to make assertions about data quality metrics for a physical data asset</p><ul><li><strong>Parameters:</strong><strong>assertion</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-assertion--str"><em>property</em> assertion <em>: str</em><a href="#property-assertion--str" class="hash-link" aria-label="Direct link to property-assertion--str" title="Direct link to property-assertion--str"></a></h4><p>The assertion representing the Data Quality contract.
|
||
E.g. a table or column-level assertion.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataTransformClass"><span class="visually-hidden">DataTransformClass</span><a href="#datahub.metadata.schema_classes.DataTransformClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataTransformClass" title="Direct link to datahub.metadata.schema_classes.DataTransformClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataTransformClass</span>(<span class="arg-name">queryStatement</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataTransformClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Information about a transformation. It may be a query,</p><ul><li><strong>Parameters:</strong><strong>queryStatement</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.QueryStatementClass"><code>QueryStatementClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-querystatement--none--querystatementclass"><em>property</em> queryStatement <em>: None | <a href="#datahub.metadata.schema_classes.QueryStatementClass">QueryStatementClass</a></em><a href="#property-querystatement--none--querystatementclass" class="hash-link" aria-label="Direct link to property-querystatement--none--querystatementclass" title="Direct link to property-querystatement--none--querystatementclass"></a></h4><p>The data transform may be defined by a query statement</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataTransformLogicClass"><span class="visually-hidden">DataTransformLogicClass</span><a href="#datahub.metadata.schema_classes.DataTransformLogicClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataTransformLogicClass" title="Direct link to datahub.metadata.schema_classes.DataTransformLogicClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataTransformLogicClass</span>(<span class="arg-name">transforms</span>)<a href="#datahub.metadata.schema_classes.DataTransformLogicClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a Query against one or more data assets (e.g. Tables or Views).</p><ul><li><strong>Parameters:</strong><strong>transforms</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.DataTransformClass"><code>DataTransformClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-transforms--listdatatransformclass"><em>property</em> transforms <em>: List[<a href="#datahub.metadata.schema_classes.DataTransformClass">DataTransformClass</a>]</em><a href="#property-transforms--listdatatransformclass" class="hash-link" aria-label="Direct link to property-transforms--listdatatransformclass" title="Direct link to property-transforms--listdatatransformclass"></a></h4><p>List of transformations applied</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataTypeInfoClass"><span class="visually-hidden">DataTypeInfoClass</span><a href="#datahub.metadata.schema_classes.DataTypeInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataTypeInfoClass" title="Direct link to datahub.metadata.schema_classes.DataTypeInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataTypeInfoClass</span>(<span class="arg-name">qualifiedName</span>, <span class="arg-name">displayName</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DataTypeInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>qualifiedName</strong> (<code>str</code>)</li><li><strong>displayName</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-13"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-13" class="hash-link" aria-label="Direct link to property-description--none--str-13" title="Direct link to property-description--none--str-13"></a></h4><p>An optional description for the data type.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-displayname--none--str-4"><em>property</em> displayName <em>: None | str</em><a href="#property-displayname--none--str-4" class="hash-link" aria-label="Direct link to property-displayname--none--str-4" title="Direct link to property-displayname--none--str-4"></a></h4><p>An optional display name for the data type.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-qualifiedname--str"><em>property</em> qualifiedName <em>: str</em><a href="#property-qualifiedname--str" class="hash-link" aria-label="Direct link to property-qualifiedname--str" title="Direct link to property-qualifiedname--str"></a></h4><p>The qualified name for the data type. Usually a unique namespace + name, e.g. datahub.string</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DataTypeKeyClass"><span class="visually-hidden">DataTypeKeyClass</span><a href="#datahub.metadata.schema_classes.DataTypeKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DataTypeKeyClass" title="Direct link to datahub.metadata.schema_classes.DataTypeKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DataTypeKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.DataTypeKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-20"><em>property</em> id <em>: str</em><a href="#property-id--str-20" class="hash-link" aria-label="Direct link to property-id--str-20" title="Direct link to property-id--str-20"></a></h4><p>A unique id for a data type. Usually this will be a unique namespace + data type name.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DatahubIngestionCheckpointClass"><span class="visually-hidden">DatahubIngestionCheckpointClass</span><a href="#datahub.metadata.schema_classes.DatahubIngestionCheckpointClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DatahubIngestionCheckpointClass" title="Direct link to datahub.metadata.schema_classes.DatahubIngestionCheckpointClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DatahubIngestionCheckpointClass</span>(<span class="arg-name">timestampMillis</span>, <span class="arg-name">pipelineName</span>, <span class="arg-name">platformInstanceId</span>, <span class="arg-name">config</span>, <span class="arg-name">state</span>, <span class="arg-name">runId</span>, <span class="arg-name">eventGranularity</span> = <span class="arg-default">None</span>, <span class="arg-name">partitionSpec</span> = <span class="arg-default">None</span>, <span class="arg-name">messageId</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DatahubIngestionCheckpointClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Checkpoint of a datahub ingestion run for a given job.</p><ul><li><strong>Parameters:</strong><ul><li><strong>timestampMillis</strong> (<code>int</code>)</li><li><strong>pipelineName</strong> (<code>str</code>)</li><li><strong>platformInstanceId</strong> (<code>str</code>)</li><li><strong>config</strong> (<code>str</code>)</li><li><strong>state</strong> (<a href="#datahub.metadata.schema_classes.IngestionCheckpointStateClass"><code>IngestionCheckpointStateClass</code></a>) – </li><li><strong>runId</strong> (<code>str</code>)</li><li><strong>eventGranularity</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeWindowSizeClass"><code>TimeWindowSizeClass</code></a>]) – </li><li><strong>partitionSpec</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.PartitionSpecClass"><code>PartitionSpecClass</code></a>]) – </li><li><strong>messageId</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="aspect_type--classvarstr--timeseries-4">ASPECT_TYPE <em>: <code>ClassVar</code>[<code>str</code>]</em> <em>= 'timeseries'</em><a href="#aspect_type--classvarstr--timeseries-4" class="hash-link" aria-label="Direct link to aspect_type--classvarstr--timeseries-4" title="Direct link to aspect_type--classvarstr--timeseries-4"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-config--str"><em>property</em> config <em>: str</em><a href="#property-config--str" class="hash-link" aria-label="Direct link to property-config--str" title="Direct link to property-config--str"></a></h4><p>Json-encoded string representation of the non-secret members of the config .</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-eventgranularity--none--timewindowsizeclass-4"><em>property</em> eventGranularity <em>: None | <a href="#datahub.metadata.schema_classes.TimeWindowSizeClass">TimeWindowSizeClass</a></em><a href="#property-eventgranularity--none--timewindowsizeclass-4" class="hash-link" aria-label="Direct link to property-eventgranularity--none--timewindowsizeclass-4" title="Direct link to property-eventgranularity--none--timewindowsizeclass-4"></a></h4><p>Granularity of the event if applicable</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-messageid--none--str-4"><em>property</em> messageId <em>: None | str</em><a href="#property-messageid--none--str-4" class="hash-link" aria-label="Direct link to property-messageid--none--str-4" title="Direct link to property-messageid--none--str-4"></a></h4><p>The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-partitionspec--partitionspecclass--none-4"><em>property</em> partitionSpec <em>: <a href="#datahub.metadata.schema_classes.PartitionSpecClass">PartitionSpecClass</a> | None</em><a href="#property-partitionspec--partitionspecclass--none-4" class="hash-link" aria-label="Direct link to property-partitionspec--partitionspecclass--none-4" title="Direct link to property-partitionspec--partitionspecclass--none-4"></a></h4><p>The optional partition specification.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-pipelinename--str"><em>property</em> pipelineName <em>: str</em><a href="#property-pipelinename--str" class="hash-link" aria-label="Direct link to property-pipelinename--str" title="Direct link to property-pipelinename--str"></a></h4><p>The name of the pipeline that ran ingestion, a stable unique user provided identifier.
|
||
e.g. my_snowflake1-to-datahub.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-platforminstanceid--str"><em>property</em> platformInstanceId <em>: str</em><a href="#property-platforminstanceid--str" class="hash-link" aria-label="Direct link to property-platforminstanceid--str" title="Direct link to property-platforminstanceid--str"></a></h4><p>The id of the instance against which the ingestion pipeline ran.
|
||
e.g.: Bigquery project ids, MySQL hostnames etc.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-runid--str-1"><em>property</em> runId <em>: str</em><a href="#property-runid--str-1" class="hash-link" aria-label="Direct link to property-runid--str-1" title="Direct link to property-runid--str-1"></a></h4><p>The run identifier of this job.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-state--ingestioncheckpointstateclass"><em>property</em> state <em>: <a href="#datahub.metadata.schema_classes.IngestionCheckpointStateClass">IngestionCheckpointStateClass</a></em><a href="#property-state--ingestioncheckpointstateclass" class="hash-link" aria-label="Direct link to property-state--ingestioncheckpointstateclass" title="Direct link to property-state--ingestioncheckpointstateclass"></a></h4><p>Opaque blob of the state representation.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-timestampmillis--int-4"><em>property</em> timestampMillis <em>: int</em><a href="#property-timestampmillis--int-4" class="hash-link" aria-label="Direct link to property-timestampmillis--int-4" title="Direct link to property-timestampmillis--int-4"></a></h4><p>The event timestamp field as epoch at UTC in milli seconds.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass"><span class="visually-hidden">DatahubIngestionRunSummaryClass</span><a href="#datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass" title="Direct link to datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DatahubIngestionRunSummaryClass</span>(<span class="arg-name">timestampMillis</span>, <span class="arg-name">pipelineName</span>, <span class="arg-name">platformInstanceId</span>, <span class="arg-name">runId</span>, <span class="arg-name">runStatus</span>, <span class="arg-name">eventGranularity</span> = <span class="arg-default">None</span>, <span class="arg-name">partitionSpec</span> = <span class="arg-default">None</span>, <span class="arg-name">messageId</span> = <span class="arg-default">None</span>, <span class="arg-name">numWorkUnitsCommitted</span> = <span class="arg-default">None</span>, <span class="arg-name">numWorkUnitsCreated</span> = <span class="arg-default">None</span>, <span class="arg-name">numEvents</span> = <span class="arg-default">None</span>, <span class="arg-name">numEntities</span> = <span class="arg-default">None</span>, <span class="arg-name">numAspects</span> = <span class="arg-default">None</span>, <span class="arg-name">numSourceAPICalls</span> = <span class="arg-default">None</span>, <span class="arg-name">totalLatencySourceAPICalls</span> = <span class="arg-default">None</span>, <span class="arg-name">numSinkAPICalls</span> = <span class="arg-default">None</span>, <span class="arg-name">totalLatencySinkAPICalls</span> = <span class="arg-default">None</span>, <span class="arg-name">numWarnings</span> = <span class="arg-default">None</span>, <span class="arg-name">numErrors</span> = <span class="arg-default">None</span>, <span class="arg-name">numEntitiesSkipped</span> = <span class="arg-default">None</span>, <span class="arg-name">config</span> = <span class="arg-default">None</span>, <span class="arg-name">custom_summary</span> = <span class="arg-default">None</span>, <span class="arg-name">softwareVersion</span> = <span class="arg-default">None</span>, <span class="arg-name">systemHostName</span> = <span class="arg-default">None</span>, <span class="arg-name">operatingSystemName</span> = <span class="arg-default">None</span>, <span class="arg-name">numProcessors</span> = <span class="arg-default">None</span>, <span class="arg-name">totalMemory</span> = <span class="arg-default">None</span>, <span class="arg-name">availableMemory</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Summary of a datahub ingestion run for a given platform.</p><ul><li><strong>Parameters:</strong><ul><li><strong>timestampMillis</strong> (<code>int</code>)</li><li><strong>pipelineName</strong> (<code>str</code>)</li><li><strong>platformInstanceId</strong> (<code>str</code>)</li><li><strong>runId</strong> (<code>str</code>)</li><li><strong>runStatus</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.JobStatusClass"><code>JobStatusClass</code></a>]) – </li><li><strong>eventGranularity</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeWindowSizeClass"><code>TimeWindowSizeClass</code></a>]) – </li><li><strong>partitionSpec</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.PartitionSpecClass"><code>PartitionSpecClass</code></a>]) – </li><li><strong>messageId</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>numWorkUnitsCommitted</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>numWorkUnitsCreated</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>numEvents</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>numEntities</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>numAspects</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>numSourceAPICalls</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>totalLatencySourceAPICalls</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>numSinkAPICalls</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>totalLatencySinkAPICalls</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>numWarnings</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>numErrors</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>numEntitiesSkipped</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>config</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>custom_summary</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>softwareVersion</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>systemHostName</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>operatingSystemName</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>numProcessors</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>totalMemory</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>availableMemory</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="aspect_type--classvarstr--timeseries-5">ASPECT_TYPE <em>: <code>ClassVar</code>[<code>str</code>]</em> <em>= 'timeseries'</em><a href="#aspect_type--classvarstr--timeseries-5" class="hash-link" aria-label="Direct link to aspect_type--classvarstr--timeseries-5" title="Direct link to aspect_type--classvarstr--timeseries-5"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-availablememory--none--int"><em>property</em> availableMemory <em>: None | int</em><a href="#property-availablememory--none--int" class="hash-link" aria-label="Direct link to property-availablememory--none--int" title="Direct link to property-availablememory--none--int"></a></h4><p>The available memory on the host the ingestion pipeline ran on.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-config--none--str"><em>property</em> config <em>: None | str</em><a href="#property-config--none--str" class="hash-link" aria-label="Direct link to property-config--none--str" title="Direct link to property-config--none--str"></a></h4><p>The non-sensitive key-value pairs of the yaml config used as json string.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-custom_summary--none--str"><em>property</em> custom_summary <em>: None | str</em><a href="#property-custom_summary--none--str" class="hash-link" aria-label="Direct link to property-custom_summary--none--str" title="Direct link to property-custom_summary--none--str"></a></h4><p>Custom value.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-eventgranularity--none--timewindowsizeclass-5"><em>property</em> eventGranularity <em>: None | <a href="#datahub.metadata.schema_classes.TimeWindowSizeClass">TimeWindowSizeClass</a></em><a href="#property-eventgranularity--none--timewindowsizeclass-5" class="hash-link" aria-label="Direct link to property-eventgranularity--none--timewindowsizeclass-5" title="Direct link to property-eventgranularity--none--timewindowsizeclass-5"></a></h4><p>Granularity of the event if applicable</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-messageid--none--str-5"><em>property</em> messageId <em>: None | str</em><a href="#property-messageid--none--str-5" class="hash-link" aria-label="Direct link to property-messageid--none--str-5" title="Direct link to property-messageid--none--str-5"></a></h4><p>The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-numaspects--none--int"><em>property</em> numAspects <em>: None | int</em><a href="#property-numaspects--none--int" class="hash-link" aria-label="Direct link to property-numaspects--none--int" title="Direct link to property-numaspects--none--int"></a></h4><p>The total number of aspects produced across all entities.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-numentities--none--int"><em>property</em> numEntities <em>: None | int</em><a href="#property-numentities--none--int" class="hash-link" aria-label="Direct link to property-numentities--none--int" title="Direct link to property-numentities--none--int"></a></h4><p>The total number of entities produced (unique entity urns).</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-numentitiesskipped--none--int"><em>property</em> numEntitiesSkipped <em>: None | int</em><a href="#property-numentitiesskipped--none--int" class="hash-link" aria-label="Direct link to property-numentitiesskipped--none--int" title="Direct link to property-numentitiesskipped--none--int"></a></h4><p>Number of entities skipped.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-numerrors--none--int"><em>property</em> numErrors <em>: None | int</em><a href="#property-numerrors--none--int" class="hash-link" aria-label="Direct link to property-numerrors--none--int" title="Direct link to property-numerrors--none--int"></a></h4><p>Number of errors generated.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-numevents--none--int"><em>property</em> numEvents <em>: None | int</em><a href="#property-numevents--none--int" class="hash-link" aria-label="Direct link to property-numevents--none--int" title="Direct link to property-numevents--none--int"></a></h4><p>The number of events produced (MCE + MCP).</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-numprocessors--none--int"><em>property</em> numProcessors <em>: None | int</em><a href="#property-numprocessors--none--int" class="hash-link" aria-label="Direct link to property-numprocessors--none--int" title="Direct link to property-numprocessors--none--int"></a></h4><p>The number of processors on the host the ingestion pipeline ran on.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-numsinkapicalls--none--int"><em>property</em> numSinkAPICalls <em>: None | int</em><a href="#property-numsinkapicalls--none--int" class="hash-link" aria-label="Direct link to property-numsinkapicalls--none--int" title="Direct link to property-numsinkapicalls--none--int"></a></h4><p>Total number of sink API calls.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-numsourceapicalls--none--int"><em>property</em> numSourceAPICalls <em>: None | int</em><a href="#property-numsourceapicalls--none--int" class="hash-link" aria-label="Direct link to property-numsourceapicalls--none--int" title="Direct link to property-numsourceapicalls--none--int"></a></h4><p>Total number of source API calls.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-numwarnings--none--int"><em>property</em> numWarnings <em>: None | int</em><a href="#property-numwarnings--none--int" class="hash-link" aria-label="Direct link to property-numwarnings--none--int" title="Direct link to property-numwarnings--none--int"></a></h4><p>Number of warnings generated.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-numworkunitscommitted--none--int"><em>property</em> numWorkUnitsCommitted <em>: None | int</em><a href="#property-numworkunitscommitted--none--int" class="hash-link" aria-label="Direct link to property-numworkunitscommitted--none--int" title="Direct link to property-numworkunitscommitted--none--int"></a></h4><p>The number of workunits written to sink.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-numworkunitscreated--none--int"><em>property</em> numWorkUnitsCreated <em>: None | int</em><a href="#property-numworkunitscreated--none--int" class="hash-link" aria-label="Direct link to property-numworkunitscreated--none--int" title="Direct link to property-numworkunitscreated--none--int"></a></h4><p>The number of workunits that are produced.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-operatingsystemname--none--str"><em>property</em> operatingSystemName <em>: None | str</em><a href="#property-operatingsystemname--none--str" class="hash-link" aria-label="Direct link to property-operatingsystemname--none--str" title="Direct link to property-operatingsystemname--none--str"></a></h4><p>The os the ingestion pipeline ran on.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-partitionspec--partitionspecclass--none-5"><em>property</em> partitionSpec <em>: <a href="#datahub.metadata.schema_classes.PartitionSpecClass">PartitionSpecClass</a> | None</em><a href="#property-partitionspec--partitionspecclass--none-5" class="hash-link" aria-label="Direct link to property-partitionspec--partitionspecclass--none-5" title="Direct link to property-partitionspec--partitionspecclass--none-5"></a></h4><p>The optional partition specification.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-pipelinename--str-1"><em>property</em> pipelineName <em>: str</em><a href="#property-pipelinename--str-1" class="hash-link" aria-label="Direct link to property-pipelinename--str-1" title="Direct link to property-pipelinename--str-1"></a></h4><p>The name of the pipeline that ran ingestion, a stable unique user provided identifier.
|
||
e.g. my_snowflake1-to-datahub.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-platforminstanceid--str-1"><em>property</em> platformInstanceId <em>: str</em><a href="#property-platforminstanceid--str-1" class="hash-link" aria-label="Direct link to property-platforminstanceid--str-1" title="Direct link to property-platforminstanceid--str-1"></a></h4><p>The id of the instance against which the ingestion pipeline ran.
|
||
e.g.: Bigquery project ids, MySQL hostnames etc.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-runid--str-2"><em>property</em> runId <em>: str</em><a href="#property-runid--str-2" class="hash-link" aria-label="Direct link to property-runid--str-2" title="Direct link to property-runid--str-2"></a></h4><p>The runId for this pipeline instance.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-runstatus--str--jobstatusclass"><em>property</em> runStatus <em>: str | <a href="#datahub.metadata.schema_classes.JobStatusClass">JobStatusClass</a></em><a href="#property-runstatus--str--jobstatusclass" class="hash-link" aria-label="Direct link to property-runstatus--str--jobstatusclass" title="Direct link to property-runstatus--str--jobstatusclass"></a></h4><p>Run Status - Succeeded/Skipped/Failed etc.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-softwareversion--none--str"><em>property</em> softwareVersion <em>: None | str</em><a href="#property-softwareversion--none--str" class="hash-link" aria-label="Direct link to property-softwareversion--none--str" title="Direct link to property-softwareversion--none--str"></a></h4><p>The software version of this ingestion.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-systemhostname--none--str"><em>property</em> systemHostName <em>: None | str</em><a href="#property-systemhostname--none--str" class="hash-link" aria-label="Direct link to property-systemhostname--none--str" title="Direct link to property-systemhostname--none--str"></a></h4><p>The hostname the ingestion pipeline ran on.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-timestampmillis--int-5"><em>property</em> timestampMillis <em>: int</em><a href="#property-timestampmillis--int-5" class="hash-link" aria-label="Direct link to property-timestampmillis--int-5" title="Direct link to property-timestampmillis--int-5"></a></h4><p>The event timestamp field as epoch at UTC in milli seconds.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-totallatencysinkapicalls--none--int"><em>property</em> totalLatencySinkAPICalls <em>: None | int</em><a href="#property-totallatencysinkapicalls--none--int" class="hash-link" aria-label="Direct link to property-totallatencysinkapicalls--none--int" title="Direct link to property-totallatencysinkapicalls--none--int"></a></h4><p>Total latency across all sink API calls.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-totallatencysourceapicalls--none--int"><em>property</em> totalLatencySourceAPICalls <em>: None | int</em><a href="#property-totallatencysourceapicalls--none--int" class="hash-link" aria-label="Direct link to property-totallatencysourceapicalls--none--int" title="Direct link to property-totallatencysourceapicalls--none--int"></a></h4><p>Total latency across all source API calls.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-totalmemory--none--int"><em>property</em> totalMemory <em>: None | int</em><a href="#property-totalmemory--none--int" class="hash-link" aria-label="Direct link to property-totalmemory--none--int" title="Direct link to property-totalmemory--none--int"></a></h4><p>The total amount of memory on the host the ingestion pipeline ran on.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DatasetAssertionInfoClass"><span class="visually-hidden">DatasetAssertionInfoClass</span><a href="#datahub.metadata.schema_classes.DatasetAssertionInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DatasetAssertionInfoClass" title="Direct link to datahub.metadata.schema_classes.DatasetAssertionInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DatasetAssertionInfoClass</span>(<span class="arg-name">dataset</span>, <span class="arg-name">scope</span>, <span class="arg-name">operator</span>, <span class="arg-name">fields</span> = <span class="arg-default">None</span>, <span class="arg-name">aggregation</span> = <span class="arg-default">None</span>, <span class="arg-name">parameters</span> = <span class="arg-default">None</span>, <span class="arg-name">nativeType</span> = <span class="arg-default">None</span>, <span class="arg-name">nativeParameters</span> = <span class="arg-default">None</span>, <span class="arg-name">logic</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DatasetAssertionInfoClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Attributes that are applicable to single-Dataset Assertions</p><ul><li><strong>Parameters:</strong><ul><li><strong>dataset</strong> (<code>str</code>)</li><li><strong>scope</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.DatasetAssertionScopeClass"><code>DatasetAssertionScopeClass</code></a>]) – </li><li><strong>operator</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.AssertionStdOperatorClass"><code>AssertionStdOperatorClass</code></a>]) – </li><li><strong>fields</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>aggregation</strong> (<code>Union</code>[<code>None</code>, <code>str</code>, <a href="#datahub.metadata.schema_classes.AssertionStdAggregationClass"><code>AssertionStdAggregationClass</code></a>]) – </li><li><strong>parameters</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AssertionStdParametersClass"><code>AssertionStdParametersClass</code></a>]) – </li><li><strong>nativeType</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>nativeParameters</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>logic</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aggregation--none--str--assertionstdaggregationclass"><em>property</em> aggregation <em>: None | str | <a href="#datahub.metadata.schema_classes.AssertionStdAggregationClass">AssertionStdAggregationClass</a></em><a href="#property-aggregation--none--str--assertionstdaggregationclass" class="hash-link" aria-label="Direct link to property-aggregation--none--str--assertionstdaggregationclass" title="Direct link to property-aggregation--none--str--assertionstdaggregationclass"></a></h4><p>Standardized assertion operator
|
||
This field is left blank if there is no selected aggregation or metric for a particular column.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-dataset--str-1"><em>property</em> dataset <em>: str</em><a href="#property-dataset--str-1" class="hash-link" aria-label="Direct link to property-dataset--str-1" title="Direct link to property-dataset--str-1"></a></h4><p>The dataset targeted by this assertion.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fields--none--liststr"><em>property</em> fields <em>: None | List<!-- -->[str]</em><a href="#property-fields--none--liststr" class="hash-link" aria-label="Direct link to property-fields--none--liststr" title="Direct link to property-fields--none--liststr"></a></h4><p>One or more dataset schema fields that are targeted by this assertion.</p><p>This field is expected to be provided if the assertion scope is DATASET_COLUMN.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-logic--none--str-1"><em>property</em> logic <em>: None | str</em><a href="#property-logic--none--str-1" class="hash-link" aria-label="Direct link to property-logic--none--str-1" title="Direct link to property-logic--none--str-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-nativeparameters--none--dictstr-str"><em>property</em> nativeParameters <em>: None | Dict<!-- -->[str, str]</em><a href="#property-nativeparameters--none--dictstr-str" class="hash-link" aria-label="Direct link to property-nativeparameters--none--dictstr-str" title="Direct link to property-nativeparameters--none--dictstr-str"></a></h4><p>Native parameters required for the assertion.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-nativetype--none--str"><em>property</em> nativeType <em>: None | str</em><a href="#property-nativetype--none--str" class="hash-link" aria-label="Direct link to property-nativetype--none--str" title="Direct link to property-nativetype--none--str"></a></h4><p>Native assertion type</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-operator--str--assertionstdoperatorclass"><em>property</em> operator <em>: str | <a href="#datahub.metadata.schema_classes.AssertionStdOperatorClass">AssertionStdOperatorClass</a></em><a href="#property-operator--str--assertionstdoperatorclass" class="hash-link" aria-label="Direct link to property-operator--str--assertionstdoperatorclass" title="Direct link to property-operator--str--assertionstdoperatorclass"></a></h4><p>Standardized assertion operator</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-parameters--none--assertionstdparametersclass"><em>property</em> parameters <em>: None | <a href="#datahub.metadata.schema_classes.AssertionStdParametersClass">AssertionStdParametersClass</a></em><a href="#property-parameters--none--assertionstdparametersclass" class="hash-link" aria-label="Direct link to property-parameters--none--assertionstdparametersclass" title="Direct link to property-parameters--none--assertionstdparametersclass"></a></h4><p>Standard parameters required for the assertion. e.g. min_value, max_value, value, columns</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-scope--str--datasetassertionscopeclass"><em>property</em> scope <em>: str | <a href="#datahub.metadata.schema_classes.DatasetAssertionScopeClass">DatasetAssertionScopeClass</a></em><a href="#property-scope--str--datasetassertionscopeclass" class="hash-link" aria-label="Direct link to property-scope--str--datasetassertionscopeclass" title="Direct link to property-scope--str--datasetassertionscopeclass"></a></h4><p>Scope of the Assertion. What part of the dataset does this assertion apply to?</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DatasetAssertionScopeClass"><span class="visually-hidden">DatasetAssertionScopeClass</span><a href="#datahub.metadata.schema_classes.DatasetAssertionScopeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DatasetAssertionScopeClass" title="Direct link to datahub.metadata.schema_classes.DatasetAssertionScopeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DatasetAssertionScopeClass</span>()<a href="#datahub.metadata.schema_classes.DatasetAssertionScopeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataset_column--dataset_column">DATASET_COLUMN <em>= 'DATASET_COLUMN'</em><a href="#dataset_column--dataset_column" class="hash-link" aria-label="Direct link to dataset_column--dataset_column" title="Direct link to dataset_column--dataset_column"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataset_rows--dataset_rows">DATASET_ROWS <em>= 'DATASET_ROWS'</em><a href="#dataset_rows--dataset_rows" class="hash-link" aria-label="Direct link to dataset_rows--dataset_rows" title="Direct link to dataset_rows--dataset_rows"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataset_schema--dataset_schema">DATASET_SCHEMA <em>= 'DATASET_SCHEMA'</em><a href="#dataset_schema--dataset_schema" class="hash-link" aria-label="Direct link to dataset_schema--dataset_schema" title="Direct link to dataset_schema--dataset_schema"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataset_storage_size--dataset_storage_size">DATASET_STORAGE_SIZE <em>= 'DATASET_STORAGE_SIZE'</em><a href="#dataset_storage_size--dataset_storage_size" class="hash-link" aria-label="Direct link to dataset_storage_size--dataset_storage_size" title="Direct link to dataset_storage_size--dataset_storage_size"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="unknown--unknown-1">UNKNOWN <em>= 'UNKNOWN'</em><a href="#unknown--unknown-1" class="hash-link" aria-label="Direct link to unknown--unknown-1" title="Direct link to unknown--unknown-1"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DatasetDeprecationClass"><span class="visually-hidden">DatasetDeprecationClass</span><a href="#datahub.metadata.schema_classes.DatasetDeprecationClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DatasetDeprecationClass" title="Direct link to datahub.metadata.schema_classes.DatasetDeprecationClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DatasetDeprecationClass</span>(<span class="arg-name">deprecated</span>, <span class="arg-name">note</span>, <span class="arg-name">decommissionTime</span> = <span class="arg-default">None</span>, <span class="arg-name">actor</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DatasetDeprecationClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Dataset deprecation status
|
||
Deprecated! This aspect is deprecated in favor of the more-general-purpose ‘Deprecation’ aspect.</p><ul><li><strong>Parameters:</strong><ul><li><strong>deprecated</strong> (<code>bool</code>)</li><li><strong>note</strong> (<code>str</code>)</li><li><strong>decommissionTime</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>actor</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-actor--none--str"><em>property</em> actor <em>: None | str</em><a href="#property-actor--none--str" class="hash-link" aria-label="Direct link to property-actor--none--str" title="Direct link to property-actor--none--str"></a></h4><p>The corpuser URN which will be credited for modifying this deprecation content.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-decommissiontime--none--int"><em>property</em> decommissionTime <em>: None | int</em><a href="#property-decommissiontime--none--int" class="hash-link" aria-label="Direct link to property-decommissiontime--none--int" title="Direct link to property-decommissiontime--none--int"></a></h4><p>The time user plan to decommission this dataset.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-deprecated--bool"><em>property</em> deprecated <em>: bool</em><a href="#property-deprecated--bool" class="hash-link" aria-label="Direct link to property-deprecated--bool" title="Direct link to property-deprecated--bool"></a></h4><p>Whether the dataset is deprecated by owner.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-note--str"><em>property</em> note <em>: str</em><a href="#property-note--str" class="hash-link" aria-label="Direct link to property-note--str" title="Direct link to property-note--str"></a></h4><p>Additional information about the dataset deprecation plan, such as the wiki, doc, RB.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DatasetFieldForeignKeyClass"><span class="visually-hidden">DatasetFieldForeignKeyClass</span><a href="#datahub.metadata.schema_classes.DatasetFieldForeignKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DatasetFieldForeignKeyClass" title="Direct link to datahub.metadata.schema_classes.DatasetFieldForeignKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DatasetFieldForeignKeyClass</span>(<span class="arg-name">parentDataset</span>, <span class="arg-name">currentFieldPaths</span>, <span class="arg-name">parentField</span>)<a href="#datahub.metadata.schema_classes.DatasetFieldForeignKeyClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>For non-urn based foregin keys.</p><ul><li><strong>Parameters:</strong><ul><li><strong>parentDataset</strong> (<code>str</code>)</li><li><strong>currentFieldPaths</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li><li><strong>parentField</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-currentfieldpaths--liststr"><em>property</em> currentFieldPaths <em>: List<!-- -->[str]</em><a href="#property-currentfieldpaths--liststr" class="hash-link" aria-label="Direct link to property-currentfieldpaths--liststr" title="Direct link to property-currentfieldpaths--liststr"></a></h4><p>List of fields in hosting(current) SchemaMetadata that conform a foreign key. List can contain a single entry or multiple entries if several entries in hosting schema conform a foreign key in a single parent dataset.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-parentdataset--str"><em>property</em> parentDataset <em>: str</em><a href="#property-parentdataset--str" class="hash-link" aria-label="Direct link to property-parentdataset--str" title="Direct link to property-parentdataset--str"></a></h4><p>dataset that stores the resource.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-parentfield--str"><em>property</em> parentField <em>: str</em><a href="#property-parentfield--str" class="hash-link" aria-label="Direct link to property-parentfield--str" title="Direct link to property-parentfield--str"></a></h4><p><a href="mailto:SchemaField@fieldPath" target="_blank" rel="noopener noreferrer">SchemaField@fieldPath</a> that uniquely identify field in parent dataset that this field references.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DatasetFieldMappingClass"><span class="visually-hidden">DatasetFieldMappingClass</span><a href="#datahub.metadata.schema_classes.DatasetFieldMappingClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DatasetFieldMappingClass" title="Direct link to datahub.metadata.schema_classes.DatasetFieldMappingClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DatasetFieldMappingClass</span>(<span class="arg-name">created</span>, <span class="arg-name">transformation</span>, <span class="arg-name">sourceFields</span>, <span class="arg-name">destinationField</span>)<a href="#datahub.metadata.schema_classes.DatasetFieldMappingClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Representation of mapping between fields in source dataset to the field in destination dataset</p><ul><li><strong>Parameters:</strong><ul><li><strong>created</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li><li><strong>transformation</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.TransformationTypeClass"><code>TransformationTypeClass</code></a>, <a href="#datahub.metadata.schema_classes.UDFTransformerClass"><code>UDFTransformerClass</code></a>]) – </li><li><strong>sourceFields</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li><li><strong>destinationField</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--auditstampclass-6"><em>property</em> created <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--auditstampclass-6" class="hash-link" aria-label="Direct link to property-created--auditstampclass-6" title="Direct link to property-created--auditstampclass-6"></a></h4><p>Audit stamp containing who reported the field mapping and when</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-destinationfield--str"><em>property</em> destinationField <em>: str</em><a href="#property-destinationfield--str" class="hash-link" aria-label="Direct link to property-destinationfield--str" title="Direct link to property-destinationfield--str"></a></h4><p>Destination field which is derived from source fields</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-sourcefields--liststr"><em>property</em> sourceFields <em>: List<!-- -->[str]</em><a href="#property-sourcefields--liststr" class="hash-link" aria-label="Direct link to property-sourcefields--liststr" title="Direct link to property-sourcefields--liststr"></a></h4><p>Source fields from which the fine grained lineage is derived</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-transformation--str--transformationtypeclass--udftransformerclass"><em>property</em> transformation <em>: str | <a href="#datahub.metadata.schema_classes.TransformationTypeClass">TransformationTypeClass</a> | <a href="#datahub.metadata.schema_classes.UDFTransformerClass">UDFTransformerClass</a></em><a href="#property-transformation--str--transformationtypeclass--udftransformerclass" class="hash-link" aria-label="Direct link to property-transformation--str--transformationtypeclass--udftransformerclass" title="Direct link to property-transformation--str--transformationtypeclass--udftransformerclass"></a></h4><p>Transfomration function between the fields involved</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DatasetFieldProfileClass"><span class="visually-hidden">DatasetFieldProfileClass</span><a href="#datahub.metadata.schema_classes.DatasetFieldProfileClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DatasetFieldProfileClass" title="Direct link to datahub.metadata.schema_classes.DatasetFieldProfileClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DatasetFieldProfileClass</span>(<span class="arg-name">fieldPath</span>, <span class="arg-name">uniqueCount</span> = <span class="arg-default">None</span>, <span class="arg-name">uniqueProportion</span> = <span class="arg-default">None</span>, <span class="arg-name">nullCount</span> = <span class="arg-default">None</span>, <span class="arg-name">nullProportion</span> = <span class="arg-default">None</span>, <span class="arg-name">min</span> = <span class="arg-default">None</span>, <span class="arg-name">max</span> = <span class="arg-default">None</span>, <span class="arg-name">mean</span> = <span class="arg-default">None</span>, <span class="arg-name">median</span> = <span class="arg-default">None</span>, <span class="arg-name">stdev</span> = <span class="arg-default">None</span>, <span class="arg-name">quantiles</span> = <span class="arg-default">None</span>, <span class="arg-name">distinctValueFrequencies</span> = <span class="arg-default">None</span>, <span class="arg-name">histogram</span> = <span class="arg-default">None</span>, <span class="arg-name">sampleValues</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DatasetFieldProfileClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Stats corresponding to fields in a dataset</p><ul><li><strong>Parameters:</strong><ul><li><strong>fieldPath</strong> (<code>str</code>)</li><li><strong>uniqueCount</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>uniqueProportion</strong> (<code>Optional</code>[<code>float</code>]<!-- -->)</li><li><strong>nullCount</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>nullProportion</strong> (<code>Optional</code>[<code>float</code>]<!-- -->)</li><li><strong>min</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>max</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>mean</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>median</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>stdev</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>quantiles</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.QuantileClass"><code>QuantileClass</code></a>]]) – </li><li><strong>distinctValueFrequencies</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.ValueFrequencyClass"><code>ValueFrequencyClass</code></a>]]) – </li><li><strong>histogram</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.HistogramClass"><code>HistogramClass</code></a>]) – </li><li><strong>sampleValues</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-distinctvaluefrequencies--none--listvaluefrequencyclass"><em>property</em> distinctValueFrequencies <em>: None | List[<a href="#datahub.metadata.schema_classes.ValueFrequencyClass">ValueFrequencyClass</a>]</em><a href="#property-distinctvaluefrequencies--none--listvaluefrequencyclass" class="hash-link" aria-label="Direct link to property-distinctvaluefrequencies--none--listvaluefrequencyclass" title="Direct link to property-distinctvaluefrequencies--none--listvaluefrequencyclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fieldpath--str-1"><em>property</em> fieldPath <em>: str</em><a href="#property-fieldpath--str-1" class="hash-link" aria-label="Direct link to property-fieldpath--str-1" title="Direct link to property-fieldpath--str-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-histogram--none--histogramclass"><em>property</em> histogram <em>: None | <a href="#datahub.metadata.schema_classes.HistogramClass">HistogramClass</a></em><a href="#property-histogram--none--histogramclass" class="hash-link" aria-label="Direct link to property-histogram--none--histogramclass" title="Direct link to property-histogram--none--histogramclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-max--none--str"><em>property</em> max <em>: None | str</em><a href="#property-max--none--str" class="hash-link" aria-label="Direct link to property-max--none--str" title="Direct link to property-max--none--str"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-mean--none--str"><em>property</em> mean <em>: None | str</em><a href="#property-mean--none--str" class="hash-link" aria-label="Direct link to property-mean--none--str" title="Direct link to property-mean--none--str"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-median--none--str"><em>property</em> median <em>: None | str</em><a href="#property-median--none--str" class="hash-link" aria-label="Direct link to property-median--none--str" title="Direct link to property-median--none--str"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-min--none--str"><em>property</em> min <em>: None | str</em><a href="#property-min--none--str" class="hash-link" aria-label="Direct link to property-min--none--str" title="Direct link to property-min--none--str"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-nullcount--none--int"><em>property</em> nullCount <em>: None | int</em><a href="#property-nullcount--none--int" class="hash-link" aria-label="Direct link to property-nullcount--none--int" title="Direct link to property-nullcount--none--int"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-nullproportion--none--float"><em>property</em> nullProportion <em>: None | float</em><a href="#property-nullproportion--none--float" class="hash-link" aria-label="Direct link to property-nullproportion--none--float" title="Direct link to property-nullproportion--none--float"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-quantiles--none--listquantileclass"><em>property</em> quantiles <em>: None | List[<a href="#datahub.metadata.schema_classes.QuantileClass">QuantileClass</a>]</em><a href="#property-quantiles--none--listquantileclass" class="hash-link" aria-label="Direct link to property-quantiles--none--listquantileclass" title="Direct link to property-quantiles--none--listquantileclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-samplevalues--none--liststr"><em>property</em> sampleValues <em>: None | List<!-- -->[str]</em><a href="#property-samplevalues--none--liststr" class="hash-link" aria-label="Direct link to property-samplevalues--none--liststr" title="Direct link to property-samplevalues--none--liststr"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-stdev--none--str"><em>property</em> stdev <em>: None | str</em><a href="#property-stdev--none--str" class="hash-link" aria-label="Direct link to property-stdev--none--str" title="Direct link to property-stdev--none--str"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-uniquecount--none--int"><em>property</em> uniqueCount <em>: None | int</em><a href="#property-uniquecount--none--int" class="hash-link" aria-label="Direct link to property-uniquecount--none--int" title="Direct link to property-uniquecount--none--int"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-uniqueproportion--none--float"><em>property</em> uniqueProportion <em>: None | float</em><a href="#property-uniqueproportion--none--float" class="hash-link" aria-label="Direct link to property-uniqueproportion--none--float" title="Direct link to property-uniqueproportion--none--float"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DatasetFieldUsageCountsClass"><span class="visually-hidden">DatasetFieldUsageCountsClass</span><a href="#datahub.metadata.schema_classes.DatasetFieldUsageCountsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DatasetFieldUsageCountsClass" title="Direct link to datahub.metadata.schema_classes.DatasetFieldUsageCountsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DatasetFieldUsageCountsClass</span>(<span class="arg-name">fieldPath</span>, <span class="arg-name">count</span>)<a href="#datahub.metadata.schema_classes.DatasetFieldUsageCountsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Records field-level usage counts for a given dataset</p><ul><li><strong>Parameters:</strong><ul><li><strong>fieldPath</strong> (<code>str</code>)</li><li><strong>count</strong> (<code>int</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-count--int"><em>property</em> count <em>: int</em><a href="#property-count--int" class="hash-link" aria-label="Direct link to property-count--int" title="Direct link to property-count--int"></a></h4><p>Number of times the field has been used.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fieldpath--str-2"><em>property</em> fieldPath <em>: str</em><a href="#property-fieldpath--str-2" class="hash-link" aria-label="Direct link to property-fieldpath--str-2" title="Direct link to property-fieldpath--str-2"></a></h4><p>The name of the field.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DatasetFilterClass"><span class="visually-hidden">DatasetFilterClass</span><a href="#datahub.metadata.schema_classes.DatasetFilterClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DatasetFilterClass" title="Direct link to datahub.metadata.schema_classes.DatasetFilterClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DatasetFilterClass</span>(<span class="arg-name">type</span>, <span class="arg-name">sql</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DatasetFilterClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A definition of filters that should be used when
|
||
querying an external Dataset or Table.</p><p>Note that this models should NOT be used for working with
|
||
search / filter on DataHub Platform itself.</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.DatasetFilterTypeClass"><code>DatasetFilterTypeClass</code></a>]) – </li><li><strong>sql</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-sql--none--str"><em>property</em> sql <em>: None | str</em><a href="#property-sql--none--str" class="hash-link" aria-label="Direct link to property-sql--none--str" title="Direct link to property-sql--none--str"></a></h4><p>The raw where clause string which will be used for monitoring.
|
||
Required if the type is SQL.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--datasetfiltertypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.DatasetFilterTypeClass">DatasetFilterTypeClass</a></em><a href="#property-type--str--datasetfiltertypeclass" class="hash-link" aria-label="Direct link to property-type--str--datasetfiltertypeclass" title="Direct link to property-type--str--datasetfiltertypeclass"></a></h4><p>How the partition will be represented in this model.</p><p>In the future, we’ll likely add support for more structured
|
||
predicates.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DatasetFilterTypeClass"><span class="visually-hidden">DatasetFilterTypeClass</span><a href="#datahub.metadata.schema_classes.DatasetFilterTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DatasetFilterTypeClass" title="Direct link to datahub.metadata.schema_classes.DatasetFilterTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DatasetFilterTypeClass</span>()<a href="#datahub.metadata.schema_classes.DatasetFilterTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sql--sql-3">SQL <em>= 'SQL'</em><a href="#sql--sql-3" class="hash-link" aria-label="Direct link to sql--sql-3" title="Direct link to sql--sql-3"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DatasetKeyClass"><span class="visually-hidden">DatasetKeyClass</span><a href="#datahub.metadata.schema_classes.DatasetKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DatasetKeyClass" title="Direct link to datahub.metadata.schema_classes.DatasetKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DatasetKeyClass</span>(<span class="arg-name">platform</span>, <span class="arg-name">name</span>, <span class="arg-name">origin</span>)<a href="#datahub.metadata.schema_classes.DatasetKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Dataset</p><ul><li><strong>Parameters:</strong><ul><li><strong>platform</strong> (<code>str</code>)</li><li><strong>name</strong> (<code>str</code>)</li><li><strong>origin</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.FabricTypeClass"><code>FabricTypeClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-14"><em>property</em> name <em>: str</em><a href="#property-name--str-14" class="hash-link" aria-label="Direct link to property-name--str-14" title="Direct link to property-name--str-14"></a></h4><p>Unique guid for dataset</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-origin--str--fabrictypeclass-1"><em>property</em> origin <em>: str | <a href="#datahub.metadata.schema_classes.FabricTypeClass">FabricTypeClass</a></em><a href="#property-origin--str--fabrictypeclass-1" class="hash-link" aria-label="Direct link to property-origin--str--fabrictypeclass-1" title="Direct link to property-origin--str--fabrictypeclass-1"></a></h4><p>Fabric type where dataset belongs to or where it was generated.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-platform--str-2"><em>property</em> platform <em>: str</em><a href="#property-platform--str-2" class="hash-link" aria-label="Direct link to property-platform--str-2" title="Direct link to property-platform--str-2"></a></h4><p>Data platform urn associated with the dataset</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DatasetLineageTypeClass"><span class="visually-hidden">DatasetLineageTypeClass</span><a href="#datahub.metadata.schema_classes.DatasetLineageTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DatasetLineageTypeClass" title="Direct link to datahub.metadata.schema_classes.DatasetLineageTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DatasetLineageTypeClass</span>()<a href="#datahub.metadata.schema_classes.DatasetLineageTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>The various types of supported dataset lineage</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="copy--copy">COPY <em>= 'COPY'</em><a href="#copy--copy" class="hash-link" aria-label="Direct link to copy--copy" title="Direct link to copy--copy"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="transformed--transformed">TRANSFORMED <em>= 'TRANSFORMED'</em><a href="#transformed--transformed" class="hash-link" aria-label="Direct link to transformed--transformed" title="Direct link to transformed--transformed"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="view--view">VIEW <em>= 'VIEW'</em><a href="#view--view" class="hash-link" aria-label="Direct link to view--view" title="Direct link to view--view"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DatasetProfileClass"><span class="visually-hidden">DatasetProfileClass</span><a href="#datahub.metadata.schema_classes.DatasetProfileClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DatasetProfileClass" title="Direct link to datahub.metadata.schema_classes.DatasetProfileClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DatasetProfileClass</span>(<span class="arg-name">timestampMillis</span>, <span class="arg-name">eventGranularity</span> = <span class="arg-default">None</span>, <span class="arg-name">partitionSpec</span> = <span class="arg-default">None</span>, <span class="arg-name">messageId</span> = <span class="arg-default">None</span>, <span class="arg-name">rowCount</span> = <span class="arg-default">None</span>, <span class="arg-name">columnCount</span> = <span class="arg-default">None</span>, <span class="arg-name">fieldProfiles</span> = <span class="arg-default">None</span>, <span class="arg-name">sizeInBytes</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DatasetProfileClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Stats corresponding to datasets</p><ul><li><strong>Parameters:</strong><ul><li><strong>timestampMillis</strong> (<code>int</code>)</li><li><strong>eventGranularity</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeWindowSizeClass"><code>TimeWindowSizeClass</code></a>]) – </li><li><strong>partitionSpec</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.PartitionSpecClass"><code>PartitionSpecClass</code></a>]) – </li><li><strong>messageId</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>rowCount</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>columnCount</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>fieldProfiles</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.DatasetFieldProfileClass"><code>DatasetFieldProfileClass</code></a>]]) – </li><li><strong>sizeInBytes</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="aspect_type--classvarstr--timeseries-6">ASPECT_TYPE <em>: <code>ClassVar</code>[<code>str</code>]</em> <em>= 'timeseries'</em><a href="#aspect_type--classvarstr--timeseries-6" class="hash-link" aria-label="Direct link to aspect_type--classvarstr--timeseries-6" title="Direct link to aspect_type--classvarstr--timeseries-6"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-columncount--none--int"><em>property</em> columnCount <em>: None | int</em><a href="#property-columncount--none--int" class="hash-link" aria-label="Direct link to property-columncount--none--int" title="Direct link to property-columncount--none--int"></a></h4><p>The total number of columns (or schema fields)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-eventgranularity--none--timewindowsizeclass-6"><em>property</em> eventGranularity <em>: None | <a href="#datahub.metadata.schema_classes.TimeWindowSizeClass">TimeWindowSizeClass</a></em><a href="#property-eventgranularity--none--timewindowsizeclass-6" class="hash-link" aria-label="Direct link to property-eventgranularity--none--timewindowsizeclass-6" title="Direct link to property-eventgranularity--none--timewindowsizeclass-6"></a></h4><p>Granularity of the event if applicable</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fieldprofiles--none--listdatasetfieldprofileclass"><em>property</em> fieldProfiles <em>: None | List[<a href="#datahub.metadata.schema_classes.DatasetFieldProfileClass">DatasetFieldProfileClass</a>]</em><a href="#property-fieldprofiles--none--listdatasetfieldprofileclass" class="hash-link" aria-label="Direct link to property-fieldprofiles--none--listdatasetfieldprofileclass" title="Direct link to property-fieldprofiles--none--listdatasetfieldprofileclass"></a></h4><p>Profiles for each column (or schema field)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-messageid--none--str-6"><em>property</em> messageId <em>: None | str</em><a href="#property-messageid--none--str-6" class="hash-link" aria-label="Direct link to property-messageid--none--str-6" title="Direct link to property-messageid--none--str-6"></a></h4><p>The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-partitionspec--partitionspecclass--none-6"><em>property</em> partitionSpec <em>: <a href="#datahub.metadata.schema_classes.PartitionSpecClass">PartitionSpecClass</a> | None</em><a href="#property-partitionspec--partitionspecclass--none-6" class="hash-link" aria-label="Direct link to property-partitionspec--partitionspecclass--none-6" title="Direct link to property-partitionspec--partitionspecclass--none-6"></a></h4><p>The optional partition specification.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-rowcount--none--int-1"><em>property</em> rowCount <em>: None | int</em><a href="#property-rowcount--none--int-1" class="hash-link" aria-label="Direct link to property-rowcount--none--int-1" title="Direct link to property-rowcount--none--int-1"></a></h4><p>The total number of rows</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-sizeinbytes--none--int"><em>property</em> sizeInBytes <em>: None | int</em><a href="#property-sizeinbytes--none--int" class="hash-link" aria-label="Direct link to property-sizeinbytes--none--int" title="Direct link to property-sizeinbytes--none--int"></a></h4><p>Storage size in bytes</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-timestampmillis--int-6"><em>property</em> timestampMillis <em>: int</em><a href="#property-timestampmillis--int-6" class="hash-link" aria-label="Direct link to property-timestampmillis--int-6" title="Direct link to property-timestampmillis--int-6"></a></h4><p>The event timestamp field as epoch at UTC in milli seconds.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DatasetPropertiesClass"><span class="visually-hidden">DatasetPropertiesClass</span><a href="#datahub.metadata.schema_classes.DatasetPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DatasetPropertiesClass" title="Direct link to datahub.metadata.schema_classes.DatasetPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DatasetPropertiesClass</span>(<span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">externalUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">name</span> = <span class="arg-default">None</span>, <span class="arg-name">qualifiedName</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">uri</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>, <span class="arg-name">tags</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DatasetPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties associated with a Dataset</p><ul><li><strong>Parameters:</strong><ul><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>externalUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>qualifiedName</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>uri</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeStampClass"><code>TimeStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeStampClass"><code>TimeStampClass</code></a>]) – </li><li><strong>tags</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--none--timestampclass-3"><em>property</em> created <em>: None | <a href="#datahub.metadata.schema_classes.TimeStampClass">TimeStampClass</a></em><a href="#property-created--none--timestampclass-3" class="hash-link" aria-label="Direct link to property-created--none--timestampclass-3" title="Direct link to property-created--none--timestampclass-3"></a></h4><p>A timestamp documenting when the asset was created in the source Data Platform (not on DataHub)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-14"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-14" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-14" title="Direct link to property-customproperties--dictstr-str-14"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-14"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-14" class="hash-link" aria-label="Direct link to property-description--none--str-14" title="Direct link to property-description--none--str-14"></a></h4><p>Documentation of the dataset</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-externalurl--none--str-12"><em>property</em> externalUrl <em>: None | str</em><a href="#property-externalurl--none--str-12" class="hash-link" aria-label="Direct link to property-externalurl--none--str-12" title="Direct link to property-externalurl--none--str-12"></a></h4><p>URL where the reference exist</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--none--timestampclass-3"><em>property</em> lastModified <em>: None | <a href="#datahub.metadata.schema_classes.TimeStampClass">TimeStampClass</a></em><a href="#property-lastmodified--none--timestampclass-3" class="hash-link" aria-label="Direct link to property-lastmodified--none--timestampclass-3" title="Direct link to property-lastmodified--none--timestampclass-3"></a></h4><p>A timestamp documenting when the asset was last modified in the source Data Platform (not on DataHub)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--none--str-4"><em>property</em> name <em>: None | str</em><a href="#property-name--none--str-4" class="hash-link" aria-label="Direct link to property-name--none--str-4" title="Direct link to property-name--none--str-4"></a></h4><p>Display name of the Dataset</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-qualifiedname--none--str-1"><em>property</em> qualifiedName <em>: None | str</em><a href="#property-qualifiedname--none--str-1" class="hash-link" aria-label="Direct link to property-qualifiedname--none--str-1" title="Direct link to property-qualifiedname--none--str-1"></a></h4><p>Fully-qualified name of the Dataset</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-tags--liststr"><em>property</em> tags <em>: List<!-- -->[str]</em><a href="#property-tags--liststr" class="hash-link" aria-label="Direct link to property-tags--liststr" title="Direct link to property-tags--liststr"></a></h4><p>[Legacy]<!-- --> Unstructured tags for the dataset. Structured tags can be applied via the GlobalTags aspect.
|
||
This is now deprecated.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-uri--none--str"><em>property</em> uri <em>: None | str</em><a href="#property-uri--none--str" class="hash-link" aria-label="Direct link to property-uri--none--str" title="Direct link to property-uri--none--str"></a></h4><p>///dir/file_name. Uri should not include any environment specific properties. Some datasets might not have a standardized uri, which makes this field optional (i.e. kafka topic).</p><ul><li><strong>Type:</strong>
|
||
The abstracted URI such as hdfs</li><li><strong>Type:</strong>
|
||
///data/tracking/PageViewEvent, file</li></ul></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DatasetSnapshotClass"><span class="visually-hidden">DatasetSnapshotClass</span><a href="#datahub.metadata.schema_classes.DatasetSnapshotClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DatasetSnapshotClass" title="Direct link to datahub.metadata.schema_classes.DatasetSnapshotClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DatasetSnapshotClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">aspects</span>)<a href="#datahub.metadata.schema_classes.DatasetSnapshotClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A metadata snapshot for a specific dataset entity.</p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>aspects</strong> (<code>List</code>[<code>Union</code>[<a href="#datahub.metadata.schema_classes.DatasetKeyClass"><code>DatasetKeyClass</code></a>, <a href="#datahub.metadata.schema_classes.DatasetPropertiesClass"><code>DatasetPropertiesClass</code></a>, <a href="#datahub.metadata.schema_classes.EditableDatasetPropertiesClass"><code>EditableDatasetPropertiesClass</code></a>, <a href="#datahub.metadata.schema_classes.DatasetDeprecationClass"><code>DatasetDeprecationClass</code></a>, <a href="#datahub.metadata.schema_classes.DatasetUpstreamLineageClass"><code>DatasetUpstreamLineageClass</code></a>, <a href="#datahub.metadata.schema_classes.UpstreamLineageClass"><code>UpstreamLineageClass</code></a>, <a href="#datahub.metadata.schema_classes.InstitutionalMemoryClass"><code>InstitutionalMemoryClass</code></a>, <a href="#datahub.metadata.schema_classes.OwnershipClass"><code>OwnershipClass</code></a>, <a href="#datahub.metadata.schema_classes.StatusClass"><code>StatusClass</code></a>, <a href="#datahub.metadata.schema_classes.SchemaMetadataClass"><code>SchemaMetadataClass</code></a>, <a href="#datahub.metadata.schema_classes.EditableSchemaMetadataClass"><code>EditableSchemaMetadataClass</code></a>, <a href="#datahub.metadata.schema_classes.GlobalTagsClass"><code>GlobalTagsClass</code></a>, <a href="#datahub.metadata.schema_classes.GlossaryTermsClass"><code>GlossaryTermsClass</code></a>, <a href="#datahub.metadata.schema_classes.BrowsePathsClass"><code>BrowsePathsClass</code></a>, <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass"><code>DataPlatformInstanceClass</code></a>, <a href="#datahub.metadata.schema_classes.ViewPropertiesClass"><code>ViewPropertiesClass</code></a>, <a href="#datahub.metadata.schema_classes.BrowsePathsV2Class"><code>BrowsePathsV2Class</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspects--listdatasetkeyclass--datasetpropertiesclass--editabledatasetpropertiesclass--datasetdeprecationclass--datasetupstreamlineageclass--upstreamlineageclass--institutionalmemoryclass--ownershipclass--statusclass--schemametadataclass--editableschemametadataclass--globaltagsclass--glossarytermsclass--browsepathsclass--dataplatforminstanceclass--viewpropertiesclass--browsepathsv2class"><em>property</em> aspects <em>: List[<a href="#datahub.metadata.schema_classes.DatasetKeyClass">DatasetKeyClass</a> | <a href="#datahub.metadata.schema_classes.DatasetPropertiesClass">DatasetPropertiesClass</a> | <a href="#datahub.metadata.schema_classes.EditableDatasetPropertiesClass">EditableDatasetPropertiesClass</a> | <a href="#datahub.metadata.schema_classes.DatasetDeprecationClass">DatasetDeprecationClass</a> | <a href="#datahub.metadata.schema_classes.DatasetUpstreamLineageClass">DatasetUpstreamLineageClass</a> | <a href="#datahub.metadata.schema_classes.UpstreamLineageClass">UpstreamLineageClass</a> | <a href="#datahub.metadata.schema_classes.InstitutionalMemoryClass">InstitutionalMemoryClass</a> | <a href="#datahub.metadata.schema_classes.OwnershipClass">OwnershipClass</a> | <a href="#datahub.metadata.schema_classes.StatusClass">StatusClass</a> | <a href="#datahub.metadata.schema_classes.SchemaMetadataClass">SchemaMetadataClass</a> | <a href="#datahub.metadata.schema_classes.EditableSchemaMetadataClass">EditableSchemaMetadataClass</a> | <a href="#datahub.metadata.schema_classes.GlobalTagsClass">GlobalTagsClass</a> | <a href="#datahub.metadata.schema_classes.GlossaryTermsClass">GlossaryTermsClass</a> | <a href="#datahub.metadata.schema_classes.BrowsePathsClass">BrowsePathsClass</a> | <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass">DataPlatformInstanceClass</a> | <a href="#datahub.metadata.schema_classes.ViewPropertiesClass">ViewPropertiesClass</a> | <a href="#datahub.metadata.schema_classes.BrowsePathsV2Class">BrowsePathsV2Class</a>]</em><a href="#property-aspects--listdatasetkeyclass--datasetpropertiesclass--editabledatasetpropertiesclass--datasetdeprecationclass--datasetupstreamlineageclass--upstreamlineageclass--institutionalmemoryclass--ownershipclass--statusclass--schemametadataclass--editableschemametadataclass--globaltagsclass--glossarytermsclass--browsepathsclass--dataplatforminstanceclass--viewpropertiesclass--browsepathsv2class" class="hash-link" aria-label="Direct link to property-aspects--listdatasetkeyclass--datasetpropertiesclass--editabledatasetpropertiesclass--datasetdeprecationclass--datasetupstreamlineageclass--upstreamlineageclass--institutionalmemoryclass--ownershipclass--statusclass--schemametadataclass--editableschemametadataclass--globaltagsclass--glossarytermsclass--browsepathsclass--dataplatforminstanceclass--viewpropertiesclass--browsepathsv2class" title="Direct link to property-aspects--listdatasetkeyclass--datasetpropertiesclass--editabledatasetpropertiesclass--datasetdeprecationclass--datasetupstreamlineageclass--upstreamlineageclass--institutionalmemoryclass--ownershipclass--statusclass--schemametadataclass--editableschemametadataclass--globaltagsclass--glossarytermsclass--browsepathsclass--dataplatforminstanceclass--viewpropertiesclass--browsepathsv2class"></a></h4><p>The list of metadata aspects associated with the dataset. Depending on the use case, this can either be all, or a selection, of supported aspects.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-10"><em>property</em> urn <em>: str</em><a href="#property-urn--str-10" class="hash-link" aria-label="Direct link to property-urn--str-10" title="Direct link to property-urn--str-10"></a></h4><p>URN for the entity the metadata snapshot is associated with.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DatasetUpstreamLineageClass"><span class="visually-hidden">DatasetUpstreamLineageClass</span><a href="#datahub.metadata.schema_classes.DatasetUpstreamLineageClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DatasetUpstreamLineageClass" title="Direct link to datahub.metadata.schema_classes.DatasetUpstreamLineageClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DatasetUpstreamLineageClass</span>(<span class="arg-name">fieldMappings</span>)<a href="#datahub.metadata.schema_classes.DatasetUpstreamLineageClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Fine Grained upstream lineage for fields in a dataset</p><ul><li><strong>Parameters:</strong><strong>fieldMappings</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.DatasetFieldMappingClass"><code>DatasetFieldMappingClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fieldmappings--listdatasetfieldmappingclass"><em>property</em> fieldMappings <em>: List[<a href="#datahub.metadata.schema_classes.DatasetFieldMappingClass">DatasetFieldMappingClass</a>]</em><a href="#property-fieldmappings--listdatasetfieldmappingclass" class="hash-link" aria-label="Direct link to property-fieldmappings--listdatasetfieldmappingclass" title="Direct link to property-fieldmappings--listdatasetfieldmappingclass"></a></h4><p>Upstream to downstream field level lineage mappings</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DatasetUsageStatisticsClass"><span class="visually-hidden">DatasetUsageStatisticsClass</span><a href="#datahub.metadata.schema_classes.DatasetUsageStatisticsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DatasetUsageStatisticsClass" title="Direct link to datahub.metadata.schema_classes.DatasetUsageStatisticsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DatasetUsageStatisticsClass</span>(<span class="arg-name">timestampMillis</span>, <span class="arg-name">eventGranularity</span> = <span class="arg-default">None</span>, <span class="arg-name">partitionSpec</span> = <span class="arg-default">None</span>, <span class="arg-name">messageId</span> = <span class="arg-default">None</span>, <span class="arg-name">uniqueUserCount</span> = <span class="arg-default">None</span>, <span class="arg-name">totalSqlQueries</span> = <span class="arg-default">None</span>, <span class="arg-name">topSqlQueries</span> = <span class="arg-default">None</span>, <span class="arg-name">userCounts</span> = <span class="arg-default">None</span>, <span class="arg-name">fieldCounts</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DatasetUsageStatisticsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Stats corresponding to dataset’s usage.</p><ul><li><strong>Parameters:</strong><ul><li><strong>timestampMillis</strong> (<code>int</code>)</li><li><strong>eventGranularity</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeWindowSizeClass"><code>TimeWindowSizeClass</code></a>]) – </li><li><strong>partitionSpec</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.PartitionSpecClass"><code>PartitionSpecClass</code></a>]) – </li><li><strong>messageId</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>uniqueUserCount</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>totalSqlQueries</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>topSqlQueries</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>userCounts</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.DatasetUserUsageCountsClass"><code>DatasetUserUsageCountsClass</code></a>]]) – </li><li><strong>fieldCounts</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.DatasetFieldUsageCountsClass"><code>DatasetFieldUsageCountsClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="aspect_type--classvarstr--timeseries-7">ASPECT_TYPE <em>: <code>ClassVar</code>[<code>str</code>]</em> <em>= 'timeseries'</em><a href="#aspect_type--classvarstr--timeseries-7" class="hash-link" aria-label="Direct link to aspect_type--classvarstr--timeseries-7" title="Direct link to aspect_type--classvarstr--timeseries-7"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-eventgranularity--none--timewindowsizeclass-7"><em>property</em> eventGranularity <em>: None | <a href="#datahub.metadata.schema_classes.TimeWindowSizeClass">TimeWindowSizeClass</a></em><a href="#property-eventgranularity--none--timewindowsizeclass-7" class="hash-link" aria-label="Direct link to property-eventgranularity--none--timewindowsizeclass-7" title="Direct link to property-eventgranularity--none--timewindowsizeclass-7"></a></h4><p>Granularity of the event if applicable</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fieldcounts--none--listdatasetfieldusagecountsclass"><em>property</em> fieldCounts <em>: None | List[<a href="#datahub.metadata.schema_classes.DatasetFieldUsageCountsClass">DatasetFieldUsageCountsClass</a>]</em><a href="#property-fieldcounts--none--listdatasetfieldusagecountsclass" class="hash-link" aria-label="Direct link to property-fieldcounts--none--listdatasetfieldusagecountsclass" title="Direct link to property-fieldcounts--none--listdatasetfieldusagecountsclass"></a></h4><p>Field-level usage stats</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-messageid--none--str-7"><em>property</em> messageId <em>: None | str</em><a href="#property-messageid--none--str-7" class="hash-link" aria-label="Direct link to property-messageid--none--str-7" title="Direct link to property-messageid--none--str-7"></a></h4><p>The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-partitionspec--partitionspecclass--none-7"><em>property</em> partitionSpec <em>: <a href="#datahub.metadata.schema_classes.PartitionSpecClass">PartitionSpecClass</a> | None</em><a href="#property-partitionspec--partitionspecclass--none-7" class="hash-link" aria-label="Direct link to property-partitionspec--partitionspecclass--none-7" title="Direct link to property-partitionspec--partitionspecclass--none-7"></a></h4><p>The optional partition specification.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-timestampmillis--int-7"><em>property</em> timestampMillis <em>: int</em><a href="#property-timestampmillis--int-7" class="hash-link" aria-label="Direct link to property-timestampmillis--int-7" title="Direct link to property-timestampmillis--int-7"></a></h4><p>The event timestamp field as epoch at UTC in milli seconds.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-topsqlqueries--none--liststr"><em>property</em> topSqlQueries <em>: None | List<!-- -->[str]</em><a href="#property-topsqlqueries--none--liststr" class="hash-link" aria-label="Direct link to property-topsqlqueries--none--liststr" title="Direct link to property-topsqlqueries--none--liststr"></a></h4><p>Frequent SQL queries; mostly makes sense for datasets in SQL databases</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-totalsqlqueries--none--int"><em>property</em> totalSqlQueries <em>: None | int</em><a href="#property-totalsqlqueries--none--int" class="hash-link" aria-label="Direct link to property-totalsqlqueries--none--int" title="Direct link to property-totalsqlqueries--none--int"></a></h4><p>Total SQL query count</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-uniqueusercount--none--int-2"><em>property</em> uniqueUserCount <em>: None | int</em><a href="#property-uniqueusercount--none--int-2" class="hash-link" aria-label="Direct link to property-uniqueusercount--none--int-2" title="Direct link to property-uniqueusercount--none--int-2"></a></h4><p>Unique user count</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-usercounts--none--listdatasetuserusagecountsclass"><em>property</em> userCounts <em>: None | List[<a href="#datahub.metadata.schema_classes.DatasetUserUsageCountsClass">DatasetUserUsageCountsClass</a>]</em><a href="#property-usercounts--none--listdatasetuserusagecountsclass" class="hash-link" aria-label="Direct link to property-usercounts--none--listdatasetuserusagecountsclass" title="Direct link to property-usercounts--none--listdatasetuserusagecountsclass"></a></h4><p>Users within this bucket, with frequency counts</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DatasetUserUsageCountsClass"><span class="visually-hidden">DatasetUserUsageCountsClass</span><a href="#datahub.metadata.schema_classes.DatasetUserUsageCountsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DatasetUserUsageCountsClass" title="Direct link to datahub.metadata.schema_classes.DatasetUserUsageCountsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DatasetUserUsageCountsClass</span>(<span class="arg-name">user</span>, <span class="arg-name">count</span>, <span class="arg-name">userEmail</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DatasetUserUsageCountsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Records a single user’s usage counts for a given resource</p><ul><li><strong>Parameters:</strong><ul><li><strong>user</strong> (<code>str</code>)</li><li><strong>count</strong> (<code>int</code>)</li><li><strong>userEmail</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-count--int-1"><em>property</em> count <em>: int</em><a href="#property-count--int-1" class="hash-link" aria-label="Direct link to property-count--int-1" title="Direct link to property-count--int-1"></a></h4><p>Number of times the dataset has been used by the user.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-user--str-2"><em>property</em> user <em>: str</em><a href="#property-user--str-2" class="hash-link" aria-label="Direct link to property-user--str-2" title="Direct link to property-user--str-2"></a></h4><p>The unique id of the user.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-useremail--none--str-1"><em>property</em> userEmail <em>: None | str</em><a href="#property-useremail--none--str-1" class="hash-link" aria-label="Direct link to property-useremail--none--str-1" title="Direct link to property-useremail--none--str-1"></a></h4><p>If user_email is set, we attempt to resolve the user’s urn upon ingest</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DateTypeClass"><span class="visually-hidden">DateTypeClass</span><a href="#datahub.metadata.schema_classes.DateTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DateTypeClass" title="Direct link to datahub.metadata.schema_classes.DateTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DateTypeClass</span>()<a href="#datahub.metadata.schema_classes.DateTypeClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Date field type.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DeploymentStatusClass"><span class="visually-hidden">DeploymentStatusClass</span><a href="#datahub.metadata.schema_classes.DeploymentStatusClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DeploymentStatusClass" title="Direct link to datahub.metadata.schema_classes.DeploymentStatusClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DeploymentStatusClass</span>()<a href="#datahub.metadata.schema_classes.DeploymentStatusClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>Model endpoint statuses</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="creating--creating">CREATING <em>= 'CREATING'</em><a href="#creating--creating" class="hash-link" aria-label="Direct link to creating--creating" title="Direct link to creating--creating"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="deleting--deleting">DELETING <em>= 'DELETING'</em><a href="#deleting--deleting" class="hash-link" aria-label="Direct link to deleting--deleting" title="Direct link to deleting--deleting"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="failed--failed-1">FAILED <em>= 'FAILED'</em><a href="#failed--failed-1" class="hash-link" aria-label="Direct link to failed--failed-1" title="Direct link to failed--failed-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="in_service--in_service">IN_SERVICE <em>= 'IN_SERVICE'</em><a href="#in_service--in_service" class="hash-link" aria-label="Direct link to in_service--in_service" title="Direct link to in_service--in_service"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="out_of_service--out_of_service">OUT_OF_SERVICE <em>= 'OUT_OF_SERVICE'</em><a href="#out_of_service--out_of_service" class="hash-link" aria-label="Direct link to out_of_service--out_of_service" title="Direct link to out_of_service--out_of_service"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="rolling_back--rolling_back">ROLLING_BACK <em>= 'ROLLING_BACK'</em><a href="#rolling_back--rolling_back" class="hash-link" aria-label="Direct link to rolling_back--rolling_back" title="Direct link to rolling_back--rolling_back"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="unknown--unknown-2">UNKNOWN <em>= 'UNKNOWN'</em><a href="#unknown--unknown-2" class="hash-link" aria-label="Direct link to unknown--unknown-2" title="Direct link to unknown--unknown-2"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="updating--updating">UPDATING <em>= 'UPDATING'</em><a href="#updating--updating" class="hash-link" aria-label="Direct link to updating--updating" title="Direct link to updating--updating"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DeprecationClass"><span class="visually-hidden">DeprecationClass</span><a href="#datahub.metadata.schema_classes.DeprecationClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DeprecationClass" title="Direct link to datahub.metadata.schema_classes.DeprecationClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DeprecationClass</span>(<span class="arg-name">deprecated</span>, <span class="arg-name">note</span>, <span class="arg-name">actor</span>, <span class="arg-name">decommissionTime</span> = <span class="arg-default">None</span>, <span class="arg-name">replacement</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DeprecationClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Deprecation status of an entity</p><ul><li><strong>Parameters:</strong><ul><li><strong>deprecated</strong> (<code>bool</code>)</li><li><strong>note</strong> (<code>str</code>)</li><li><strong>actor</strong> (<code>str</code>)</li><li><strong>decommissionTime</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>replacement</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-actor--str-1"><em>property</em> actor <em>: str</em><a href="#property-actor--str-1" class="hash-link" aria-label="Direct link to property-actor--str-1" title="Direct link to property-actor--str-1"></a></h4><p>The user URN which will be credited for modifying this deprecation content.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-decommissiontime--none--int-1"><em>property</em> decommissionTime <em>: None | int</em><a href="#property-decommissiontime--none--int-1" class="hash-link" aria-label="Direct link to property-decommissiontime--none--int-1" title="Direct link to property-decommissiontime--none--int-1"></a></h4><p>The time user plan to decommission this entity.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-deprecated--bool-1"><em>property</em> deprecated <em>: bool</em><a href="#property-deprecated--bool-1" class="hash-link" aria-label="Direct link to property-deprecated--bool-1" title="Direct link to property-deprecated--bool-1"></a></h4><p>Whether the entity is deprecated.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-note--str-1"><em>property</em> note <em>: str</em><a href="#property-note--str-1" class="hash-link" aria-label="Direct link to property-note--str-1" title="Direct link to property-note--str-1"></a></h4><p>Additional information about the entity deprecation plan, such as the wiki, doc, RB.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-replacement--none--str"><em>property</em> replacement <em>: None | str</em><a href="#property-replacement--none--str" class="hash-link" aria-label="Direct link to property-replacement--none--str" title="Direct link to property-replacement--none--str"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DisplayPropertiesClass"><span class="visually-hidden">DisplayPropertiesClass</span><a href="#datahub.metadata.schema_classes.DisplayPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DisplayPropertiesClass" title="Direct link to datahub.metadata.schema_classes.DisplayPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DisplayPropertiesClass</span>(<span class="arg-name">colorHex</span> = <span class="arg-default">None</span>, <span class="arg-name">icon</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DisplayPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties related to how the entity is displayed in the Datahub UI</p><ul><li><strong>Parameters:</strong><ul><li><strong>colorHex</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>icon</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.IconPropertiesClass"><code>IconPropertiesClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-colorhex--none--str"><em>property</em> colorHex <em>: None | str</em><a href="#property-colorhex--none--str" class="hash-link" aria-label="Direct link to property-colorhex--none--str" title="Direct link to property-colorhex--none--str"></a></h4><p>The color associated with the entity in Hex. For example #FFFFFF.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-icon--none--iconpropertiesclass"><em>property</em> icon <em>: None | <a href="#datahub.metadata.schema_classes.IconPropertiesClass">IconPropertiesClass</a></em><a href="#property-icon--none--iconpropertiesclass" class="hash-link" aria-label="Direct link to property-icon--none--iconpropertiesclass" title="Direct link to property-icon--none--iconpropertiesclass"></a></h4><p>The icon associated with the entity</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DocPropagationFeatureSettingsClass"><span class="visually-hidden">DocPropagationFeatureSettingsClass</span><a href="#datahub.metadata.schema_classes.DocPropagationFeatureSettingsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DocPropagationFeatureSettingsClass" title="Direct link to datahub.metadata.schema_classes.DocPropagationFeatureSettingsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DocPropagationFeatureSettingsClass</span>(<span class="arg-name">enabled</span>, <span class="arg-name">config</span> = <span class="arg-default">None</span>, <span class="arg-name">configVersion</span> = <span class="arg-default">None</span>, <span class="arg-name">columnPropagationEnabled</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DocPropagationFeatureSettingsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>enabled</strong> (<code>bool</code>)</li><li><strong>config</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>configVersion</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>columnPropagationEnabled</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-columnpropagationenabled--bool"><em>property</em> columnPropagationEnabled <em>: bool</em><a href="#property-columnpropagationenabled--bool" class="hash-link" aria-label="Direct link to property-columnpropagationenabled--bool" title="Direct link to property-columnpropagationenabled--bool"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-config--none--str-1"><em>property</em> config <em>: None | str</em><a href="#property-config--none--str-1" class="hash-link" aria-label="Direct link to property-config--none--str-1" title="Direct link to property-config--none--str-1"></a></h4><p>The configuration for the feature, in JSON format.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-configversion--none--str"><em>property</em> configVersion <em>: None | str</em><a href="#property-configversion--none--str" class="hash-link" aria-label="Direct link to property-configversion--none--str" title="Direct link to property-configversion--none--str"></a></h4><p>The version of the configuration schema that has been used to serialize
|
||
: the config.</p><p>If not provided, the version is assumed to be the latest version.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-enabled--bool"><em>property</em> enabled <em>: bool</em><a href="#property-enabled--bool" class="hash-link" aria-label="Direct link to property-enabled--bool" title="Direct link to property-enabled--bool"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DocumentationAssociationClass"><span class="visually-hidden">DocumentationAssociationClass</span><a href="#datahub.metadata.schema_classes.DocumentationAssociationClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DocumentationAssociationClass" title="Direct link to datahub.metadata.schema_classes.DocumentationAssociationClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DocumentationAssociationClass</span>(<span class="arg-name">documentation</span>, <span class="arg-name">attribution</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DocumentationAssociationClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Properties of applied documentation including the attribution of the doc</p><ul><li><strong>Parameters:</strong><ul><li><strong>documentation</strong> (<code>str</code>)</li><li><strong>attribution</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.MetadataAttributionClass"><code>MetadataAttributionClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-attribution--none--metadataattributionclass"><em>property</em> attribution <em>: None | <a href="#datahub.metadata.schema_classes.MetadataAttributionClass">MetadataAttributionClass</a></em><a href="#property-attribution--none--metadataattributionclass" class="hash-link" aria-label="Direct link to property-attribution--none--metadataattributionclass" title="Direct link to property-attribution--none--metadataattributionclass"></a></h4><p>Information about who, why, and how this metadata was applied</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-documentation--str"><em>property</em> documentation <em>: str</em><a href="#property-documentation--str" class="hash-link" aria-label="Direct link to property-documentation--str" title="Direct link to property-documentation--str"></a></h4><p>Description of this asset</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DocumentationClass"><span class="visually-hidden">DocumentationClass</span><a href="#datahub.metadata.schema_classes.DocumentationClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DocumentationClass" title="Direct link to datahub.metadata.schema_classes.DocumentationClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DocumentationClass</span>(<span class="arg-name">documentations</span>)<a href="#datahub.metadata.schema_classes.DocumentationClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Aspect used for storing all applicable documentations on assets.
|
||
This aspect supports multiple documentations from different sources.
|
||
There is an implicit assumption that there is only one documentation per</p><blockquote><p>source.</p></blockquote><p>For example, if there are two documentations from the same source, the
|
||
: latest one will overwrite the previous one.</p><p>If there are two documentations from different sources, both will be
|
||
: stored.</p><p>Future evolution considerations:
|
||
The first entity that uses this aspect is Schema Field. We will expand this</p><blockquote><p>aspect to other entities eventually.</p></blockquote><p>The values of the documentation are not currently searchable. This will be
|
||
: changed once this aspect develops opinion on which documentation entry is
|
||
the authoritative one.</p><p>Ensuring that there is only one documentation per source is a business
|
||
: rule that is not enforced by the aspect yet. This will currently be enforced by the
|
||
application that uses this aspect. We will eventually enforce this rule in
|
||
the aspect using AspectMutators.</p><ul><li><strong>Parameters:</strong><strong>documentations</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.DocumentationAssociationClass"><code>DocumentationAssociationClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-documentations--listdocumentationassociationclass"><em>property</em> documentations <em>: List[<a href="#datahub.metadata.schema_classes.DocumentationAssociationClass">DocumentationAssociationClass</a>]</em><a href="#property-documentations--listdocumentationassociationclass" class="hash-link" aria-label="Direct link to property-documentations--listdocumentationassociationclass" title="Direct link to property-documentations--listdocumentationassociationclass"></a></h4><p>Documentations associated with this asset. We could be receiving docs from different sources</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DomainKeyClass"><span class="visually-hidden">DomainKeyClass</span><a href="#datahub.metadata.schema_classes.DomainKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DomainKeyClass" title="Direct link to datahub.metadata.schema_classes.DomainKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DomainKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.DomainKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for an Asset Domain</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-21"><em>property</em> id <em>: str</em><a href="#property-id--str-21" class="hash-link" aria-label="Direct link to property-id--str-21" title="Direct link to property-id--str-21"></a></h4><p>A unique id for the domain. Should be separate from the name used for displaying a Domain.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DomainPropertiesClass"><span class="visually-hidden">DomainPropertiesClass</span><a href="#datahub.metadata.schema_classes.DomainPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DomainPropertiesClass" title="Direct link to datahub.metadata.schema_classes.DomainPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DomainPropertiesClass</span>(<span class="arg-name">name</span>, <span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">parentDomain</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.DomainPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a Domain</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>parentDomain</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--none--auditstampclass-4"><em>property</em> created <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--none--auditstampclass-4" class="hash-link" aria-label="Direct link to property-created--none--auditstampclass-4" title="Direct link to property-created--none--auditstampclass-4"></a></h4><p>Created Audit stamp</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-15"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-15" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-15" title="Direct link to property-customproperties--dictstr-str-15"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-15"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-15" class="hash-link" aria-label="Direct link to property-description--none--str-15" title="Direct link to property-description--none--str-15"></a></h4><p>Description of the Domain</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-15"><em>property</em> name <em>: str</em><a href="#property-name--str-15" class="hash-link" aria-label="Direct link to property-name--str-15" title="Direct link to property-name--str-15"></a></h4><p>Display name of the Domain</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-parentdomain--none--str"><em>property</em> parentDomain <em>: None | str</em><a href="#property-parentdomain--none--str" class="hash-link" aria-label="Direct link to property-parentdomain--none--str" title="Direct link to property-parentdomain--none--str"></a></h4><p>Parent of the domain</p><ul><li><strong>Type:</strong>
|
||
Optional</li></ul></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DomainsClass"><span class="visually-hidden">DomainsClass</span><a href="#datahub.metadata.schema_classes.DomainsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DomainsClass" title="Direct link to datahub.metadata.schema_classes.DomainsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DomainsClass</span>(<span class="arg-name">domains</span>)<a href="#datahub.metadata.schema_classes.DomainsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Links from an Asset to its Domains</p><ul><li><strong>Parameters:</strong><strong>domains</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-domains--liststr"><em>property</em> domains <em>: List<!-- -->[str]</em><a href="#property-domains--liststr" class="hash-link" aria-label="Direct link to property-domains--liststr" title="Direct link to property-domains--liststr"></a></h4><p>The Domains attached to an Asset</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.DynamicFormAssignmentClass"><span class="visually-hidden">DynamicFormAssignmentClass</span><a href="#datahub.metadata.schema_classes.DynamicFormAssignmentClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.DynamicFormAssignmentClass" title="Direct link to datahub.metadata.schema_classes.DynamicFormAssignmentClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">DynamicFormAssignmentClass</span>(<span class="arg-name">filter</span>)<a href="#datahub.metadata.schema_classes.DynamicFormAssignmentClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about how a form is assigned to entities dynamically. Provide a filter to
|
||
match a set of entities instead of explicitly applying a form to specific entities.</p><ul><li><strong>Parameters:</strong><strong>filter</strong> (<a href="#datahub.metadata.schema_classes.FilterClass"><code>FilterClass</code></a>) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-filter--filterclass-1"><em>property</em> filter <em>: <a href="#datahub.metadata.schema_classes.FilterClass">FilterClass</a></em><a href="#property-filter--filterclass-1" class="hash-link" aria-label="Direct link to property-filter--filterclass-1" title="Direct link to property-filter--filterclass-1"></a></h4><p>The filter applied when assigning this form to entities. Entities that match this filter
|
||
will have this form applied to them. Right now this filter only supports filtering by
|
||
platform, entity type, container, and domain through the UI.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ERModelRelationshipCardinalityClass"><span class="visually-hidden">ERModelRelationshipCardinalityClass</span><a href="#datahub.metadata.schema_classes.ERModelRelationshipCardinalityClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ERModelRelationshipCardinalityClass" title="Direct link to datahub.metadata.schema_classes.ERModelRelationshipCardinalityClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ERModelRelationshipCardinalityClass</span>()<a href="#datahub.metadata.schema_classes.ERModelRelationshipCardinalityClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="n_n--n_n">N_N <em>= 'N_N'</em><a href="#n_n--n_n" class="hash-link" aria-label="Direct link to n_n--n_n" title="Direct link to n_n--n_n"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="n_one--n_one">N_ONE <em>= 'N_ONE'</em><a href="#n_one--n_one" class="hash-link" aria-label="Direct link to n_one--n_one" title="Direct link to n_one--n_one"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="one_n--one_n">ONE_N <em>= 'ONE_N'</em><a href="#one_n--one_n" class="hash-link" aria-label="Direct link to one_n--one_n" title="Direct link to one_n--one_n"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="one_one--one_one">ONE_ONE <em>= 'ONE_ONE'</em><a href="#one_one--one_one" class="hash-link" aria-label="Direct link to one_one--one_one" title="Direct link to one_one--one_one"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ERModelRelationshipKeyClass"><span class="visually-hidden">ERModelRelationshipKeyClass</span><a href="#datahub.metadata.schema_classes.ERModelRelationshipKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ERModelRelationshipKeyClass" title="Direct link to datahub.metadata.schema_classes.ERModelRelationshipKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ERModelRelationshipKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.ERModelRelationshipKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a ERModelRelationship</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-22"><em>property</em> id <em>: str</em><a href="#property-id--str-22" class="hash-link" aria-label="Direct link to property-id--str-22" title="Direct link to property-id--str-22"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ERModelRelationshipPropertiesClass"><span class="visually-hidden">ERModelRelationshipPropertiesClass</span><a href="#datahub.metadata.schema_classes.ERModelRelationshipPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ERModelRelationshipPropertiesClass" title="Direct link to datahub.metadata.schema_classes.ERModelRelationshipPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ERModelRelationshipPropertiesClass</span>(<span class="arg-name">name</span>, <span class="arg-name">source</span>, <span class="arg-name">destination</span>, <span class="arg-name">relationshipFieldMappings</span>, <span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>, <span class="arg-name">cardinality</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.ERModelRelationshipPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties associated with a ERModelRelationship</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>source</strong> (<code>str</code>)</li><li><strong>destination</strong> (<code>str</code>)</li><li><strong>relationshipFieldMappings</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.RelationshipFieldMappingClass"><code>RelationshipFieldMappingClass</code></a>]) – </li><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>cardinality</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.ERModelRelationshipCardinalityClass"><code>ERModelRelationshipCardinalityClass</code></a>, <code>None</code>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-cardinality--str--ermodelrelationshipcardinalityclass"><em>property</em> cardinality <em>: str | <a href="#datahub.metadata.schema_classes.ERModelRelationshipCardinalityClass">ERModelRelationshipCardinalityClass</a></em><a href="#property-cardinality--str--ermodelrelationshipcardinalityclass" class="hash-link" aria-label="Direct link to property-cardinality--str--ermodelrelationshipcardinalityclass" title="Direct link to property-cardinality--str--ermodelrelationshipcardinalityclass"></a></h4><p>Cardinality of the relationship</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--none--auditstampclass-5"><em>property</em> created <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--none--auditstampclass-5" class="hash-link" aria-label="Direct link to property-created--none--auditstampclass-5" title="Direct link to property-created--none--auditstampclass-5"></a></h4><p>A timestamp documenting when the asset was created in the source Data Platform (not on DataHub)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-16"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-16" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-16" title="Direct link to property-customproperties--dictstr-str-16"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-destination--str"><em>property</em> destination <em>: str</em><a href="#property-destination--str" class="hash-link" aria-label="Direct link to property-destination--str" title="Direct link to property-destination--str"></a></h4><p>Second dataset in the erModelRelationship (no directionality)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--none--auditstampclass-1"><em>property</em> lastModified <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--none--auditstampclass-1" class="hash-link" aria-label="Direct link to property-lastmodified--none--auditstampclass-1" title="Direct link to property-lastmodified--none--auditstampclass-1"></a></h4><p>A timestamp documenting when the asset was last modified in the source Data Platform (not on DataHub)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-16"><em>property</em> name <em>: str</em><a href="#property-name--str-16" class="hash-link" aria-label="Direct link to property-name--str-16" title="Direct link to property-name--str-16"></a></h4><p>Name of the ERModelRelation</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-relationshipfieldmappings--listrelationshipfieldmappingclass"><em>property</em> relationshipFieldMappings <em>: List[<a href="#datahub.metadata.schema_classes.RelationshipFieldMappingClass">RelationshipFieldMappingClass</a>]</em><a href="#property-relationshipfieldmappings--listrelationshipfieldmappingclass" class="hash-link" aria-label="Direct link to property-relationshipfieldmappings--listrelationshipfieldmappingclass" title="Direct link to property-relationshipfieldmappings--listrelationshipfieldmappingclass"></a></h4><p>ERModelRelationFieldMapping (in future we can make it an array)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-source--str"><em>property</em> source <em>: str</em><a href="#property-source--str" class="hash-link" aria-label="Direct link to property-source--str" title="Direct link to property-source--str"></a></h4><p>First dataset in the erModelRelationship (no directionality)</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EdgeClass"><span class="visually-hidden">EdgeClass</span><a href="#datahub.metadata.schema_classes.EdgeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EdgeClass" title="Direct link to datahub.metadata.schema_classes.EdgeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EdgeClass</span>(<span class="arg-name">destinationUrn</span>, <span class="arg-name">sourceUrn</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>, <span class="arg-name">properties</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.EdgeClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A common structure to represent all edges to entities when used inside aspects as collections
|
||
This ensures that all edges have common structure around audit-stamps and will support PATCH, time-travel automatically.</p><ul><li><strong>Parameters:</strong><ul><li><strong>destinationUrn</strong> (<code>str</code>)</li><li><strong>sourceUrn</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>properties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--none--auditstampclass-6"><em>property</em> created <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--none--auditstampclass-6" class="hash-link" aria-label="Direct link to property-created--none--auditstampclass-6" title="Direct link to property-created--none--auditstampclass-6"></a></h4><p>Audit stamp containing who created this relationship edge and when</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-destinationurn--str-1"><em>property</em> destinationUrn <em>: str</em><a href="#property-destinationurn--str-1" class="hash-link" aria-label="Direct link to property-destinationurn--str-1" title="Direct link to property-destinationurn--str-1"></a></h4><p>Urn of the destination of this relationship edge.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--none--auditstampclass-2"><em>property</em> lastModified <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--none--auditstampclass-2" class="hash-link" aria-label="Direct link to property-lastmodified--none--auditstampclass-2" title="Direct link to property-lastmodified--none--auditstampclass-2"></a></h4><p>Audit stamp containing who last modified this relationship edge and when</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-properties--none--dictstr-str-2"><em>property</em> properties <em>: None | Dict<!-- -->[str, str]</em><a href="#property-properties--none--dictstr-str-2" class="hash-link" aria-label="Direct link to property-properties--none--dictstr-str-2" title="Direct link to property-properties--none--dictstr-str-2"></a></h4><p>A generic properties bag that allows us to store specific information on this graph edge.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-sourceurn--none--str-1"><em>property</em> sourceUrn <em>: None | str</em><a href="#property-sourceurn--none--str-1" class="hash-link" aria-label="Direct link to property-sourceurn--none--str-1" title="Direct link to property-sourceurn--none--str-1"></a></h4><p>Urn of the source of this relationship edge.
|
||
If not specified, assumed to be the entity that this aspect belongs to.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EditableChartPropertiesClass"><span class="visually-hidden">EditableChartPropertiesClass</span><a href="#datahub.metadata.schema_classes.EditableChartPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EditableChartPropertiesClass" title="Direct link to datahub.metadata.schema_classes.EditableChartPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EditableChartPropertiesClass</span>(<span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>, <span class="arg-name">deleted</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.EditableChartPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Stores editable changes made to properties. This separates changes made from
|
||
ingestion pipelines and edits in the UI to avoid accidental overwrites of user-provided data by ingestion pipelines</p><ul><li><strong>Parameters:</strong><ul><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>deleted</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--auditstampclass-7"><em>property</em> created <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--auditstampclass-7" class="hash-link" aria-label="Direct link to property-created--auditstampclass-7" title="Direct link to property-created--auditstampclass-7"></a></h4><p>An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-deleted--none--auditstampclass-2"><em>property</em> deleted <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-deleted--none--auditstampclass-2" class="hash-link" aria-label="Direct link to property-deleted--none--auditstampclass-2" title="Direct link to property-deleted--none--auditstampclass-2"></a></h4><p>An AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-16"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-16" class="hash-link" aria-label="Direct link to property-description--none--str-16" title="Direct link to property-description--none--str-16"></a></h4><p>Edited documentation of the chart</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--auditstampclass-7"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--auditstampclass-7" class="hash-link" aria-label="Direct link to property-lastmodified--auditstampclass-7" title="Direct link to property-lastmodified--auditstampclass-7"></a></h4><p>An AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EditableContainerPropertiesClass"><span class="visually-hidden">EditableContainerPropertiesClass</span><a href="#datahub.metadata.schema_classes.EditableContainerPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EditableContainerPropertiesClass" title="Direct link to datahub.metadata.schema_classes.EditableContainerPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EditableContainerPropertiesClass</span>(<span class="arg-name">description</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.EditableContainerPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Editable information about an Asset Container as defined on the DataHub Platform</p><ul><li><strong>Parameters:</strong><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-17"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-17" class="hash-link" aria-label="Direct link to property-description--none--str-17" title="Direct link to property-description--none--str-17"></a></h4><p>Description of the Asset Container as its received on the DataHub Platform</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EditableDashboardPropertiesClass"><span class="visually-hidden">EditableDashboardPropertiesClass</span><a href="#datahub.metadata.schema_classes.EditableDashboardPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EditableDashboardPropertiesClass" title="Direct link to datahub.metadata.schema_classes.EditableDashboardPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EditableDashboardPropertiesClass</span>(<span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>, <span class="arg-name">deleted</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.EditableDashboardPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Stores editable changes made to properties. This separates changes made from
|
||
ingestion pipelines and edits in the UI to avoid accidental overwrites of user-provided data by ingestion pipelines</p><ul><li><strong>Parameters:</strong><ul><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>deleted</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--auditstampclass-8"><em>property</em> created <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--auditstampclass-8" class="hash-link" aria-label="Direct link to property-created--auditstampclass-8" title="Direct link to property-created--auditstampclass-8"></a></h4><p>An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-deleted--none--auditstampclass-3"><em>property</em> deleted <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-deleted--none--auditstampclass-3" class="hash-link" aria-label="Direct link to property-deleted--none--auditstampclass-3" title="Direct link to property-deleted--none--auditstampclass-3"></a></h4><p>An AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-18"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-18" class="hash-link" aria-label="Direct link to property-description--none--str-18" title="Direct link to property-description--none--str-18"></a></h4><p>Edited documentation of the dashboard</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--auditstampclass-8"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--auditstampclass-8" class="hash-link" aria-label="Direct link to property-lastmodified--auditstampclass-8" title="Direct link to property-lastmodified--auditstampclass-8"></a></h4><p>An AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EditableDataFlowPropertiesClass"><span class="visually-hidden">EditableDataFlowPropertiesClass</span><a href="#datahub.metadata.schema_classes.EditableDataFlowPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EditableDataFlowPropertiesClass" title="Direct link to datahub.metadata.schema_classes.EditableDataFlowPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EditableDataFlowPropertiesClass</span>(<span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>, <span class="arg-name">deleted</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.EditableDataFlowPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Stores editable changes made to properties. This separates changes made from
|
||
ingestion pipelines and edits in the UI to avoid accidental overwrites of user-provided data by ingestion pipelines</p><ul><li><strong>Parameters:</strong><ul><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>deleted</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--auditstampclass-9"><em>property</em> created <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--auditstampclass-9" class="hash-link" aria-label="Direct link to property-created--auditstampclass-9" title="Direct link to property-created--auditstampclass-9"></a></h4><p>An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-deleted--none--auditstampclass-4"><em>property</em> deleted <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-deleted--none--auditstampclass-4" class="hash-link" aria-label="Direct link to property-deleted--none--auditstampclass-4" title="Direct link to property-deleted--none--auditstampclass-4"></a></h4><p>An AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-19"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-19" class="hash-link" aria-label="Direct link to property-description--none--str-19" title="Direct link to property-description--none--str-19"></a></h4><p>Edited documentation of the data flow</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--auditstampclass-9"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--auditstampclass-9" class="hash-link" aria-label="Direct link to property-lastmodified--auditstampclass-9" title="Direct link to property-lastmodified--auditstampclass-9"></a></h4><p>An AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EditableDataJobPropertiesClass"><span class="visually-hidden">EditableDataJobPropertiesClass</span><a href="#datahub.metadata.schema_classes.EditableDataJobPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EditableDataJobPropertiesClass" title="Direct link to datahub.metadata.schema_classes.EditableDataJobPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EditableDataJobPropertiesClass</span>(<span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>, <span class="arg-name">deleted</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.EditableDataJobPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Stores editable changes made to properties. This separates changes made from
|
||
ingestion pipelines and edits in the UI to avoid accidental overwrites of user-provided data by ingestion pipelines</p><ul><li><strong>Parameters:</strong><ul><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>deleted</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--auditstampclass-10"><em>property</em> created <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--auditstampclass-10" class="hash-link" aria-label="Direct link to property-created--auditstampclass-10" title="Direct link to property-created--auditstampclass-10"></a></h4><p>An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-deleted--none--auditstampclass-5"><em>property</em> deleted <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-deleted--none--auditstampclass-5" class="hash-link" aria-label="Direct link to property-deleted--none--auditstampclass-5" title="Direct link to property-deleted--none--auditstampclass-5"></a></h4><p>An AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-20"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-20" class="hash-link" aria-label="Direct link to property-description--none--str-20" title="Direct link to property-description--none--str-20"></a></h4><p>Edited documentation of the data job</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--auditstampclass-10"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--auditstampclass-10" class="hash-link" aria-label="Direct link to property-lastmodified--auditstampclass-10" title="Direct link to property-lastmodified--auditstampclass-10"></a></h4><p>An AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EditableDatasetPropertiesClass"><span class="visually-hidden">EditableDatasetPropertiesClass</span><a href="#datahub.metadata.schema_classes.EditableDatasetPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EditableDatasetPropertiesClass" title="Direct link to datahub.metadata.schema_classes.EditableDatasetPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EditableDatasetPropertiesClass</span>(<span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>, <span class="arg-name">deleted</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">name</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.EditableDatasetPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>EditableDatasetProperties stores editable changes made to dataset properties. This separates changes made from
|
||
ingestion pipelines and edits in the UI to avoid accidental overwrites of user-provided data by ingestion pipelines</p><ul><li><strong>Parameters:</strong><ul><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>deleted</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--auditstampclass-11"><em>property</em> created <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--auditstampclass-11" class="hash-link" aria-label="Direct link to property-created--auditstampclass-11" title="Direct link to property-created--auditstampclass-11"></a></h4><p>An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-deleted--none--auditstampclass-6"><em>property</em> deleted <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-deleted--none--auditstampclass-6" class="hash-link" aria-label="Direct link to property-deleted--none--auditstampclass-6" title="Direct link to property-deleted--none--auditstampclass-6"></a></h4><p>An AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-21"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-21" class="hash-link" aria-label="Direct link to property-description--none--str-21" title="Direct link to property-description--none--str-21"></a></h4><p>Documentation of the dataset</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--auditstampclass-11"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--auditstampclass-11" class="hash-link" aria-label="Direct link to property-lastmodified--auditstampclass-11" title="Direct link to property-lastmodified--auditstampclass-11"></a></h4><p>An AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--none--str-5"><em>property</em> name <em>: None | str</em><a href="#property-name--none--str-5" class="hash-link" aria-label="Direct link to property-name--none--str-5" title="Direct link to property-name--none--str-5"></a></h4><p>Editable display name of the Dataset</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EditableERModelRelationshipPropertiesClass"><span class="visually-hidden">EditableERModelRelationshipPropertiesClass</span><a href="#datahub.metadata.schema_classes.EditableERModelRelationshipPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EditableERModelRelationshipPropertiesClass" title="Direct link to datahub.metadata.schema_classes.EditableERModelRelationshipPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EditableERModelRelationshipPropertiesClass</span>(<span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>, <span class="arg-name">deleted</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">name</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.EditableERModelRelationshipPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>EditableERModelRelationProperties stores editable changes made to erModelRelationship properties. This separates changes made from
|
||
ingestion pipelines and edits in the UI to avoid accidental overwrites of user-provided data by ingestion pipelines</p><ul><li><strong>Parameters:</strong><ul><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>deleted</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--auditstampclass-12"><em>property</em> created <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--auditstampclass-12" class="hash-link" aria-label="Direct link to property-created--auditstampclass-12" title="Direct link to property-created--auditstampclass-12"></a></h4><p>An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-deleted--none--auditstampclass-7"><em>property</em> deleted <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-deleted--none--auditstampclass-7" class="hash-link" aria-label="Direct link to property-deleted--none--auditstampclass-7" title="Direct link to property-deleted--none--auditstampclass-7"></a></h4><p>An AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-22"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-22" class="hash-link" aria-label="Direct link to property-description--none--str-22" title="Direct link to property-description--none--str-22"></a></h4><p>Documentation of the erModelRelationship</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--auditstampclass-12"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--auditstampclass-12" class="hash-link" aria-label="Direct link to property-lastmodified--auditstampclass-12" title="Direct link to property-lastmodified--auditstampclass-12"></a></h4><p>An AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--none--str-6"><em>property</em> name <em>: None | str</em><a href="#property-name--none--str-6" class="hash-link" aria-label="Direct link to property-name--none--str-6" title="Direct link to property-name--none--str-6"></a></h4><p>Display name of the ERModelRelation</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EditableMLFeaturePropertiesClass"><span class="visually-hidden">EditableMLFeaturePropertiesClass</span><a href="#datahub.metadata.schema_classes.EditableMLFeaturePropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EditableMLFeaturePropertiesClass" title="Direct link to datahub.metadata.schema_classes.EditableMLFeaturePropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EditableMLFeaturePropertiesClass</span>(<span class="arg-name">description</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.EditableMLFeaturePropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties associated with a MLFeature editable from the UI</p><ul><li><strong>Parameters:</strong><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-23"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-23" class="hash-link" aria-label="Direct link to property-description--none--str-23" title="Direct link to property-description--none--str-23"></a></h4><p>Documentation of the MLFeature</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EditableMLFeatureTablePropertiesClass"><span class="visually-hidden">EditableMLFeatureTablePropertiesClass</span><a href="#datahub.metadata.schema_classes.EditableMLFeatureTablePropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EditableMLFeatureTablePropertiesClass" title="Direct link to datahub.metadata.schema_classes.EditableMLFeatureTablePropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EditableMLFeatureTablePropertiesClass</span>(<span class="arg-name">description</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.EditableMLFeatureTablePropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties associated with a MLFeatureTable editable from the ui</p><ul><li><strong>Parameters:</strong><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-24"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-24" class="hash-link" aria-label="Direct link to property-description--none--str-24" title="Direct link to property-description--none--str-24"></a></h4><p>Documentation of the MLFeatureTable</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EditableMLModelGroupPropertiesClass"><span class="visually-hidden">EditableMLModelGroupPropertiesClass</span><a href="#datahub.metadata.schema_classes.EditableMLModelGroupPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EditableMLModelGroupPropertiesClass" title="Direct link to datahub.metadata.schema_classes.EditableMLModelGroupPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EditableMLModelGroupPropertiesClass</span>(<span class="arg-name">description</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.EditableMLModelGroupPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties associated with an ML Model Group editable from the UI</p><ul><li><strong>Parameters:</strong><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-25"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-25" class="hash-link" aria-label="Direct link to property-description--none--str-25" title="Direct link to property-description--none--str-25"></a></h4><p>Documentation of the ml model group</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EditableMLModelPropertiesClass"><span class="visually-hidden">EditableMLModelPropertiesClass</span><a href="#datahub.metadata.schema_classes.EditableMLModelPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EditableMLModelPropertiesClass" title="Direct link to datahub.metadata.schema_classes.EditableMLModelPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EditableMLModelPropertiesClass</span>(<span class="arg-name">description</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.EditableMLModelPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties associated with a ML Model editable from the UI</p><ul><li><strong>Parameters:</strong><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-26"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-26" class="hash-link" aria-label="Direct link to property-description--none--str-26" title="Direct link to property-description--none--str-26"></a></h4><p>Documentation of the ml model</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EditableMLPrimaryKeyPropertiesClass"><span class="visually-hidden">EditableMLPrimaryKeyPropertiesClass</span><a href="#datahub.metadata.schema_classes.EditableMLPrimaryKeyPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EditableMLPrimaryKeyPropertiesClass" title="Direct link to datahub.metadata.schema_classes.EditableMLPrimaryKeyPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EditableMLPrimaryKeyPropertiesClass</span>(<span class="arg-name">description</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.EditableMLPrimaryKeyPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties associated with a MLPrimaryKey editable from the UI</p><ul><li><strong>Parameters:</strong><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-27"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-27" class="hash-link" aria-label="Direct link to property-description--none--str-27" title="Direct link to property-description--none--str-27"></a></h4><p>Documentation of the MLPrimaryKey</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EditableNotebookPropertiesClass"><span class="visually-hidden">EditableNotebookPropertiesClass</span><a href="#datahub.metadata.schema_classes.EditableNotebookPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EditableNotebookPropertiesClass" title="Direct link to datahub.metadata.schema_classes.EditableNotebookPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EditableNotebookPropertiesClass</span>(<span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>, <span class="arg-name">deleted</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.EditableNotebookPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Stores editable changes made to properties. This separates changes made from
|
||
ingestion pipelines and edits in the UI to avoid accidental overwrites of user-provided data by ingestion pipelines
|
||
Note: This is IN BETA version</p><ul><li><strong>Parameters:</strong><ul><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>deleted</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--auditstampclass-13"><em>property</em> created <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--auditstampclass-13" class="hash-link" aria-label="Direct link to property-created--auditstampclass-13" title="Direct link to property-created--auditstampclass-13"></a></h4><p>An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-deleted--none--auditstampclass-8"><em>property</em> deleted <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-deleted--none--auditstampclass-8" class="hash-link" aria-label="Direct link to property-deleted--none--auditstampclass-8" title="Direct link to property-deleted--none--auditstampclass-8"></a></h4><p>An AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-28"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-28" class="hash-link" aria-label="Direct link to property-description--none--str-28" title="Direct link to property-description--none--str-28"></a></h4><p>Edited documentation of the Notebook</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--auditstampclass-13"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--auditstampclass-13" class="hash-link" aria-label="Direct link to property-lastmodified--auditstampclass-13" title="Direct link to property-lastmodified--auditstampclass-13"></a></h4><p>An AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EditableSchemaFieldInfoClass"><span class="visually-hidden">EditableSchemaFieldInfoClass</span><a href="#datahub.metadata.schema_classes.EditableSchemaFieldInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EditableSchemaFieldInfoClass" title="Direct link to datahub.metadata.schema_classes.EditableSchemaFieldInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EditableSchemaFieldInfoClass</span>(<span class="arg-name">fieldPath</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">globalTags</span> = <span class="arg-default">None</span>, <span class="arg-name">glossaryTerms</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.EditableSchemaFieldInfoClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>SchemaField to describe metadata related to dataset schema.</p><ul><li><strong>Parameters:</strong><ul><li><strong>fieldPath</strong> (<code>str</code>)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>globalTags</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.GlobalTagsClass"><code>GlobalTagsClass</code></a>]) – </li><li><strong>glossaryTerms</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.GlossaryTermsClass"><code>GlossaryTermsClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-29"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-29" class="hash-link" aria-label="Direct link to property-description--none--str-29" title="Direct link to property-description--none--str-29"></a></h4><p>Description</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fieldpath--str-3"><em>property</em> fieldPath <em>: str</em><a href="#property-fieldpath--str-3" class="hash-link" aria-label="Direct link to property-fieldpath--str-3" title="Direct link to property-fieldpath--str-3"></a></h4><p>FieldPath uniquely identifying the SchemaField this metadata is associated with</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-globaltags--none--globaltagsclass-1"><em>property</em> globalTags <em>: None | <a href="#datahub.metadata.schema_classes.GlobalTagsClass">GlobalTagsClass</a></em><a href="#property-globaltags--none--globaltagsclass-1" class="hash-link" aria-label="Direct link to property-globaltags--none--globaltagsclass-1" title="Direct link to property-globaltags--none--globaltagsclass-1"></a></h4><p>Tags associated with the field</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-glossaryterms--none--glossarytermsclass-1"><em>property</em> glossaryTerms <em>: None | <a href="#datahub.metadata.schema_classes.GlossaryTermsClass">GlossaryTermsClass</a></em><a href="#property-glossaryterms--none--glossarytermsclass-1" class="hash-link" aria-label="Direct link to property-glossaryterms--none--glossarytermsclass-1" title="Direct link to property-glossaryterms--none--glossarytermsclass-1"></a></h4><p>Glossary terms associated with the field</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EditableSchemaMetadataClass"><span class="visually-hidden">EditableSchemaMetadataClass</span><a href="#datahub.metadata.schema_classes.EditableSchemaMetadataClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EditableSchemaMetadataClass" title="Direct link to datahub.metadata.schema_classes.EditableSchemaMetadataClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EditableSchemaMetadataClass</span>(<span class="arg-name">editableSchemaFieldInfo</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>, <span class="arg-name">deleted</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.EditableSchemaMetadataClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>EditableSchemaMetadata stores editable changes made to schema metadata. This separates changes made from
|
||
ingestion pipelines and edits in the UI to avoid accidental overwrites of user-provided data by ingestion pipelines.</p><ul><li><strong>Parameters:</strong><ul><li><strong>editableSchemaFieldInfo</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.EditableSchemaFieldInfoClass"><code>EditableSchemaFieldInfoClass</code></a>]) – </li><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>deleted</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--auditstampclass-14"><em>property</em> created <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--auditstampclass-14" class="hash-link" aria-label="Direct link to property-created--auditstampclass-14" title="Direct link to property-created--auditstampclass-14"></a></h4><p>An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-deleted--none--auditstampclass-9"><em>property</em> deleted <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-deleted--none--auditstampclass-9" class="hash-link" aria-label="Direct link to property-deleted--none--auditstampclass-9" title="Direct link to property-deleted--none--auditstampclass-9"></a></h4><p>An AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-editableschemafieldinfo--listeditableschemafieldinfoclass"><em>property</em> editableSchemaFieldInfo <em>: List[<a href="#datahub.metadata.schema_classes.EditableSchemaFieldInfoClass">EditableSchemaFieldInfoClass</a>]</em><a href="#property-editableschemafieldinfo--listeditableschemafieldinfoclass" class="hash-link" aria-label="Direct link to property-editableschemafieldinfo--listeditableschemafieldinfoclass" title="Direct link to property-editableschemafieldinfo--listeditableschemafieldinfoclass"></a></h4><p>Client provided a list of fields from document schema.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--auditstampclass-14"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--auditstampclass-14" class="hash-link" aria-label="Direct link to property-lastmodified--auditstampclass-14" title="Direct link to property-lastmodified--auditstampclass-14"></a></h4><p>An AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EmailNotificationSettingsClass"><span class="visually-hidden">EmailNotificationSettingsClass</span><a href="#datahub.metadata.schema_classes.EmailNotificationSettingsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EmailNotificationSettingsClass" title="Direct link to datahub.metadata.schema_classes.EmailNotificationSettingsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EmailNotificationSettingsClass</span>(<span class="arg-name">email</span>)<a href="#datahub.metadata.schema_classes.EmailNotificationSettingsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Email Notification settings for an actor.</p><ul><li><strong>Parameters:</strong><strong>email</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-email--str"><em>property</em> email <em>: str</em><a href="#property-email--str" class="hash-link" aria-label="Direct link to property-email--str" title="Direct link to property-email--str"></a></h4><p>Optional user or group email address</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EmbedClass"><span class="visually-hidden">EmbedClass</span><a href="#datahub.metadata.schema_classes.EmbedClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EmbedClass" title="Direct link to datahub.metadata.schema_classes.EmbedClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EmbedClass</span>(<span class="arg-name">renderUrl</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.EmbedClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information regarding rendering an embed for an asset.</p><ul><li><strong>Parameters:</strong><strong>renderUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-renderurl--none--str"><em>property</em> renderUrl <em>: None | str</em><a href="#property-renderurl--none--str" class="hash-link" aria-label="Direct link to property-renderurl--none--str" title="Direct link to property-renderurl--none--str"></a></h4><p>An embed URL to be rendered inside of an iframe.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EntityChangeEventClass"><span class="visually-hidden">EntityChangeEventClass</span><a href="#datahub.metadata.schema_classes.EntityChangeEventClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EntityChangeEventClass" title="Direct link to datahub.metadata.schema_classes.EntityChangeEventClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EntityChangeEventClass</span>(<span class="arg-name">entityType</span>, <span class="arg-name">entityUrn</span>, <span class="arg-name">category</span>, <span class="arg-name">operation</span>, <span class="arg-name">auditStamp</span>, <span class="arg-name">version</span>, <span class="arg-name">modifier</span> = <span class="arg-default">None</span>, <span class="arg-name">parameters</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.EntityChangeEventClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Shared fields for all entity change events.</p><ul><li><strong>Parameters:</strong><ul><li><strong>entityType</strong> (<code>str</code>)</li><li><strong>entityUrn</strong> (<code>str</code>)</li><li><strong>category</strong> (<code>str</code>)</li><li><strong>operation</strong> (<code>str</code>)</li><li><strong>auditStamp</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li><li><strong>version</strong> (<code>int</code>)</li><li><strong>modifier</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>parameters</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.ParametersClass"><code>ParametersClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-auditstamp--auditstampclass"><em>property</em> auditStamp <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-auditstamp--auditstampclass" class="hash-link" aria-label="Direct link to property-auditstamp--auditstampclass" title="Direct link to property-auditstamp--auditstampclass"></a></h4><p>Audit stamp of the operation</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-category--str"><em>property</em> category <em>: str</em><a href="#property-category--str" class="hash-link" aria-label="Direct link to property-category--str" title="Direct link to property-category--str"></a></h4><p>The category type (TAG, GLOSSARY_TERM, OWNERSHIP, TECHNICAL_SCHEMA, etc). This is used to determine what the rest of the schema will look like.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-entitytype--str"><em>property</em> entityType <em>: str</em><a href="#property-entitytype--str" class="hash-link" aria-label="Direct link to property-entitytype--str" title="Direct link to property-entitytype--str"></a></h4><p>The type of the entity affected. Corresponds to the entity registry, e.g. ‘dataset’, ‘chart’, ‘dashboard’, etc.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-entityurn--str"><em>property</em> entityUrn <em>: str</em><a href="#property-entityurn--str" class="hash-link" aria-label="Direct link to property-entityurn--str" title="Direct link to property-entityurn--str"></a></h4><p>The urn of the entity which was affected.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-modifier--none--str"><em>property</em> modifier <em>: None | str</em><a href="#property-modifier--none--str" class="hash-link" aria-label="Direct link to property-modifier--none--str" title="Direct link to property-modifier--none--str"></a></h4><p>The urn of the entity which was affected.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-operation--str"><em>property</em> operation <em>: str</em><a href="#property-operation--str" class="hash-link" aria-label="Direct link to property-operation--str" title="Direct link to property-operation--str"></a></h4><p>The operation type. This is used to determine what the rest of the schema will look like.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-parameters--none--parametersclass"><em>property</em> parameters <em>: None | <a href="#datahub.metadata.schema_classes.ParametersClass">ParametersClass</a></em><a href="#property-parameters--none--parametersclass" class="hash-link" aria-label="Direct link to property-parameters--none--parametersclass" title="Direct link to property-parameters--none--parametersclass"></a></h4><p>Arbitrary key-value parameters corresponding to the event.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-version--int"><em>property</em> version <em>: int</em><a href="#property-version--int" class="hash-link" aria-label="Direct link to property-version--int" title="Direct link to property-version--int"></a></h4><p>The version of the event type, incremented in integers.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EntityTypeInfoClass"><span class="visually-hidden">EntityTypeInfoClass</span><a href="#datahub.metadata.schema_classes.EntityTypeInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EntityTypeInfoClass" title="Direct link to datahub.metadata.schema_classes.EntityTypeInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EntityTypeInfoClass</span>(<span class="arg-name">qualifiedName</span>, <span class="arg-name">displayName</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.EntityTypeInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>qualifiedName</strong> (<code>str</code>)</li><li><strong>displayName</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-30"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-30" class="hash-link" aria-label="Direct link to property-description--none--str-30" title="Direct link to property-description--none--str-30"></a></h4><p>what is it for?</p><ul><li><strong>Type:</strong>
|
||
A description for the Entity Type</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-displayname--none--str-5"><em>property</em> displayName <em>: None | str</em><a href="#property-displayname--none--str-5" class="hash-link" aria-label="Direct link to property-displayname--none--str-5" title="Direct link to property-displayname--none--str-5"></a></h4><p>The display name for the Entity Type.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-qualifiedname--str-1"><em>property</em> qualifiedName <em>: str</em><a href="#property-qualifiedname--str-1" class="hash-link" aria-label="Direct link to property-qualifiedname--str-1" title="Direct link to property-qualifiedname--str-1"></a></h4><p>The fully qualified name for the entity type, which usually consists of a namespace
|
||
plus an identifier or name, e.g. datahub.dataset</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EntityTypeKeyClass"><span class="visually-hidden">EntityTypeKeyClass</span><a href="#datahub.metadata.schema_classes.EntityTypeKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EntityTypeKeyClass" title="Direct link to datahub.metadata.schema_classes.EntityTypeKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EntityTypeKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.EntityTypeKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-23"><em>property</em> id <em>: str</em><a href="#property-id--str-23" class="hash-link" aria-label="Direct link to property-id--str-23" title="Direct link to property-id--str-23"></a></h4><p>A unique id for an entity type. Usually this will be a unique namespace + entity name.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EnumTypeClass"><span class="visually-hidden">EnumTypeClass</span><a href="#datahub.metadata.schema_classes.EnumTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EnumTypeClass" title="Direct link to datahub.metadata.schema_classes.EnumTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EnumTypeClass</span>()<a href="#datahub.metadata.schema_classes.EnumTypeClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Enum field type.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EspressoSchemaClass"><span class="visually-hidden">EspressoSchemaClass</span><a href="#datahub.metadata.schema_classes.EspressoSchemaClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EspressoSchemaClass" title="Direct link to datahub.metadata.schema_classes.EspressoSchemaClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EspressoSchemaClass</span>(<span class="arg-name">documentSchema</span>, <span class="arg-name">tableSchema</span>)<a href="#datahub.metadata.schema_classes.EspressoSchemaClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Schema text of an espresso table schema.</p><ul><li><strong>Parameters:</strong><ul><li><strong>documentSchema</strong> (<code>str</code>)</li><li><strong>tableSchema</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-documentschema--str"><em>property</em> documentSchema <em>: str</em><a href="#property-documentschema--str" class="hash-link" aria-label="Direct link to property-documentschema--str" title="Direct link to property-documentschema--str"></a></h4><p>The native espresso document schema.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-tableschema--str"><em>property</em> tableSchema <em>: str</em><a href="#property-tableschema--str" class="hash-link" aria-label="Direct link to property-tableschema--str" title="Direct link to property-tableschema--str"></a></h4><p>The espresso table schema definition.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EthicalConsiderationsClass"><span class="visually-hidden">EthicalConsiderationsClass</span><a href="#datahub.metadata.schema_classes.EthicalConsiderationsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EthicalConsiderationsClass" title="Direct link to datahub.metadata.schema_classes.EthicalConsiderationsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EthicalConsiderationsClass</span>(<span class="arg-name">data</span> = <span class="arg-default">None</span>, <span class="arg-name">humanLife</span> = <span class="arg-default">None</span>, <span class="arg-name">mitigations</span> = <span class="arg-default">None</span>, <span class="arg-name">risksAndHarms</span> = <span class="arg-default">None</span>, <span class="arg-name">useCases</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.EthicalConsiderationsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>This section is intended to demonstrate the ethical considerations that went into MLModel development, surfacing ethical challenges and solutions to stakeholders.</p><ul><li><strong>Parameters:</strong><ul><li><strong>data</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>humanLife</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>mitigations</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>risksAndHarms</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>useCases</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-data--none--liststr"><em>property</em> data <em>: None | List<!-- -->[str]</em><a href="#property-data--none--liststr" class="hash-link" aria-label="Direct link to property-data--none--liststr" title="Direct link to property-data--none--liststr"></a></h4><p>Does the MLModel use any sensitive data (e.g., protected classes)?</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-humanlife--none--liststr"><em>property</em> humanLife <em>: None | List<!-- -->[str]</em><a href="#property-humanlife--none--liststr" class="hash-link" aria-label="Direct link to property-humanlife--none--liststr" title="Direct link to property-humanlife--none--liststr"></a></h4><p>Is the MLModel intended to inform decisions about matters central to human life or flourishing - e.g., health or safety? Or could it be used in such a way?</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-mitigations--none--liststr"><em>property</em> mitigations <em>: None | List<!-- -->[str]</em><a href="#property-mitigations--none--liststr" class="hash-link" aria-label="Direct link to property-mitigations--none--liststr" title="Direct link to property-mitigations--none--liststr"></a></h4><p>What risk mitigation strategies were used during MLModel development?</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-risksandharms--none--liststr"><em>property</em> risksAndHarms <em>: None | List<!-- -->[str]</em><a href="#property-risksandharms--none--liststr" class="hash-link" aria-label="Direct link to property-risksandharms--none--liststr" title="Direct link to property-risksandharms--none--liststr"></a></h4><p>What risks may be present in MLModel usage? Try to identify the potential recipients, likelihood, and magnitude of harms. If these cannot be determined, note that they were considered but remain unknown.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-usecases--none--liststr"><em>property</em> useCases <em>: None | List<!-- -->[str]</em><a href="#property-usecases--none--liststr" class="hash-link" aria-label="Direct link to property-usecases--none--liststr" title="Direct link to property-usecases--none--liststr"></a></h4><p>Are there any known MLModel use cases that are especially fraught? This may connect directly to the intended use section</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.EvaluationDataClass"><span class="visually-hidden">EvaluationDataClass</span><a href="#datahub.metadata.schema_classes.EvaluationDataClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.EvaluationDataClass" title="Direct link to datahub.metadata.schema_classes.EvaluationDataClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">EvaluationDataClass</span>(<span class="arg-name">evaluationData</span>)<a href="#datahub.metadata.schema_classes.EvaluationDataClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>All referenced datasets would ideally point to any set of documents that provide visibility into the source and composition of the dataset.</p><ul><li><strong>Parameters:</strong><strong>evaluationData</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.BaseDataClass"><code>BaseDataClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-evaluationdata--listbasedataclass"><em>property</em> evaluationData <em>: List[<a href="#datahub.metadata.schema_classes.BaseDataClass">BaseDataClass</a>]</em><a href="#property-evaluationdata--listbasedataclass" class="hash-link" aria-label="Direct link to property-evaluationdata--listbasedataclass" title="Direct link to property-evaluationdata--listbasedataclass"></a></h4><p>Details on the dataset(s) used for the quantitative analyses in the MLModel</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ExecutionRequestInputClass"><span class="visually-hidden">ExecutionRequestInputClass</span><a href="#datahub.metadata.schema_classes.ExecutionRequestInputClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ExecutionRequestInputClass" title="Direct link to datahub.metadata.schema_classes.ExecutionRequestInputClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ExecutionRequestInputClass</span>(<span class="arg-name">task</span>, <span class="arg-name">args</span>, <span class="arg-name">executorId</span>, <span class="arg-name">source</span>, <span class="arg-name">requestedAt</span>, <span class="arg-name">actorUrn</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.ExecutionRequestInputClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>An request to execution some remote logic or action.
|
||
TODO: Determine who is responsible for emitting execution request success or failure. Executor?</p><ul><li><strong>Parameters:</strong><ul><li><strong>task</strong> (<code>str</code>)</li><li><strong>args</strong> (<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->)</li><li><strong>executorId</strong> (<code>str</code>)</li><li><strong>source</strong> (<a href="#datahub.metadata.schema_classes.ExecutionRequestSourceClass"><code>ExecutionRequestSourceClass</code></a>) – </li><li><strong>requestedAt</strong> (<code>int</code>)</li><li><strong>actorUrn</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-actorurn--none--str"><em>property</em> actorUrn <em>: None | str</em><a href="#property-actorurn--none--str" class="hash-link" aria-label="Direct link to property-actorurn--none--str" title="Direct link to property-actorurn--none--str"></a></h4><p>Urn of the actor who created this execution request.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-args--dictstr-str"><em>property</em> args <em>: Dict<!-- -->[str, str]</em><a href="#property-args--dictstr-str" class="hash-link" aria-label="Direct link to property-args--dictstr-str" title="Direct link to property-args--dictstr-str"></a></h4><p>Arguments provided to the task</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-executorid--str"><em>property</em> executorId <em>: str</em><a href="#property-executorid--str" class="hash-link" aria-label="Direct link to property-executorid--str" title="Direct link to property-executorid--str"></a></h4><p>specify a specific executor to route the request to. If none is provided, a “default” executor is used.</p><ul><li><strong>Type:</strong>
|
||
Advanced</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-requestedat--int"><em>property</em> requestedAt <em>: int</em><a href="#property-requestedat--int" class="hash-link" aria-label="Direct link to property-requestedat--int" title="Direct link to property-requestedat--int"></a></h4><p>Time at which the execution request input was created</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-source--executionrequestsourceclass"><em>property</em> source <em>: <a href="#datahub.metadata.schema_classes.ExecutionRequestSourceClass">ExecutionRequestSourceClass</a></em><a href="#property-source--executionrequestsourceclass" class="hash-link" aria-label="Direct link to property-source--executionrequestsourceclass" title="Direct link to property-source--executionrequestsourceclass"></a></h4><p>Source which created the execution request</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-task--str"><em>property</em> task <em>: str</em><a href="#property-task--str" class="hash-link" aria-label="Direct link to property-task--str" title="Direct link to property-task--str"></a></h4><p>The name of the task to execute, for example RUN_INGEST</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ExecutionRequestKeyClass"><span class="visually-hidden">ExecutionRequestKeyClass</span><a href="#datahub.metadata.schema_classes.ExecutionRequestKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ExecutionRequestKeyClass" title="Direct link to datahub.metadata.schema_classes.ExecutionRequestKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ExecutionRequestKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.ExecutionRequestKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for an DataHub Execution Request</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-24"><em>property</em> id <em>: str</em><a href="#property-id--str-24" class="hash-link" aria-label="Direct link to property-id--str-24" title="Direct link to property-id--str-24"></a></h4><p>A unique id for the DataHub execution request.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ExecutionRequestResultClass"><span class="visually-hidden">ExecutionRequestResultClass</span><a href="#datahub.metadata.schema_classes.ExecutionRequestResultClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ExecutionRequestResultClass" title="Direct link to datahub.metadata.schema_classes.ExecutionRequestResultClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ExecutionRequestResultClass</span>(<span class="arg-name">status</span>, <span class="arg-name">report</span> = <span class="arg-default">None</span>, <span class="arg-name">structuredReport</span> = <span class="arg-default">None</span>, <span class="arg-name">startTimeMs</span> = <span class="arg-default">None</span>, <span class="arg-name">durationMs</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.ExecutionRequestResultClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>The result of an execution request</p><ul><li><strong>Parameters:</strong><ul><li><strong>status</strong> (<code>str</code>)</li><li><strong>report</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>structuredReport</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.StructuredExecutionReportClass"><code>StructuredExecutionReportClass</code></a>]) – </li><li><strong>startTimeMs</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>durationMs</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-durationms--none--int"><em>property</em> durationMs <em>: None | int</em><a href="#property-durationms--none--int" class="hash-link" aria-label="Direct link to property-durationms--none--int" title="Direct link to property-durationms--none--int"></a></h4><p>Duration in milliseconds</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-report--none--str"><em>property</em> report <em>: None | str</em><a href="#property-report--none--str" class="hash-link" aria-label="Direct link to property-report--none--str" title="Direct link to property-report--none--str"></a></h4><p>The pretty-printed execution report.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-starttimems--none--int"><em>property</em> startTimeMs <em>: None | int</em><a href="#property-starttimems--none--int" class="hash-link" aria-label="Direct link to property-starttimems--none--int" title="Direct link to property-starttimems--none--int"></a></h4><p>Time at which the request was created</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-status--str-1"><em>property</em> status <em>: str</em><a href="#property-status--str-1" class="hash-link" aria-label="Direct link to property-status--str-1" title="Direct link to property-status--str-1"></a></h4><p>The status of the execution request</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-structuredreport--none--structuredexecutionreportclass"><em>property</em> structuredReport <em>: None | <a href="#datahub.metadata.schema_classes.StructuredExecutionReportClass">StructuredExecutionReportClass</a></em><a href="#property-structuredreport--none--structuredexecutionreportclass" class="hash-link" aria-label="Direct link to property-structuredreport--none--structuredexecutionreportclass" title="Direct link to property-structuredreport--none--structuredexecutionreportclass"></a></h4><p>A structured report if available.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ExecutionRequestSignalClass"><span class="visually-hidden">ExecutionRequestSignalClass</span><a href="#datahub.metadata.schema_classes.ExecutionRequestSignalClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ExecutionRequestSignalClass" title="Direct link to datahub.metadata.schema_classes.ExecutionRequestSignalClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ExecutionRequestSignalClass</span>(<span class="arg-name">signal</span>, <span class="arg-name">createdAt</span>, <span class="arg-name">executorId</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.ExecutionRequestSignalClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>An signal sent to a running execution request</p><ul><li><strong>Parameters:</strong><ul><li><strong>signal</strong> (<code>str</code>)</li><li><strong>createdAt</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li><li><strong>executorId</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-createdat--auditstampclass"><em>property</em> createdAt <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-createdat--auditstampclass" class="hash-link" aria-label="Direct link to property-createdat--auditstampclass" title="Direct link to property-createdat--auditstampclass"></a></h4><p>Audit Stamp</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-executorid--none--str-1"><em>property</em> executorId <em>: None | str</em><a href="#property-executorid--none--str-1" class="hash-link" aria-label="Direct link to property-executorid--none--str-1" title="Direct link to property-executorid--none--str-1"></a></h4><p>specify a specific executor to route the request to. If none is provided, a “default” executor is used.</p><ul><li><strong>Type:</strong>
|
||
Advanced</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-signal--str"><em>property</em> signal <em>: str</em><a href="#property-signal--str" class="hash-link" aria-label="Direct link to property-signal--str" title="Direct link to property-signal--str"></a></h4><p>The signal to issue, e.g. KILL</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ExecutionRequestSourceClass"><span class="visually-hidden">ExecutionRequestSourceClass</span><a href="#datahub.metadata.schema_classes.ExecutionRequestSourceClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ExecutionRequestSourceClass" title="Direct link to datahub.metadata.schema_classes.ExecutionRequestSourceClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ExecutionRequestSourceClass</span>(<span class="arg-name">type</span>, <span class="arg-name">ingestionSource</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.ExecutionRequestSourceClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>str</code>)</li><li><strong>ingestionSource</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-ingestionsource--none--str"><em>property</em> ingestionSource <em>: None | str</em><a href="#property-ingestionsource--none--str" class="hash-link" aria-label="Direct link to property-ingestionsource--none--str" title="Direct link to property-ingestionsource--none--str"></a></h4><p>The urn of the ingestion source associated with the ingestion request. Present if type is INGESTION_SOURCE</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str-3"><em>property</em> type <em>: str</em><a href="#property-type--str-3" class="hash-link" aria-label="Direct link to property-type--str-3" title="Direct link to property-type--str-3"></a></h4><p>The type of the execution request source, e.g. INGESTION_SOURCE</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FabricTypeClass"><span class="visually-hidden">FabricTypeClass</span><a href="#datahub.metadata.schema_classes.FabricTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FabricTypeClass" title="Direct link to datahub.metadata.schema_classes.FabricTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FabricTypeClass</span>()<a href="#datahub.metadata.schema_classes.FabricTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>Fabric group type</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="corp--corp">CORP <em>= 'CORP'</em><a href="#corp--corp" class="hash-link" aria-label="Direct link to corp--corp" title="Direct link to corp--corp"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dev--dev">DEV <em>= 'DEV'</em><a href="#dev--dev" class="hash-link" aria-label="Direct link to dev--dev" title="Direct link to dev--dev"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="ei--ei">EI <em>= 'EI'</em><a href="#ei--ei" class="hash-link" aria-label="Direct link to ei--ei" title="Direct link to ei--ei"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="non_prod--non_prod">NON_PROD <em>= 'NON_PROD'</em><a href="#non_prod--non_prod" class="hash-link" aria-label="Direct link to non_prod--non_prod" title="Direct link to non_prod--non_prod"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="prd--prd">PRD <em>= 'PRD'</em><a href="#prd--prd" class="hash-link" aria-label="Direct link to prd--prd" title="Direct link to prd--prd"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="pre--pre">PRE <em>= 'PRE'</em><a href="#pre--pre" class="hash-link" aria-label="Direct link to pre--pre" title="Direct link to pre--pre"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="prod--prod">PROD <em>= 'PROD'</em><a href="#prod--prod" class="hash-link" aria-label="Direct link to prod--prod" title="Direct link to prod--prod"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="qa--qa">QA <em>= 'QA'</em><a href="#qa--qa" class="hash-link" aria-label="Direct link to qa--qa" title="Direct link to qa--qa"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="rvw--rvw">RVW <em>= 'RVW'</em><a href="#rvw--rvw" class="hash-link" aria-label="Direct link to rvw--rvw" title="Direct link to rvw--rvw"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sandbox--sandbox">SANDBOX <em>= 'SANDBOX'</em><a href="#sandbox--sandbox" class="hash-link" aria-label="Direct link to sandbox--sandbox" title="Direct link to sandbox--sandbox"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sbx--sbx">SBX <em>= 'SBX'</em><a href="#sbx--sbx" class="hash-link" aria-label="Direct link to sbx--sbx" title="Direct link to sbx--sbx"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sit--sit">SIT <em>= 'SIT'</em><a href="#sit--sit" class="hash-link" aria-label="Direct link to sit--sit" title="Direct link to sit--sit"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="stg--stg">STG <em>= 'STG'</em><a href="#stg--stg" class="hash-link" aria-label="Direct link to stg--stg" title="Direct link to stg--stg"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="test--test">TEST <em>= 'TEST'</em><a href="#test--test" class="hash-link" aria-label="Direct link to test--test" title="Direct link to test--test"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="tst--tst">TST <em>= 'TST'</em><a href="#tst--tst" class="hash-link" aria-label="Direct link to tst--tst" title="Direct link to tst--tst"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="uat--uat">UAT <em>= 'UAT'</em><a href="#uat--uat" class="hash-link" aria-label="Direct link to uat--uat" title="Direct link to uat--uat"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FieldAssertionInfoClass"><span class="visually-hidden">FieldAssertionInfoClass</span><a href="#datahub.metadata.schema_classes.FieldAssertionInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FieldAssertionInfoClass" title="Direct link to datahub.metadata.schema_classes.FieldAssertionInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FieldAssertionInfoClass</span>(<span class="arg-name">type</span>, <span class="arg-name">entity</span>, <span class="arg-name">fieldValuesAssertion</span> = <span class="arg-default">None</span>, <span class="arg-name">fieldMetricAssertion</span> = <span class="arg-default">None</span>, <span class="arg-name">filter</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.FieldAssertionInfoClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Attributes defining a Field Assertion.</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.FieldAssertionTypeClass"><code>FieldAssertionTypeClass</code></a>]) – </li><li><strong>entity</strong> (<code>str</code>)</li><li><strong>fieldValuesAssertion</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.FieldValuesAssertionClass"><code>FieldValuesAssertionClass</code></a>]) – </li><li><strong>fieldMetricAssertion</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.FieldMetricAssertionClass"><code>FieldMetricAssertionClass</code></a>]) – </li><li><strong>filter</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.DatasetFilterClass"><code>DatasetFilterClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-entity--str-2"><em>property</em> entity <em>: str</em><a href="#property-entity--str-2" class="hash-link" aria-label="Direct link to property-entity--str-2" title="Direct link to property-entity--str-2"></a></h4><p>The entity targeted by this Field check.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fieldmetricassertion--none--fieldmetricassertionclass"><em>property</em> fieldMetricAssertion <em>: None | <a href="#datahub.metadata.schema_classes.FieldMetricAssertionClass">FieldMetricAssertionClass</a></em><a href="#property-fieldmetricassertion--none--fieldmetricassertionclass" class="hash-link" aria-label="Direct link to property-fieldmetricassertion--none--fieldmetricassertionclass" title="Direct link to property-fieldmetricassertion--none--fieldmetricassertionclass"></a></h4><p>The definition of an assertion that validates a common metric obtained about a field / column for a set of rows.
|
||
This type of assertion verifies that the value of a high-level metric obtained by aggregating over a column meets
|
||
expectations</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fieldvaluesassertion--none--fieldvaluesassertionclass"><em>property</em> fieldValuesAssertion <em>: None | <a href="#datahub.metadata.schema_classes.FieldValuesAssertionClass">FieldValuesAssertionClass</a></em><a href="#property-fieldvaluesassertion--none--fieldvaluesassertionclass" class="hash-link" aria-label="Direct link to property-fieldvaluesassertion--none--fieldvaluesassertionclass" title="Direct link to property-fieldvaluesassertion--none--fieldvaluesassertionclass"></a></h4><p>The definition of an assertion that validates individual values of a field / column for a set of rows.
|
||
This type of assertion verifies that each column value meets a particular requirement.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-filter--none--datasetfilterclass"><em>property</em> filter <em>: None | <a href="#datahub.metadata.schema_classes.DatasetFilterClass">DatasetFilterClass</a></em><a href="#property-filter--none--datasetfilterclass" class="hash-link" aria-label="Direct link to property-filter--none--datasetfilterclass" title="Direct link to property-filter--none--datasetfilterclass"></a></h4><p>A definition of the specific filters that should be applied, when performing monitoring.
|
||
If not provided, there is no filter, and the full table is under consideration.
|
||
If using DataHub Dataset Profiles as the assertion source type, the value of this field will be ignored.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--fieldassertiontypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.FieldAssertionTypeClass">FieldAssertionTypeClass</a></em><a href="#property-type--str--fieldassertiontypeclass" class="hash-link" aria-label="Direct link to property-type--str--fieldassertiontypeclass" title="Direct link to property-type--str--fieldassertiontypeclass"></a></h4><p>The type of the field assertion being monitored.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FieldAssertionTypeClass"><span class="visually-hidden">FieldAssertionTypeClass</span><a href="#datahub.metadata.schema_classes.FieldAssertionTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FieldAssertionTypeClass" title="Direct link to datahub.metadata.schema_classes.FieldAssertionTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FieldAssertionTypeClass</span>()<a href="#datahub.metadata.schema_classes.FieldAssertionTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="field_metric--field_metric">FIELD_METRIC <em>= 'FIELD_METRIC'</em><a href="#field_metric--field_metric" class="hash-link" aria-label="Direct link to field_metric--field_metric" title="Direct link to field_metric--field_metric"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="field_values--field_values">FIELD_VALUES <em>= 'FIELD_VALUES'</em><a href="#field_values--field_values" class="hash-link" aria-label="Direct link to field_values--field_values" title="Direct link to field_values--field_values"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FieldFormPromptAssociationClass"><span class="visually-hidden">FieldFormPromptAssociationClass</span><a href="#datahub.metadata.schema_classes.FieldFormPromptAssociationClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FieldFormPromptAssociationClass" title="Direct link to datahub.metadata.schema_classes.FieldFormPromptAssociationClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FieldFormPromptAssociationClass</span>(<span class="arg-name">fieldPath</span>, <span class="arg-name">lastModified</span>)<a href="#datahub.metadata.schema_classes.FieldFormPromptAssociationClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Information about the status of a particular prompt for a specific schema field
|
||
on an entity.</p><ul><li><strong>Parameters:</strong><ul><li><strong>fieldPath</strong> (<code>str</code>)</li><li><strong>lastModified</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fieldpath--str-4"><em>property</em> fieldPath <em>: str</em><a href="#property-fieldpath--str-4" class="hash-link" aria-label="Direct link to property-fieldpath--str-4" title="Direct link to property-fieldpath--str-4"></a></h4><p>The field path on a schema field.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--auditstampclass-15"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--auditstampclass-15" class="hash-link" aria-label="Direct link to property-lastmodified--auditstampclass-15" title="Direct link to property-lastmodified--auditstampclass-15"></a></h4><p>The last time this prompt was touched for the field on the entity (set, unset)</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FieldMetricAssertionClass"><span class="visually-hidden">FieldMetricAssertionClass</span><a href="#datahub.metadata.schema_classes.FieldMetricAssertionClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FieldMetricAssertionClass" title="Direct link to datahub.metadata.schema_classes.FieldMetricAssertionClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FieldMetricAssertionClass</span>(<span class="arg-name">field</span>, <span class="arg-name">metric</span>, <span class="arg-name">operator</span>, <span class="arg-name">parameters</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.FieldMetricAssertionClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Attributes defining a field metric assertion, which asserts an expectation against
|
||
a common metric derived from the set of field / column values, for example:
|
||
max, min, median, null count, null percentage, unique count, unique percentage, and more.</p><ul><li><strong>Parameters:</strong><ul><li><strong>field</strong> (<a href="#datahub.metadata.schema_classes.SchemaFieldSpecClass"><code>SchemaFieldSpecClass</code></a>) – </li><li><strong>metric</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.FieldMetricTypeClass"><code>FieldMetricTypeClass</code></a>]) – </li><li><strong>operator</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.AssertionStdOperatorClass"><code>AssertionStdOperatorClass</code></a>]) – </li><li><strong>parameters</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AssertionStdParametersClass"><code>AssertionStdParametersClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-field--schemafieldspecclass"><em>property</em> field <em>: <a href="#datahub.metadata.schema_classes.SchemaFieldSpecClass">SchemaFieldSpecClass</a></em><a href="#property-field--schemafieldspecclass" class="hash-link" aria-label="Direct link to property-field--schemafieldspecclass" title="Direct link to property-field--schemafieldspecclass"></a></h4><p>The field under evaluation</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-metric--str--fieldmetrictypeclass"><em>property</em> metric <em>: str | <a href="#datahub.metadata.schema_classes.FieldMetricTypeClass">FieldMetricTypeClass</a></em><a href="#property-metric--str--fieldmetrictypeclass" class="hash-link" aria-label="Direct link to property-metric--str--fieldmetrictypeclass" title="Direct link to property-metric--str--fieldmetrictypeclass"></a></h4><p>The specific metric to assert against. This is the value that
|
||
will be obtained by applying a standard operation, such as an aggregation,
|
||
to the selected field.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-operator--str--assertionstdoperatorclass-1"><em>property</em> operator <em>: str | <a href="#datahub.metadata.schema_classes.AssertionStdOperatorClass">AssertionStdOperatorClass</a></em><a href="#property-operator--str--assertionstdoperatorclass-1" class="hash-link" aria-label="Direct link to property-operator--str--assertionstdoperatorclass-1" title="Direct link to property-operator--str--assertionstdoperatorclass-1"></a></h4><p>The predicate to evaluate against the metric for the field / column.
|
||
Depending on the operator, parameters may be required in order to successfully
|
||
evaluate the assertion against the metric value.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-parameters--none--assertionstdparametersclass-1"><em>property</em> parameters <em>: None | <a href="#datahub.metadata.schema_classes.AssertionStdParametersClass">AssertionStdParametersClass</a></em><a href="#property-parameters--none--assertionstdparametersclass-1" class="hash-link" aria-label="Direct link to property-parameters--none--assertionstdparametersclass-1" title="Direct link to property-parameters--none--assertionstdparametersclass-1"></a></h4><p>Standard parameters required for the assertion. e.g. min_value, max_value, value, columns</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FieldMetricTypeClass"><span class="visually-hidden">FieldMetricTypeClass</span><a href="#datahub.metadata.schema_classes.FieldMetricTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FieldMetricTypeClass" title="Direct link to datahub.metadata.schema_classes.FieldMetricTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FieldMetricTypeClass</span>()<a href="#datahub.metadata.schema_classes.FieldMetricTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>A standard metric that can be derived from the set of values
|
||
for a specific field / column of a dataset / table.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="empty_count--empty_count">EMPTY_COUNT <em>= 'EMPTY_COUNT'</em><a href="#empty_count--empty_count" class="hash-link" aria-label="Direct link to empty_count--empty_count" title="Direct link to empty_count--empty_count"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="empty_percentage--empty_percentage">EMPTY_PERCENTAGE <em>= 'EMPTY_PERCENTAGE'</em><a href="#empty_percentage--empty_percentage" class="hash-link" aria-label="Direct link to empty_percentage--empty_percentage" title="Direct link to empty_percentage--empty_percentage"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="max--max-1">MAX <em>= 'MAX'</em><a href="#max--max-1" class="hash-link" aria-label="Direct link to max--max-1" title="Direct link to max--max-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="max_length--max_length">MAX_LENGTH <em>= 'MAX_LENGTH'</em><a href="#max_length--max_length" class="hash-link" aria-label="Direct link to max_length--max_length" title="Direct link to max_length--max_length"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="mean--mean-1">MEAN <em>= 'MEAN'</em><a href="#mean--mean-1" class="hash-link" aria-label="Direct link to mean--mean-1" title="Direct link to mean--mean-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="median--median-1">MEDIAN <em>= 'MEDIAN'</em><a href="#median--median-1" class="hash-link" aria-label="Direct link to median--median-1" title="Direct link to median--median-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="min--min-1">MIN <em>= 'MIN'</em><a href="#min--min-1" class="hash-link" aria-label="Direct link to min--min-1" title="Direct link to min--min-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="min_length--min_length">MIN_LENGTH <em>= 'MIN_LENGTH'</em><a href="#min_length--min_length" class="hash-link" aria-label="Direct link to min_length--min_length" title="Direct link to min_length--min_length"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="negative_count--negative_count">NEGATIVE_COUNT <em>= 'NEGATIVE_COUNT'</em><a href="#negative_count--negative_count" class="hash-link" aria-label="Direct link to negative_count--negative_count" title="Direct link to negative_count--negative_count"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="negative_percentage--negative_percentage">NEGATIVE_PERCENTAGE <em>= 'NEGATIVE_PERCENTAGE'</em><a href="#negative_percentage--negative_percentage" class="hash-link" aria-label="Direct link to negative_percentage--negative_percentage" title="Direct link to negative_percentage--negative_percentage"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="null_count--null_count-1">NULL_COUNT <em>= 'NULL_COUNT'</em><a href="#null_count--null_count-1" class="hash-link" aria-label="Direct link to null_count--null_count-1" title="Direct link to null_count--null_count-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="null_percentage--null_percentage">NULL_PERCENTAGE <em>= 'NULL_PERCENTAGE'</em><a href="#null_percentage--null_percentage" class="hash-link" aria-label="Direct link to null_percentage--null_percentage" title="Direct link to null_percentage--null_percentage"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="stddev--stddev-1">STDDEV <em>= 'STDDEV'</em><a href="#stddev--stddev-1" class="hash-link" aria-label="Direct link to stddev--stddev-1" title="Direct link to stddev--stddev-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="unique_count--unique_count-1">UNIQUE_COUNT <em>= 'UNIQUE_COUNT'</em><a href="#unique_count--unique_count-1" class="hash-link" aria-label="Direct link to unique_count--unique_count-1" title="Direct link to unique_count--unique_count-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="unique_percentage--unique_percentage">UNIQUE_PERCENTAGE <em>= 'UNIQUE_PERCENTAGE'</em><a href="#unique_percentage--unique_percentage" class="hash-link" aria-label="Direct link to unique_percentage--unique_percentage" title="Direct link to unique_percentage--unique_percentage"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="zero_count--zero_count">ZERO_COUNT <em>= 'ZERO_COUNT'</em><a href="#zero_count--zero_count" class="hash-link" aria-label="Direct link to zero_count--zero_count" title="Direct link to zero_count--zero_count"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="zero_percentage--zero_percentage">ZERO_PERCENTAGE <em>= 'ZERO_PERCENTAGE'</em><a href="#zero_percentage--zero_percentage" class="hash-link" aria-label="Direct link to zero_percentage--zero_percentage" title="Direct link to zero_percentage--zero_percentage"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FieldTransformClass"><span class="visually-hidden">FieldTransformClass</span><a href="#datahub.metadata.schema_classes.FieldTransformClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FieldTransformClass" title="Direct link to datahub.metadata.schema_classes.FieldTransformClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FieldTransformClass</span>(<span class="arg-name">type</span>)<a href="#datahub.metadata.schema_classes.FieldTransformClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Definition of a transform applied to the values of a column / field.
|
||
Note that the applicability of a field transform ultimately depends on the native type
|
||
of the field / column.</p><p>Model has single field to permit extension.</p><ul><li><strong>Parameters:</strong><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.FieldTransformTypeClass"><code>FieldTransformTypeClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--fieldtransformtypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.FieldTransformTypeClass">FieldTransformTypeClass</a></em><a href="#property-type--str--fieldtransformtypeclass" class="hash-link" aria-label="Direct link to property-type--str--fieldtransformtypeclass" title="Direct link to property-type--str--fieldtransformtypeclass"></a></h4><p>The type of the field transform, e.g. the transformation
|
||
function / operator to apply.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FieldTransformTypeClass"><span class="visually-hidden">FieldTransformTypeClass</span><a href="#datahub.metadata.schema_classes.FieldTransformTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FieldTransformTypeClass" title="Direct link to datahub.metadata.schema_classes.FieldTransformTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FieldTransformTypeClass</span>()<a href="#datahub.metadata.schema_classes.FieldTransformTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="length--length">LENGTH <em>= 'LENGTH'</em><a href="#length--length" class="hash-link" aria-label="Direct link to length--length" title="Direct link to length--length"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FieldUsageCountsClass"><span class="visually-hidden">FieldUsageCountsClass</span><a href="#datahub.metadata.schema_classes.FieldUsageCountsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FieldUsageCountsClass" title="Direct link to datahub.metadata.schema_classes.FieldUsageCountsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FieldUsageCountsClass</span>(<span class="arg-name">fieldName</span>, <span class="arg-name">count</span>)<a href="#datahub.metadata.schema_classes.FieldUsageCountsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Records field-level usage counts for a given resource</p><ul><li><strong>Parameters:</strong><ul><li><strong>fieldName</strong> (<code>str</code>)</li><li><strong>count</strong> (<code>int</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-count--int-2"><em>property</em> count <em>: int</em><a href="#property-count--int-2" class="hash-link" aria-label="Direct link to property-count--int-2" title="Direct link to property-count--int-2"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fieldname--str"><em>property</em> fieldName <em>: str</em><a href="#property-fieldname--str" class="hash-link" aria-label="Direct link to property-fieldname--str" title="Direct link to property-fieldname--str"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FieldValuesAssertionClass"><span class="visually-hidden">FieldValuesAssertionClass</span><a href="#datahub.metadata.schema_classes.FieldValuesAssertionClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FieldValuesAssertionClass" title="Direct link to datahub.metadata.schema_classes.FieldValuesAssertionClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FieldValuesAssertionClass</span>(<span class="arg-name">field</span>, <span class="arg-name">operator</span>, <span class="arg-name">failThreshold</span>, <span class="arg-name">transform</span> = <span class="arg-default">None</span>, <span class="arg-name">parameters</span> = <span class="arg-default">None</span>, <span class="arg-name">excludeNulls</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.FieldValuesAssertionClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Attributes defining a field values assertion, which asserts that the values for a field / column
|
||
of a dataset / table matches a set of expectations.</p><p>In other words, this type of assertion acts as a semantic constraint applied to fields for a specific column.</p><p>TODO: We should display the “failed row count” to the user if the column fails the verification rules.
|
||
TODO: Determine whether we need an “operator” that can be applied to the field.</p><ul><li><strong>Parameters:</strong><ul><li><strong>field</strong> (<a href="#datahub.metadata.schema_classes.SchemaFieldSpecClass"><code>SchemaFieldSpecClass</code></a>) – </li><li><strong>operator</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.AssertionStdOperatorClass"><code>AssertionStdOperatorClass</code></a>]) – </li><li><strong>failThreshold</strong> (<a href="#datahub.metadata.schema_classes.FieldValuesFailThresholdClass"><code>FieldValuesFailThresholdClass</code></a>) – </li><li><strong>transform</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.FieldTransformClass"><code>FieldTransformClass</code></a>]) – </li><li><strong>parameters</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AssertionStdParametersClass"><code>AssertionStdParametersClass</code></a>]) – </li><li><strong>excludeNulls</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-excludenulls--bool"><em>property</em> excludeNulls <em>: bool</em><a href="#property-excludenulls--bool" class="hash-link" aria-label="Direct link to property-excludenulls--bool" title="Direct link to property-excludenulls--bool"></a></h4><p>Whether to ignore or allow nulls when running the values assertion. (i.e.
|
||
consider only non-null values) using operators OTHER than the IS_NULL operator.</p><p>Defaults to true, allowing null values.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-failthreshold--fieldvaluesfailthresholdclass"><em>property</em> failThreshold <em>: <a href="#datahub.metadata.schema_classes.FieldValuesFailThresholdClass">FieldValuesFailThresholdClass</a></em><a href="#property-failthreshold--fieldvaluesfailthresholdclass" class="hash-link" aria-label="Direct link to property-failthreshold--fieldvaluesfailthresholdclass" title="Direct link to property-failthreshold--fieldvaluesfailthresholdclass"></a></h4><p>Additional customization about when the assertion
|
||
should be officially considered failing.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-field--schemafieldspecclass-1"><em>property</em> field <em>: <a href="#datahub.metadata.schema_classes.SchemaFieldSpecClass">SchemaFieldSpecClass</a></em><a href="#property-field--schemafieldspecclass-1" class="hash-link" aria-label="Direct link to property-field--schemafieldspecclass-1" title="Direct link to property-field--schemafieldspecclass-1"></a></h4><p>The field under evaluation</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-operator--str--assertionstdoperatorclass-2"><em>property</em> operator <em>: str | <a href="#datahub.metadata.schema_classes.AssertionStdOperatorClass">AssertionStdOperatorClass</a></em><a href="#property-operator--str--assertionstdoperatorclass-2" class="hash-link" aria-label="Direct link to property-operator--str--assertionstdoperatorclass-2" title="Direct link to property-operator--str--assertionstdoperatorclass-2"></a></h4><p>The predicate to evaluate against a single value of the field.
|
||
Depending on the operator, parameters may be required in order to successfully
|
||
evaluate the assertion against the field value.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-parameters--none--assertionstdparametersclass-2"><em>property</em> parameters <em>: None | <a href="#datahub.metadata.schema_classes.AssertionStdParametersClass">AssertionStdParametersClass</a></em><a href="#property-parameters--none--assertionstdparametersclass-2" class="hash-link" aria-label="Direct link to property-parameters--none--assertionstdparametersclass-2" title="Direct link to property-parameters--none--assertionstdparametersclass-2"></a></h4><p>Standard parameters required for the assertion. e.g. min_value, max_value, value, columns</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-transform--none--fieldtransformclass"><em>property</em> transform <em>: None | <a href="#datahub.metadata.schema_classes.FieldTransformClass">FieldTransformClass</a></em><a href="#property-transform--none--fieldtransformclass" class="hash-link" aria-label="Direct link to property-transform--none--fieldtransformclass" title="Direct link to property-transform--none--fieldtransformclass"></a></h4><p>An optional transform to apply to field values
|
||
before evaluating the operator.</p><p>If none is applied, the field value will be compared as is.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FieldValuesFailThresholdClass"><span class="visually-hidden">FieldValuesFailThresholdClass</span><a href="#datahub.metadata.schema_classes.FieldValuesFailThresholdClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FieldValuesFailThresholdClass" title="Direct link to datahub.metadata.schema_classes.FieldValuesFailThresholdClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FieldValuesFailThresholdClass</span>(<span class="arg-name">type</span> = <span class="arg-default">None</span>, <span class="arg-name">value</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.FieldValuesFailThresholdClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.FieldValuesFailThresholdTypeClass"><code>FieldValuesFailThresholdTypeClass</code></a>, <code>None</code>]) – </li><li><strong>value</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--fieldvaluesfailthresholdtypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.FieldValuesFailThresholdTypeClass">FieldValuesFailThresholdTypeClass</a></em><a href="#property-type--str--fieldvaluesfailthresholdtypeclass" class="hash-link" aria-label="Direct link to property-type--str--fieldvaluesfailthresholdtypeclass" title="Direct link to property-type--str--fieldvaluesfailthresholdtypeclass"></a></h4><p>The type of failure threshold. Either based on the number
|
||
of column values (rows) that fail the expectations, or the percentage
|
||
of the total rows under consideration.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-value--int"><em>property</em> value <em>: int</em><a href="#property-value--int" class="hash-link" aria-label="Direct link to property-value--int" title="Direct link to property-value--int"></a></h4><p>By default this is 0, meaning that ALL column values (i.e. rows) must
|
||
meet the defined expectations.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FieldValuesFailThresholdTypeClass"><span class="visually-hidden">FieldValuesFailThresholdTypeClass</span><a href="#datahub.metadata.schema_classes.FieldValuesFailThresholdTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FieldValuesFailThresholdTypeClass" title="Direct link to datahub.metadata.schema_classes.FieldValuesFailThresholdTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FieldValuesFailThresholdTypeClass</span>()<a href="#datahub.metadata.schema_classes.FieldValuesFailThresholdTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="count--count">COUNT <em>= 'COUNT'</em><a href="#count--count" class="hash-link" aria-label="Direct link to count--count" title="Direct link to count--count"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="percentage--percentage-1">PERCENTAGE <em>= 'PERCENTAGE'</em><a href="#percentage--percentage-1" class="hash-link" aria-label="Direct link to percentage--percentage-1" title="Direct link to percentage--percentage-1"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FilterClass"><span class="visually-hidden">FilterClass</span><a href="#datahub.metadata.schema_classes.FilterClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FilterClass" title="Direct link to datahub.metadata.schema_classes.FilterClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FilterClass</span>(<span class="arg-name">or_</span> = <span class="arg-default">None</span>, <span class="arg-name">criteria</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.FilterClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>The filter for finding a record or a collection of records</p><ul><li><strong>Parameters:</strong><ul><li><strong>or_</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.ConjunctiveCriterionClass"><code>ConjunctiveCriterionClass</code></a>]]) – </li><li><strong>criteria</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.CriterionClass"><code>CriterionClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-criteria--none--listcriterionclass"><em>property</em> criteria <em>: None | List[<a href="#datahub.metadata.schema_classes.CriterionClass">CriterionClass</a>]</em><a href="#property-criteria--none--listcriterionclass" class="hash-link" aria-label="Direct link to property-criteria--none--listcriterionclass" title="Direct link to property-criteria--none--listcriterionclass"></a></h4><p>Deprecated! A list of conjunctive criterion for the filter. If “or” field is provided, then this field is ignored.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-or_--none--listconjunctivecriterionclass"><em>property</em> or_ <em>: None | List[<a href="#datahub.metadata.schema_classes.ConjunctiveCriterionClass">ConjunctiveCriterionClass</a>]</em><a href="#property-or_--none--listconjunctivecriterionclass" class="hash-link" aria-label="Direct link to property-or_--none--listconjunctivecriterionclass" title="Direct link to property-or_--none--listconjunctivecriterionclass"></a></h4><p>A list of disjunctive criterion for the filter. (or operation to combine filters)</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FineGrainedLineageClass"><span class="visually-hidden">FineGrainedLineageClass</span><a href="#datahub.metadata.schema_classes.FineGrainedLineageClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FineGrainedLineageClass" title="Direct link to datahub.metadata.schema_classes.FineGrainedLineageClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FineGrainedLineageClass</span>(<span class="arg-name">upstreamType</span>, <span class="arg-name">downstreamType</span>, <span class="arg-name">upstreams</span> = <span class="arg-default">None</span>, <span class="arg-name">downstreams</span> = <span class="arg-default">None</span>, <span class="arg-name">transformOperation</span> = <span class="arg-default">None</span>, <span class="arg-name">confidenceScore</span> = <span class="arg-default">None</span>, <span class="arg-name">query</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.FineGrainedLineageClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A fine-grained lineage from upstream fields/datasets to downstream field(s)</p><ul><li><strong>Parameters:</strong><ul><li><strong>upstreamType</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.FineGrainedLineageUpstreamTypeClass"><code>FineGrainedLineageUpstreamTypeClass</code></a>]) – </li><li><strong>downstreamType</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.FineGrainedLineageDownstreamTypeClass"><code>FineGrainedLineageDownstreamTypeClass</code></a>]) – </li><li><strong>upstreams</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>downstreams</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>transformOperation</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>confidenceScore</strong> (<code>Optional</code>[<code>float</code>]<!-- -->)</li><li><strong>query</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-confidencescore--float"><em>property</em> confidenceScore <em>: float</em><a href="#property-confidencescore--float" class="hash-link" aria-label="Direct link to property-confidencescore--float" title="Direct link to property-confidencescore--float"></a></h4><p>The confidence in this lineage between 0 (low confidence) and 1 (high confidence)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-downstreamtype--str--finegrainedlineagedownstreamtypeclass"><em>property</em> downstreamType <em>: str | <a href="#datahub.metadata.schema_classes.FineGrainedLineageDownstreamTypeClass">FineGrainedLineageDownstreamTypeClass</a></em><a href="#property-downstreamtype--str--finegrainedlineagedownstreamtypeclass" class="hash-link" aria-label="Direct link to property-downstreamtype--str--finegrainedlineagedownstreamtypeclass" title="Direct link to property-downstreamtype--str--finegrainedlineagedownstreamtypeclass"></a></h4><p>The type of downstream field(s)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-downstreams--none--liststr"><em>property</em> downstreams <em>: None | List<!-- -->[str]</em><a href="#property-downstreams--none--liststr" class="hash-link" aria-label="Direct link to property-downstreams--none--liststr" title="Direct link to property-downstreams--none--liststr"></a></h4><p>Downstream fields in the lineage</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-query--none--str-1"><em>property</em> query <em>: None | str</em><a href="#property-query--none--str-1" class="hash-link" aria-label="Direct link to property-query--none--str-1" title="Direct link to property-query--none--str-1"></a></h4><p>The query that was used to generate this lineage.
|
||
Present only if the lineage was generated from a detected query.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-transformoperation--none--str"><em>property</em> transformOperation <em>: None | str</em><a href="#property-transformoperation--none--str" class="hash-link" aria-label="Direct link to property-transformoperation--none--str" title="Direct link to property-transformoperation--none--str"></a></h4><p>The transform operation applied to the upstream entities to produce the downstream field(s)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-upstreamtype--str--finegrainedlineageupstreamtypeclass"><em>property</em> upstreamType <em>: str | <a href="#datahub.metadata.schema_classes.FineGrainedLineageUpstreamTypeClass">FineGrainedLineageUpstreamTypeClass</a></em><a href="#property-upstreamtype--str--finegrainedlineageupstreamtypeclass" class="hash-link" aria-label="Direct link to property-upstreamtype--str--finegrainedlineageupstreamtypeclass" title="Direct link to property-upstreamtype--str--finegrainedlineageupstreamtypeclass"></a></h4><p>The type of upstream entity</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-upstreams--none--liststr"><em>property</em> upstreams <em>: None | List<!-- -->[str]</em><a href="#property-upstreams--none--liststr" class="hash-link" aria-label="Direct link to property-upstreams--none--liststr" title="Direct link to property-upstreams--none--liststr"></a></h4><p>Upstream entities in the lineage</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FineGrainedLineageDownstreamTypeClass"><span class="visually-hidden">FineGrainedLineageDownstreamTypeClass</span><a href="#datahub.metadata.schema_classes.FineGrainedLineageDownstreamTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FineGrainedLineageDownstreamTypeClass" title="Direct link to datahub.metadata.schema_classes.FineGrainedLineageDownstreamTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FineGrainedLineageDownstreamTypeClass</span>()<a href="#datahub.metadata.schema_classes.FineGrainedLineageDownstreamTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>The type of downstream field(s) in a fine-grained lineage</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="field--field-1">FIELD <em>= 'FIELD'</em><a href="#field--field-1" class="hash-link" aria-label="Direct link to field--field-1" title="Direct link to field--field-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="field_set--field_set">FIELD_SET <em>= 'FIELD_SET'</em><a href="#field_set--field_set" class="hash-link" aria-label="Direct link to field_set--field_set" title="Direct link to field_set--field_set"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FineGrainedLineageUpstreamTypeClass"><span class="visually-hidden">FineGrainedLineageUpstreamTypeClass</span><a href="#datahub.metadata.schema_classes.FineGrainedLineageUpstreamTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FineGrainedLineageUpstreamTypeClass" title="Direct link to datahub.metadata.schema_classes.FineGrainedLineageUpstreamTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FineGrainedLineageUpstreamTypeClass</span>()<a href="#datahub.metadata.schema_classes.FineGrainedLineageUpstreamTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>The type of upstream entity in a fine-grained lineage</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataset--dataset-1">DATASET <em>= 'DATASET'</em><a href="#dataset--dataset-1" class="hash-link" aria-label="Direct link to dataset--dataset-1" title="Direct link to dataset--dataset-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="field_set--field_set-1">FIELD_SET <em>= 'FIELD_SET'</em><a href="#field_set--field_set-1" class="hash-link" aria-label="Direct link to field_set--field_set-1" title="Direct link to field_set--field_set-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="none--none">NONE <em>= 'NONE'</em><a href="#none--none" class="hash-link" aria-label="Direct link to none--none" title="Direct link to none--none"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FixedIntervalScheduleClass"><span class="visually-hidden">FixedIntervalScheduleClass</span><a href="#datahub.metadata.schema_classes.FixedIntervalScheduleClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FixedIntervalScheduleClass" title="Direct link to datahub.metadata.schema_classes.FixedIntervalScheduleClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FixedIntervalScheduleClass</span>(<span class="arg-name">unit</span>, <span class="arg-name">multiple</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.FixedIntervalScheduleClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Attributes defining a relative fixed interval SLA schedule.</p><ul><li><strong>Parameters:</strong><ul><li><strong>unit</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.CalendarIntervalClass"><code>CalendarIntervalClass</code></a>]) – </li><li><strong>multiple</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-multiple--int"><em>property</em> multiple <em>: int</em><a href="#property-multiple--int" class="hash-link" aria-label="Direct link to property-multiple--int" title="Direct link to property-multiple--int"></a></h4><p>How many units. Defaults to 1.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-unit--str--calendarintervalclass"><em>property</em> unit <em>: str | <a href="#datahub.metadata.schema_classes.CalendarIntervalClass">CalendarIntervalClass</a></em><a href="#property-unit--str--calendarintervalclass" class="hash-link" aria-label="Direct link to property-unit--str--calendarintervalclass" title="Direct link to property-unit--str--calendarintervalclass"></a></h4><p>Interval unit such as minute/hour/day etc.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FixedTypeClass"><span class="visually-hidden">FixedTypeClass</span><a href="#datahub.metadata.schema_classes.FixedTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FixedTypeClass" title="Direct link to datahub.metadata.schema_classes.FixedTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FixedTypeClass</span>()<a href="#datahub.metadata.schema_classes.FixedTypeClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Fixed field type.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ForeignKeyConstraintClass"><span class="visually-hidden">ForeignKeyConstraintClass</span><a href="#datahub.metadata.schema_classes.ForeignKeyConstraintClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ForeignKeyConstraintClass" title="Direct link to datahub.metadata.schema_classes.ForeignKeyConstraintClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ForeignKeyConstraintClass</span>(<span class="arg-name">name</span>, <span class="arg-name">foreignFields</span>, <span class="arg-name">sourceFields</span>, <span class="arg-name">foreignDataset</span>)<a href="#datahub.metadata.schema_classes.ForeignKeyConstraintClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Description of a foreign key constraint in a schema.</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>foreignFields</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li><li><strong>sourceFields</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li><li><strong>foreignDataset</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-foreigndataset--str"><em>property</em> foreignDataset <em>: str</em><a href="#property-foreigndataset--str" class="hash-link" aria-label="Direct link to property-foreigndataset--str" title="Direct link to property-foreigndataset--str"></a></h4><p>Reference to the foreign dataset for ease of lookup</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-foreignfields--liststr"><em>property</em> foreignFields <em>: List<!-- -->[str]</em><a href="#property-foreignfields--liststr" class="hash-link" aria-label="Direct link to property-foreignfields--liststr" title="Direct link to property-foreignfields--liststr"></a></h4><p>Fields the constraint maps to on the foreign dataset</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-17"><em>property</em> name <em>: str</em><a href="#property-name--str-17" class="hash-link" aria-label="Direct link to property-name--str-17" title="Direct link to property-name--str-17"></a></h4><p>Name of the constraint, likely provided from the source</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-sourcefields--liststr-1"><em>property</em> sourceFields <em>: List<!-- -->[str]</em><a href="#property-sourcefields--liststr-1" class="hash-link" aria-label="Direct link to property-sourcefields--liststr-1" title="Direct link to property-sourcefields--liststr-1"></a></h4><p>Fields the constraint maps to on the source dataset</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ForeignKeySpecClass"><span class="visually-hidden">ForeignKeySpecClass</span><a href="#datahub.metadata.schema_classes.ForeignKeySpecClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ForeignKeySpecClass" title="Direct link to datahub.metadata.schema_classes.ForeignKeySpecClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ForeignKeySpecClass</span>(<span class="arg-name">foreignKey</span>)<a href="#datahub.metadata.schema_classes.ForeignKeySpecClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Description of a foreign key in a schema.</p><ul><li><strong>Parameters:</strong><strong>foreignKey</strong> (<code>Union</code>[<a href="#datahub.metadata.schema_classes.DatasetFieldForeignKeyClass"><code>DatasetFieldForeignKeyClass</code></a>, <a href="#datahub.metadata.schema_classes.UrnForeignKeyClass"><code>UrnForeignKeyClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-foreignkey--datasetfieldforeignkeyclass--urnforeignkeyclass"><em>property</em> foreignKey <em>: <a href="#datahub.metadata.schema_classes.DatasetFieldForeignKeyClass">DatasetFieldForeignKeyClass</a> | <a href="#datahub.metadata.schema_classes.UrnForeignKeyClass">UrnForeignKeyClass</a></em><a href="#property-foreignkey--datasetfieldforeignkeyclass--urnforeignkeyclass" class="hash-link" aria-label="Direct link to property-foreignkey--datasetfieldforeignkeyclass--urnforeignkeyclass" title="Direct link to property-foreignkey--datasetfieldforeignkeyclass--urnforeignkeyclass"></a></h4><p>Foreign key definition in metadata schema.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FormActorAssignmentClass"><span class="visually-hidden">FormActorAssignmentClass</span><a href="#datahub.metadata.schema_classes.FormActorAssignmentClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FormActorAssignmentClass" title="Direct link to datahub.metadata.schema_classes.FormActorAssignmentClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FormActorAssignmentClass</span>(<span class="arg-name">owners</span> = <span class="arg-default">None</span>, <span class="arg-name">groups</span> = <span class="arg-default">None</span>, <span class="arg-name">users</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.FormActorAssignmentClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>owners</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>groups</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>users</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-groups--none--liststr-1"><em>property</em> groups <em>: None | List<!-- -->[str]</em><a href="#property-groups--none--liststr-1" class="hash-link" aria-label="Direct link to property-groups--none--liststr-1" title="Direct link to property-groups--none--liststr-1"></a></h4><p>Specific set of groups that are targeted by this form assignment.</p><ul><li><strong>Type:</strong>
|
||
Optional</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-owners--bool"><em>property</em> owners <em>: bool</em><a href="#property-owners--bool" class="hash-link" aria-label="Direct link to property-owners--bool" title="Direct link to property-owners--bool"></a></h4><p>Whether the form should be assigned to the owners of assets that it is applied to.
|
||
This is the default.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-users--none--liststr-1"><em>property</em> users <em>: None | List<!-- -->[str]</em><a href="#property-users--none--liststr-1" class="hash-link" aria-label="Direct link to property-users--none--liststr-1" title="Direct link to property-users--none--liststr-1"></a></h4><p>Specific set of users that are targeted by this form assignment.</p><ul><li><strong>Type:</strong>
|
||
Optional</li></ul></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FormAssociationClass"><span class="visually-hidden">FormAssociationClass</span><a href="#datahub.metadata.schema_classes.FormAssociationClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FormAssociationClass" title="Direct link to datahub.metadata.schema_classes.FormAssociationClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FormAssociationClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">incompletePrompts</span> = <span class="arg-default">None</span>, <span class="arg-name">completedPrompts</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.FormAssociationClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Properties of an applied form.</p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>incompletePrompts</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.FormPromptAssociationClass"><code>FormPromptAssociationClass</code></a>]]) – </li><li><strong>completedPrompts</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.FormPromptAssociationClass"><code>FormPromptAssociationClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-completedprompts--listformpromptassociationclass"><em>property</em> completedPrompts <em>: List[<a href="#datahub.metadata.schema_classes.FormPromptAssociationClass">FormPromptAssociationClass</a>]</em><a href="#property-completedprompts--listformpromptassociationclass" class="hash-link" aria-label="Direct link to property-completedprompts--listformpromptassociationclass" title="Direct link to property-completedprompts--listformpromptassociationclass"></a></h4><p>A list of prompts that have been completed for this form.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-incompleteprompts--listformpromptassociationclass"><em>property</em> incompletePrompts <em>: List[<a href="#datahub.metadata.schema_classes.FormPromptAssociationClass">FormPromptAssociationClass</a>]</em><a href="#property-incompleteprompts--listformpromptassociationclass" class="hash-link" aria-label="Direct link to property-incompleteprompts--listformpromptassociationclass" title="Direct link to property-incompleteprompts--listformpromptassociationclass"></a></h4><p>A list of prompts that are not yet complete for this form.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-11"><em>property</em> urn <em>: str</em><a href="#property-urn--str-11" class="hash-link" aria-label="Direct link to property-urn--str-11" title="Direct link to property-urn--str-11"></a></h4><p>Urn of the applied form</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FormInfoClass"><span class="visually-hidden">FormInfoClass</span><a href="#datahub.metadata.schema_classes.FormInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FormInfoClass" title="Direct link to datahub.metadata.schema_classes.FormInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FormInfoClass</span>(<span class="arg-name">name</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">type</span> = <span class="arg-default">None</span>, <span class="arg-name">prompts</span> = <span class="arg-default">None</span>, <span class="arg-name">actors</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.FormInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a form to help with filling out metadata on entities.</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.FormTypeClass"><code>FormTypeClass</code></a>, <code>None</code>]) – </li><li><strong>prompts</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.FormPromptClass"><code>FormPromptClass</code></a>]]) – </li><li><strong>actors</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.FormActorAssignmentClass"><code>FormActorAssignmentClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-actors--formactorassignmentclass"><em>property</em> actors <em>: <a href="#datahub.metadata.schema_classes.FormActorAssignmentClass">FormActorAssignmentClass</a></em><a href="#property-actors--formactorassignmentclass" class="hash-link" aria-label="Direct link to property-actors--formactorassignmentclass" title="Direct link to property-actors--formactorassignmentclass"></a></h4><p>Who the form is assigned to, e.g. who should see the form when visiting the entity page or governance center</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-31"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-31" class="hash-link" aria-label="Direct link to property-description--none--str-31" title="Direct link to property-description--none--str-31"></a></h4><p>Description of the form</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-18"><em>property</em> name <em>: str</em><a href="#property-name--str-18" class="hash-link" aria-label="Direct link to property-name--str-18" title="Direct link to property-name--str-18"></a></h4><p>Display name of the form</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-prompts--listformpromptclass"><em>property</em> prompts <em>: List[<a href="#datahub.metadata.schema_classes.FormPromptClass">FormPromptClass</a>]</em><a href="#property-prompts--listformpromptclass" class="hash-link" aria-label="Direct link to property-prompts--listformpromptclass" title="Direct link to property-prompts--listformpromptclass"></a></h4><p>List of prompts to present to the user to encourage filling out metadata</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--formtypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.FormTypeClass">FormTypeClass</a></em><a href="#property-type--str--formtypeclass" class="hash-link" aria-label="Direct link to property-type--str--formtypeclass" title="Direct link to property-type--str--formtypeclass"></a></h4><p>The type of this form</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FormKeyClass"><span class="visually-hidden">FormKeyClass</span><a href="#datahub.metadata.schema_classes.FormKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FormKeyClass" title="Direct link to datahub.metadata.schema_classes.FormKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FormKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.FormKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Form</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-25"><em>property</em> id <em>: str</em><a href="#property-id--str-25" class="hash-link" aria-label="Direct link to property-id--str-25" title="Direct link to property-id--str-25"></a></h4><p>Unique id for the form.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FormPromptAssociationClass"><span class="visually-hidden">FormPromptAssociationClass</span><a href="#datahub.metadata.schema_classes.FormPromptAssociationClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FormPromptAssociationClass" title="Direct link to datahub.metadata.schema_classes.FormPromptAssociationClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FormPromptAssociationClass</span>(<span class="arg-name">id</span>, <span class="arg-name">lastModified</span>, <span class="arg-name">fieldAssociations</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.FormPromptAssociationClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Information about the status of a particular prompt.
|
||
Note that this is where we can add additional information about individual responses:
|
||
actor, timestamp, and the response itself.</p><ul><li><strong>Parameters:</strong><ul><li><strong>id</strong> (<code>str</code>)</li><li><strong>lastModified</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li><li><strong>fieldAssociations</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.FormPromptFieldAssociationsClass"><code>FormPromptFieldAssociationsClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fieldassociations--none--formpromptfieldassociationsclass"><em>property</em> fieldAssociations <em>: None | <a href="#datahub.metadata.schema_classes.FormPromptFieldAssociationsClass">FormPromptFieldAssociationsClass</a></em><a href="#property-fieldassociations--none--formpromptfieldassociationsclass" class="hash-link" aria-label="Direct link to property-fieldassociations--none--formpromptfieldassociationsclass" title="Direct link to property-fieldassociations--none--formpromptfieldassociationsclass"></a></h4><p>Optional information about the field-level prompt associations.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-26"><em>property</em> id <em>: str</em><a href="#property-id--str-26" class="hash-link" aria-label="Direct link to property-id--str-26" title="Direct link to property-id--str-26"></a></h4><p>The id for the prompt. This must be GLOBALLY UNIQUE.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--auditstampclass-16"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--auditstampclass-16" class="hash-link" aria-label="Direct link to property-lastmodified--auditstampclass-16" title="Direct link to property-lastmodified--auditstampclass-16"></a></h4><p>The last time this prompt was touched for the entity (set, unset)</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FormPromptClass"><span class="visually-hidden">FormPromptClass</span><a href="#datahub.metadata.schema_classes.FormPromptClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FormPromptClass" title="Direct link to datahub.metadata.schema_classes.FormPromptClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FormPromptClass</span>(<span class="arg-name">id</span>, <span class="arg-name">title</span>, <span class="arg-name">type</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">structuredPropertyParams</span> = <span class="arg-default">None</span>, <span class="arg-name">required</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.FormPromptClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A prompt to present to the user to encourage filling out metadata</p><ul><li><strong>Parameters:</strong><ul><li><strong>id</strong> (<code>str</code>)</li><li><strong>title</strong> (<code>str</code>)</li><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.FormPromptTypeClass"><code>FormPromptTypeClass</code></a>]) – </li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>structuredPropertyParams</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.StructuredPropertyParamsClass"><code>StructuredPropertyParamsClass</code></a>]) – </li><li><strong>required</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-32"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-32" class="hash-link" aria-label="Direct link to property-description--none--str-32" title="Direct link to property-description--none--str-32"></a></h4><p>The description of this prompt</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-27"><em>property</em> id <em>: str</em><a href="#property-id--str-27" class="hash-link" aria-label="Direct link to property-id--str-27" title="Direct link to property-id--str-27"></a></h4><p>The unique id for this prompt. This must be GLOBALLY unique.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-required--bool"><em>property</em> required <em>: bool</em><a href="#property-required--bool" class="hash-link" aria-label="Direct link to property-required--bool" title="Direct link to property-required--bool"></a></h4><p>Whether the prompt is required to be completed, in order for the form to be marked as complete.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-structuredpropertyparams--none--structuredpropertyparamsclass"><em>property</em> structuredPropertyParams <em>: None | <a href="#datahub.metadata.schema_classes.StructuredPropertyParamsClass">StructuredPropertyParamsClass</a></em><a href="#property-structuredpropertyparams--none--structuredpropertyparamsclass" class="hash-link" aria-label="Direct link to property-structuredpropertyparams--none--structuredpropertyparamsclass" title="Direct link to property-structuredpropertyparams--none--structuredpropertyparamsclass"></a></h4><p>An optional set of information specific to structured properties prompts.
|
||
This should be filled out if the prompt is type STRUCTURED_PROPERTY or FIELDS_STRUCTURED_PROPERTY.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-title--str-2"><em>property</em> title <em>: str</em><a href="#property-title--str-2" class="hash-link" aria-label="Direct link to property-title--str-2" title="Direct link to property-title--str-2"></a></h4><p>The title of this prompt</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--formprompttypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.FormPromptTypeClass">FormPromptTypeClass</a></em><a href="#property-type--str--formprompttypeclass" class="hash-link" aria-label="Direct link to property-type--str--formprompttypeclass" title="Direct link to property-type--str--formprompttypeclass"></a></h4><p>The type of prompt</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FormPromptFieldAssociationsClass"><span class="visually-hidden">FormPromptFieldAssociationsClass</span><a href="#datahub.metadata.schema_classes.FormPromptFieldAssociationsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FormPromptFieldAssociationsClass" title="Direct link to datahub.metadata.schema_classes.FormPromptFieldAssociationsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FormPromptFieldAssociationsClass</span>(<span class="arg-name">completedFieldPrompts</span> = <span class="arg-default">None</span>, <span class="arg-name">incompleteFieldPrompts</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.FormPromptFieldAssociationsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Information about the field-level prompt associations on a top-level prompt association.</p><ul><li><strong>Parameters:</strong><ul><li><strong>completedFieldPrompts</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.FieldFormPromptAssociationClass"><code>FieldFormPromptAssociationClass</code></a>]]) – </li><li><strong>incompleteFieldPrompts</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.FieldFormPromptAssociationClass"><code>FieldFormPromptAssociationClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-completedfieldprompts--none--listfieldformpromptassociationclass"><em>property</em> completedFieldPrompts <em>: None | List[<a href="#datahub.metadata.schema_classes.FieldFormPromptAssociationClass">FieldFormPromptAssociationClass</a>]</em><a href="#property-completedfieldprompts--none--listfieldformpromptassociationclass" class="hash-link" aria-label="Direct link to property-completedfieldprompts--none--listfieldformpromptassociationclass" title="Direct link to property-completedfieldprompts--none--listfieldformpromptassociationclass"></a></h4><p>A list of field-level prompt associations that are not yet complete for this form.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-incompletefieldprompts--none--listfieldformpromptassociationclass"><em>property</em> incompleteFieldPrompts <em>: None | List[<a href="#datahub.metadata.schema_classes.FieldFormPromptAssociationClass">FieldFormPromptAssociationClass</a>]</em><a href="#property-incompletefieldprompts--none--listfieldformpromptassociationclass" class="hash-link" aria-label="Direct link to property-incompletefieldprompts--none--listfieldformpromptassociationclass" title="Direct link to property-incompletefieldprompts--none--listfieldformpromptassociationclass"></a></h4><p>A list of field-level prompt associations that are complete for this form.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FormPromptTypeClass"><span class="visually-hidden">FormPromptTypeClass</span><a href="#datahub.metadata.schema_classes.FormPromptTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FormPromptTypeClass" title="Direct link to datahub.metadata.schema_classes.FormPromptTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FormPromptTypeClass</span>()<a href="#datahub.metadata.schema_classes.FormPromptTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="fields_structured_property--fields_structured_property">FIELDS_STRUCTURED_PROPERTY <em>= 'FIELDS_STRUCTURED_PROPERTY'</em><a href="#fields_structured_property--fields_structured_property" class="hash-link" aria-label="Direct link to fields_structured_property--fields_structured_property" title="Direct link to fields_structured_property--fields_structured_property"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="structured_property--structured_property">STRUCTURED_PROPERTY <em>= 'STRUCTURED_PROPERTY'</em><a href="#structured_property--structured_property" class="hash-link" aria-label="Direct link to structured_property--structured_property" title="Direct link to structured_property--structured_property"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FormTypeClass"><span class="visually-hidden">FormTypeClass</span><a href="#datahub.metadata.schema_classes.FormTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FormTypeClass" title="Direct link to datahub.metadata.schema_classes.FormTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FormTypeClass</span>()<a href="#datahub.metadata.schema_classes.FormTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="completion--completion">COMPLETION <em>= 'COMPLETION'</em><a href="#completion--completion" class="hash-link" aria-label="Direct link to completion--completion" title="Direct link to completion--completion"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="verification--verification">VERIFICATION <em>= 'VERIFICATION'</em><a href="#verification--verification" class="hash-link" aria-label="Direct link to verification--verification" title="Direct link to verification--verification"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FormVerificationAssociationClass"><span class="visually-hidden">FormVerificationAssociationClass</span><a href="#datahub.metadata.schema_classes.FormVerificationAssociationClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FormVerificationAssociationClass" title="Direct link to datahub.metadata.schema_classes.FormVerificationAssociationClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FormVerificationAssociationClass</span>(<span class="arg-name">form</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.FormVerificationAssociationClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>An association between a verification and an entity that has been granted
|
||
via completion of one or more forms of type ‘VERIFICATION’.</p><ul><li><strong>Parameters:</strong><ul><li><strong>form</strong> (<code>str</code>)</li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-form--str"><em>property</em> form <em>: str</em><a href="#property-form--str" class="hash-link" aria-label="Direct link to property-form--str" title="Direct link to property-form--str"></a></h4><p>The urn of the form that granted this verification.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--none--auditstampclass-3"><em>property</em> lastModified <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--none--auditstampclass-3" class="hash-link" aria-label="Direct link to property-lastmodified--none--auditstampclass-3" title="Direct link to property-lastmodified--none--auditstampclass-3"></a></h4><p>An audit stamp capturing who and when verification was applied for this form.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FormsClass"><span class="visually-hidden">FormsClass</span><a href="#datahub.metadata.schema_classes.FormsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FormsClass" title="Direct link to datahub.metadata.schema_classes.FormsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FormsClass</span>(<span class="arg-name">incompleteForms</span>, <span class="arg-name">completedForms</span>, <span class="arg-name">verifications</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.FormsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Forms that are assigned to this entity to be filled out</p><ul><li><strong>Parameters:</strong><ul><li><strong>incompleteForms</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.FormAssociationClass"><code>FormAssociationClass</code></a>]) – </li><li><strong>completedForms</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.FormAssociationClass"><code>FormAssociationClass</code></a>]) – </li><li><strong>verifications</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.FormVerificationAssociationClass"><code>FormVerificationAssociationClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-completedforms--listformassociationclass"><em>property</em> completedForms <em>: List[<a href="#datahub.metadata.schema_classes.FormAssociationClass">FormAssociationClass</a>]</em><a href="#property-completedforms--listformassociationclass" class="hash-link" aria-label="Direct link to property-completedforms--listformassociationclass" title="Direct link to property-completedforms--listformassociationclass"></a></h4><p>All complete forms assigned to the entity.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-incompleteforms--listformassociationclass"><em>property</em> incompleteForms <em>: List[<a href="#datahub.metadata.schema_classes.FormAssociationClass">FormAssociationClass</a>]</em><a href="#property-incompleteforms--listformassociationclass" class="hash-link" aria-label="Direct link to property-incompleteforms--listformassociationclass" title="Direct link to property-incompleteforms--listformassociationclass"></a></h4><p>All incomplete forms assigned to the entity.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-verifications--listformverificationassociationclass"><em>property</em> verifications <em>: List[<a href="#datahub.metadata.schema_classes.FormVerificationAssociationClass">FormVerificationAssociationClass</a>]</em><a href="#property-verifications--listformverificationassociationclass" class="hash-link" aria-label="Direct link to property-verifications--listformverificationassociationclass" title="Direct link to property-verifications--listformverificationassociationclass"></a></h4><p>Verifications that have been applied to the entity via completed forms.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FreshnessAssertionInfoClass"><span class="visually-hidden">FreshnessAssertionInfoClass</span><a href="#datahub.metadata.schema_classes.FreshnessAssertionInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FreshnessAssertionInfoClass" title="Direct link to datahub.metadata.schema_classes.FreshnessAssertionInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FreshnessAssertionInfoClass</span>(<span class="arg-name">type</span>, <span class="arg-name">entity</span>, <span class="arg-name">schedule</span>, <span class="arg-name">filter</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.FreshnessAssertionInfoClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Attributes defining a Freshness Assertion.</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.FreshnessAssertionTypeClass"><code>FreshnessAssertionTypeClass</code></a>]) – </li><li><strong>entity</strong> (<code>str</code>)</li><li><strong>schedule</strong> (<a href="#datahub.metadata.schema_classes.FreshnessAssertionScheduleClass"><code>FreshnessAssertionScheduleClass</code></a>) – </li><li><strong>filter</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.DatasetFilterClass"><code>DatasetFilterClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-entity--str-3"><em>property</em> entity <em>: str</em><a href="#property-entity--str-3" class="hash-link" aria-label="Direct link to property-entity--str-3" title="Direct link to property-entity--str-3"></a></h4><p>The entity targeted by this Freshness check.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-filter--none--datasetfilterclass-1"><em>property</em> filter <em>: None | <a href="#datahub.metadata.schema_classes.DatasetFilterClass">DatasetFilterClass</a></em><a href="#property-filter--none--datasetfilterclass-1" class="hash-link" aria-label="Direct link to property-filter--none--datasetfilterclass-1" title="Direct link to property-filter--none--datasetfilterclass-1"></a></h4><p>A definition of the specific filters that should be applied, when performing monitoring.
|
||
If not provided, there is no filter, and the full table is under consideration.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-schedule--freshnessassertionscheduleclass"><em>property</em> schedule <em>: <a href="#datahub.metadata.schema_classes.FreshnessAssertionScheduleClass">FreshnessAssertionScheduleClass</a></em><a href="#property-schedule--freshnessassertionscheduleclass" class="hash-link" aria-label="Direct link to property-schedule--freshnessassertionscheduleclass" title="Direct link to property-schedule--freshnessassertionscheduleclass"></a></h4><p>Produce FAILURE Assertion Result if the asset is not updated on the cadence and within the time range described by the schedule.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--freshnessassertiontypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.FreshnessAssertionTypeClass">FreshnessAssertionTypeClass</a></em><a href="#property-type--str--freshnessassertiontypeclass" class="hash-link" aria-label="Direct link to property-type--str--freshnessassertiontypeclass" title="Direct link to property-type--str--freshnessassertiontypeclass"></a></h4><p>The type of the freshness assertion being monitored.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FreshnessAssertionScheduleClass"><span class="visually-hidden">FreshnessAssertionScheduleClass</span><a href="#datahub.metadata.schema_classes.FreshnessAssertionScheduleClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FreshnessAssertionScheduleClass" title="Direct link to datahub.metadata.schema_classes.FreshnessAssertionScheduleClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FreshnessAssertionScheduleClass</span>(<span class="arg-name">type</span>, <span class="arg-name">cron</span> = <span class="arg-default">None</span>, <span class="arg-name">fixedInterval</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.FreshnessAssertionScheduleClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Attributes defining a single Freshness schedule.</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.FreshnessAssertionScheduleTypeClass"><code>FreshnessAssertionScheduleTypeClass</code></a>]) – </li><li><strong>cron</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.FreshnessCronScheduleClass"><code>FreshnessCronScheduleClass</code></a>]) – </li><li><strong>fixedInterval</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.FixedIntervalScheduleClass"><code>FixedIntervalScheduleClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-cron--none--freshnesscronscheduleclass"><em>property</em> cron <em>: None | <a href="#datahub.metadata.schema_classes.FreshnessCronScheduleClass">FreshnessCronScheduleClass</a></em><a href="#property-cron--none--freshnesscronscheduleclass" class="hash-link" aria-label="Direct link to property-cron--none--freshnesscronscheduleclass" title="Direct link to property-cron--none--freshnesscronscheduleclass"></a></h4><p>A cron schedule. This field is required when type is CRON.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fixedinterval--none--fixedintervalscheduleclass"><em>property</em> fixedInterval <em>: None | <a href="#datahub.metadata.schema_classes.FixedIntervalScheduleClass">FixedIntervalScheduleClass</a></em><a href="#property-fixedinterval--none--fixedintervalscheduleclass" class="hash-link" aria-label="Direct link to property-fixedinterval--none--fixedintervalscheduleclass" title="Direct link to property-fixedinterval--none--fixedintervalscheduleclass"></a></h4><p>A fixed interval schedule. This field is required when type is FIXED_INTERVAL.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--freshnessassertionscheduletypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.FreshnessAssertionScheduleTypeClass">FreshnessAssertionScheduleTypeClass</a></em><a href="#property-type--str--freshnessassertionscheduletypeclass" class="hash-link" aria-label="Direct link to property-type--str--freshnessassertionscheduletypeclass" title="Direct link to property-type--str--freshnessassertionscheduletypeclass"></a></h4><p>The type of a Freshness Assertion Schedule.</p><p>Once we support data-time-relative schedules (e.g. schedules relative to time partitions),
|
||
we will add those schedule types here.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FreshnessAssertionScheduleTypeClass"><span class="visually-hidden">FreshnessAssertionScheduleTypeClass</span><a href="#datahub.metadata.schema_classes.FreshnessAssertionScheduleTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FreshnessAssertionScheduleTypeClass" title="Direct link to datahub.metadata.schema_classes.FreshnessAssertionScheduleTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FreshnessAssertionScheduleTypeClass</span>()<a href="#datahub.metadata.schema_classes.FreshnessAssertionScheduleTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="cron--cron">CRON <em>= 'CRON'</em><a href="#cron--cron" class="hash-link" aria-label="Direct link to cron--cron" title="Direct link to cron--cron"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="fixed_interval--fixed_interval">FIXED_INTERVAL <em>= 'FIXED_INTERVAL'</em><a href="#fixed_interval--fixed_interval" class="hash-link" aria-label="Direct link to fixed_interval--fixed_interval" title="Direct link to fixed_interval--fixed_interval"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="since_the_last_check--since_the_last_check">SINCE_THE_LAST_CHECK <em>= 'SINCE_THE_LAST_CHECK'</em><a href="#since_the_last_check--since_the_last_check" class="hash-link" aria-label="Direct link to since_the_last_check--since_the_last_check" title="Direct link to since_the_last_check--since_the_last_check"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FreshnessAssertionTypeClass"><span class="visually-hidden">FreshnessAssertionTypeClass</span><a href="#datahub.metadata.schema_classes.FreshnessAssertionTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FreshnessAssertionTypeClass" title="Direct link to datahub.metadata.schema_classes.FreshnessAssertionTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FreshnessAssertionTypeClass</span>()<a href="#datahub.metadata.schema_classes.FreshnessAssertionTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataset_change--dataset_change">DATASET_CHANGE <em>= 'DATASET_CHANGE'</em><a href="#dataset_change--dataset_change" class="hash-link" aria-label="Direct link to dataset_change--dataset_change" title="Direct link to dataset_change--dataset_change"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="data_job_run--data_job_run">DATA_JOB_RUN <em>= 'DATA_JOB_RUN'</em><a href="#data_job_run--data_job_run" class="hash-link" aria-label="Direct link to data_job_run--data_job_run" title="Direct link to data_job_run--data_job_run"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FreshnessContractClass"><span class="visually-hidden">FreshnessContractClass</span><a href="#datahub.metadata.schema_classes.FreshnessContractClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FreshnessContractClass" title="Direct link to datahub.metadata.schema_classes.FreshnessContractClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FreshnessContractClass</span>(<span class="arg-name">assertion</span>)<a href="#datahub.metadata.schema_classes.FreshnessContractClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A contract pertaining to the operational SLAs of a physical data asset</p><ul><li><strong>Parameters:</strong><strong>assertion</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-assertion--str-1"><em>property</em> assertion <em>: str</em><a href="#property-assertion--str-1" class="hash-link" aria-label="Direct link to property-assertion--str-1" title="Direct link to property-assertion--str-1"></a></h4><p>The assertion representing the SLA contract.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.FreshnessCronScheduleClass"><span class="visually-hidden">FreshnessCronScheduleClass</span><a href="#datahub.metadata.schema_classes.FreshnessCronScheduleClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.FreshnessCronScheduleClass" title="Direct link to datahub.metadata.schema_classes.FreshnessCronScheduleClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">FreshnessCronScheduleClass</span>(<span class="arg-name">cron</span>, <span class="arg-name">timezone</span>, <span class="arg-name">windowStartOffsetMs</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.FreshnessCronScheduleClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Attributes defining a CRON-formatted schedule used for defining a freshness assertion.</p><ul><li><strong>Parameters:</strong><ul><li><strong>cron</strong> (<code>str</code>)</li><li><strong>timezone</strong> (<code>str</code>)</li><li><strong>windowStartOffsetMs</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-cron--str"><em>property</em> cron <em>: str</em><a href="#property-cron--str" class="hash-link" aria-label="Direct link to property-cron--str" title="Direct link to property-cron--str"></a></h4><p>A cron-formatted execution interval, as a cron string, e.g. 1 <!-- -->*<!-- --> <!-- -->*<!-- --> <!-- -->*<!-- --> <!-- -->*</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-timezone--str-1"><em>property</em> timezone <em>: str</em><a href="#property-timezone--str-1" class="hash-link" aria-label="Direct link to property-timezone--str-1" title="Direct link to property-timezone--str-1"></a></h4><p>Timezone in which the cron interval applies, e.g. America/Los Angeles</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-windowstartoffsetms--none--int"><em>property</em> windowStartOffsetMs <em>: None | int</em><a href="#property-windowstartoffsetms--none--int" class="hash-link" aria-label="Direct link to property-windowstartoffsetms--none--int" title="Direct link to property-windowstartoffsetms--none--int"></a></h4><p>An optional offset in milliseconds to SUBTRACT from the timestamp generated by the cron schedule
|
||
to generate the lower bounds of the “freshness window”, or the window of time in which an event must have occurred in order for the Freshness check
|
||
to be considering passing.</p><p>If left empty, the start of the SLA window will be the <!-- -->_<!-- -->end_ of the previously evaluated Freshness window.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.GenericAspectClass"><span class="visually-hidden">GenericAspectClass</span><a href="#datahub.metadata.schema_classes.GenericAspectClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.GenericAspectClass" title="Direct link to datahub.metadata.schema_classes.GenericAspectClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">GenericAspectClass</span>(<span class="arg-name">value</span>, <span class="arg-name">contentType</span>)<a href="#datahub.metadata.schema_classes.GenericAspectClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Generic record structure for serializing an Aspect</p><ul><li><strong>Parameters:</strong><ul><li><strong>value</strong> (<code>bytes</code>)</li><li><strong>contentType</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-contenttype--str"><em>property</em> contentType <em>: str</em><a href="#property-contenttype--str" class="hash-link" aria-label="Direct link to property-contenttype--str" title="Direct link to property-contenttype--str"></a></h4><p>The content type, which represents the fashion in which the aspect was serialized.
|
||
The only type currently supported is application/json.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-value--bytes"><em>property</em> value <em>: bytes</em><a href="#property-value--bytes" class="hash-link" aria-label="Direct link to property-value--bytes" title="Direct link to property-value--bytes"></a></h4><p>The value of the aspect, serialized as bytes.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.GenericPayloadClass"><span class="visually-hidden">GenericPayloadClass</span><a href="#datahub.metadata.schema_classes.GenericPayloadClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.GenericPayloadClass" title="Direct link to datahub.metadata.schema_classes.GenericPayloadClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">GenericPayloadClass</span>(<span class="arg-name">value</span>, <span class="arg-name">contentType</span>)<a href="#datahub.metadata.schema_classes.GenericPayloadClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Generic payload record structure for serializing a Platform Event.</p><ul><li><strong>Parameters:</strong><ul><li><strong>value</strong> (<code>bytes</code>)</li><li><strong>contentType</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-contenttype--str-1"><em>property</em> contentType <em>: str</em><a href="#property-contenttype--str-1" class="hash-link" aria-label="Direct link to property-contenttype--str-1" title="Direct link to property-contenttype--str-1"></a></h4><p>The content type, which represents the fashion in which the event was serialized.
|
||
The only type currently supported is application/json.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-value--bytes-1"><em>property</em> value <em>: bytes</em><a href="#property-value--bytes-1" class="hash-link" aria-label="Direct link to property-value--bytes-1" title="Direct link to property-value--bytes-1"></a></h4><p>The value of the event, serialized as bytes.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.GlobalHomePageSettingsClass"><span class="visually-hidden">GlobalHomePageSettingsClass</span><a href="#datahub.metadata.schema_classes.GlobalHomePageSettingsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.GlobalHomePageSettingsClass" title="Direct link to datahub.metadata.schema_classes.GlobalHomePageSettingsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">GlobalHomePageSettingsClass</span>(<span class="arg-name">defaultTemplate</span>)<a href="#datahub.metadata.schema_classes.GlobalHomePageSettingsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Global settings related to the home page for an instance</p><ul><li><strong>Parameters:</strong><strong>defaultTemplate</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-defaulttemplate--str"><em>property</em> defaultTemplate <em>: str</em><a href="#property-defaulttemplate--str" class="hash-link" aria-label="Direct link to property-defaulttemplate--str" title="Direct link to property-defaulttemplate--str"></a></h4><p>The urn that will be rendered in the UI by default for all users</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.GlobalSettingsInfoClass"><span class="visually-hidden">GlobalSettingsInfoClass</span><a href="#datahub.metadata.schema_classes.GlobalSettingsInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.GlobalSettingsInfoClass" title="Direct link to datahub.metadata.schema_classes.GlobalSettingsInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">GlobalSettingsInfoClass</span>(<span class="arg-name">sso</span> = <span class="arg-default">None</span>, <span class="arg-name">views</span> = <span class="arg-default">None</span>, <span class="arg-name">docPropagation</span> = <span class="arg-default">None</span>, <span class="arg-name">homePage</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.GlobalSettingsInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>DataHub Global platform settings. Careful - these should not be modified by the outside world!</p><ul><li><strong>Parameters:</strong><ul><li><strong>sso</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.SsoSettingsClass"><code>SsoSettingsClass</code></a>]) – </li><li><strong>views</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.GlobalViewsSettingsClass"><code>GlobalViewsSettingsClass</code></a>]) – </li><li><strong>docPropagation</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.DocPropagationFeatureSettingsClass"><code>DocPropagationFeatureSettingsClass</code></a>]) – </li><li><strong>homePage</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.GlobalHomePageSettingsClass"><code>GlobalHomePageSettingsClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-docpropagation--docpropagationfeaturesettingsclass--none"><em>property</em> docPropagation <em>: <a href="#datahub.metadata.schema_classes.DocPropagationFeatureSettingsClass">DocPropagationFeatureSettingsClass</a> | None</em><a href="#property-docpropagation--docpropagationfeaturesettingsclass--none" class="hash-link" aria-label="Direct link to property-docpropagation--docpropagationfeaturesettingsclass--none" title="Direct link to property-docpropagation--docpropagationfeaturesettingsclass--none"></a></h4><p>Settings related to the documentation propagation feature</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-homepage--none--globalhomepagesettingsclass"><em>property</em> homePage <em>: None | <a href="#datahub.metadata.schema_classes.GlobalHomePageSettingsClass">GlobalHomePageSettingsClass</a></em><a href="#property-homepage--none--globalhomepagesettingsclass" class="hash-link" aria-label="Direct link to property-homepage--none--globalhomepagesettingsclass" title="Direct link to property-homepage--none--globalhomepagesettingsclass"></a></h4><p>Global settings related to the home page for an instance</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-sso--none--ssosettingsclass"><em>property</em> sso <em>: None | <a href="#datahub.metadata.schema_classes.SsoSettingsClass">SsoSettingsClass</a></em><a href="#property-sso--none--ssosettingsclass" class="hash-link" aria-label="Direct link to property-sso--none--ssosettingsclass" title="Direct link to property-sso--none--ssosettingsclass"></a></h4><p>SSO integrations between DataHub and identity providers</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-views--none--globalviewssettingsclass"><em>property</em> views <em>: None | <a href="#datahub.metadata.schema_classes.GlobalViewsSettingsClass">GlobalViewsSettingsClass</a></em><a href="#property-views--none--globalviewssettingsclass" class="hash-link" aria-label="Direct link to property-views--none--globalviewssettingsclass" title="Direct link to property-views--none--globalviewssettingsclass"></a></h4><p>Settings related to the Views Feature</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.GlobalSettingsKeyClass"><span class="visually-hidden">GlobalSettingsKeyClass</span><a href="#datahub.metadata.schema_classes.GlobalSettingsKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.GlobalSettingsKeyClass" title="Direct link to datahub.metadata.schema_classes.GlobalSettingsKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">GlobalSettingsKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.GlobalSettingsKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Global Settings</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-28"><em>property</em> id <em>: str</em><a href="#property-id--str-28" class="hash-link" aria-label="Direct link to property-id--str-28" title="Direct link to property-id--str-28"></a></h4><p>li:globalSettings:0</p><ul><li><strong>Type:</strong>
|
||
Id for the settings. There should be only 1 global settings urn</li><li><strong>Type:</strong>
|
||
urn</li></ul></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.GlobalTagsClass"><span class="visually-hidden">GlobalTagsClass</span><a href="#datahub.metadata.schema_classes.GlobalTagsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.GlobalTagsClass" title="Direct link to datahub.metadata.schema_classes.GlobalTagsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">GlobalTagsClass</span>(<span class="arg-name">tags</span>)<a href="#datahub.metadata.schema_classes.GlobalTagsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Tag aspect used for applying tags to an entity</p><ul><li><strong>Parameters:</strong><strong>tags</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.TagAssociationClass"><code>TagAssociationClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-tags--listtagassociationclass"><em>property</em> tags <em>: List[<a href="#datahub.metadata.schema_classes.TagAssociationClass">TagAssociationClass</a>]</em><a href="#property-tags--listtagassociationclass" class="hash-link" aria-label="Direct link to property-tags--listtagassociationclass" title="Direct link to property-tags--listtagassociationclass"></a></h4><p>Tags associated with a given entity</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.GlobalViewsSettingsClass"><span class="visually-hidden">GlobalViewsSettingsClass</span><a href="#datahub.metadata.schema_classes.GlobalViewsSettingsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.GlobalViewsSettingsClass" title="Direct link to datahub.metadata.schema_classes.GlobalViewsSettingsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">GlobalViewsSettingsClass</span>(<span class="arg-name">defaultView</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.GlobalViewsSettingsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Settings for DataHub Views feature.</p><ul><li><strong>Parameters:</strong><strong>defaultView</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-defaultview--none--str-1"><em>property</em> defaultView <em>: None | str</em><a href="#property-defaultview--none--str-1" class="hash-link" aria-label="Direct link to property-defaultview--none--str-1" title="Direct link to property-defaultview--none--str-1"></a></h4><p>The default View for the instance, or organization.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.GlossaryNodeInfoClass"><span class="visually-hidden">GlossaryNodeInfoClass</span><a href="#datahub.metadata.schema_classes.GlossaryNodeInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.GlossaryNodeInfoClass" title="Direct link to datahub.metadata.schema_classes.GlossaryNodeInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">GlossaryNodeInfoClass</span>(<span class="arg-name">definition</span>, <span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">parentNode</span> = <span class="arg-default">None</span>, <span class="arg-name">name</span> = <span class="arg-default">None</span>, <span class="arg-name">id</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.GlossaryNodeInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties associated with a GlossaryNode</p><ul><li><strong>Parameters:</strong><ul><li><strong>definition</strong> (<code>str</code>)</li><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>parentNode</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>id</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-17"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-17" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-17" title="Direct link to property-customproperties--dictstr-str-17"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-definition--str"><em>property</em> definition <em>: str</em><a href="#property-definition--str" class="hash-link" aria-label="Direct link to property-definition--str" title="Direct link to property-definition--str"></a></h4><p>Definition of business node</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--none--str"><em>property</em> id <em>: None | str</em><a href="#property-id--none--str" class="hash-link" aria-label="Direct link to property-id--none--str" title="Direct link to property-id--none--str"></a></h4><p>Optional id for the GlossaryNode</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--none--str-7"><em>property</em> name <em>: None | str</em><a href="#property-name--none--str-7" class="hash-link" aria-label="Direct link to property-name--none--str-7" title="Direct link to property-name--none--str-7"></a></h4><p>Display name of the node</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-parentnode--none--str"><em>property</em> parentNode <em>: None | str</em><a href="#property-parentnode--none--str" class="hash-link" aria-label="Direct link to property-parentnode--none--str" title="Direct link to property-parentnode--none--str"></a></h4><p>Parent node of the glossary term</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.GlossaryNodeKeyClass"><span class="visually-hidden">GlossaryNodeKeyClass</span><a href="#datahub.metadata.schema_classes.GlossaryNodeKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.GlossaryNodeKeyClass" title="Direct link to datahub.metadata.schema_classes.GlossaryNodeKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">GlossaryNodeKeyClass</span>(<span class="arg-name">name</span>)<a href="#datahub.metadata.schema_classes.GlossaryNodeKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a GlossaryNode</p><ul><li><strong>Parameters:</strong><strong>name</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-19"><em>property</em> name <em>: str</em><a href="#property-name--str-19" class="hash-link" aria-label="Direct link to property-name--str-19" title="Direct link to property-name--str-19"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.GlossaryNodeSnapshotClass"><span class="visually-hidden">GlossaryNodeSnapshotClass</span><a href="#datahub.metadata.schema_classes.GlossaryNodeSnapshotClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.GlossaryNodeSnapshotClass" title="Direct link to datahub.metadata.schema_classes.GlossaryNodeSnapshotClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">GlossaryNodeSnapshotClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">aspects</span>)<a href="#datahub.metadata.schema_classes.GlossaryNodeSnapshotClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A metadata snapshot for a specific GlossaryNode entity.</p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>aspects</strong> (<code>List</code>[<code>Union</code>[<a href="#datahub.metadata.schema_classes.GlossaryNodeKeyClass"><code>GlossaryNodeKeyClass</code></a>, <a href="#datahub.metadata.schema_classes.GlossaryNodeInfoClass"><code>GlossaryNodeInfoClass</code></a>, <a href="#datahub.metadata.schema_classes.OwnershipClass"><code>OwnershipClass</code></a>, <a href="#datahub.metadata.schema_classes.StatusClass"><code>StatusClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspects--listglossarynodekeyclass--glossarynodeinfoclass--ownershipclass--statusclass"><em>property</em> aspects <em>: List[<a href="#datahub.metadata.schema_classes.GlossaryNodeKeyClass">GlossaryNodeKeyClass</a> | <a href="#datahub.metadata.schema_classes.GlossaryNodeInfoClass">GlossaryNodeInfoClass</a> | <a href="#datahub.metadata.schema_classes.OwnershipClass">OwnershipClass</a> | <a href="#datahub.metadata.schema_classes.StatusClass">StatusClass</a>]</em><a href="#property-aspects--listglossarynodekeyclass--glossarynodeinfoclass--ownershipclass--statusclass" class="hash-link" aria-label="Direct link to property-aspects--listglossarynodekeyclass--glossarynodeinfoclass--ownershipclass--statusclass" title="Direct link to property-aspects--listglossarynodekeyclass--glossarynodeinfoclass--ownershipclass--statusclass"></a></h4><p>The list of metadata aspects associated with the GlossaryNode. Depending on the use case, this can either be all, or a selection, of supported aspects.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-12"><em>property</em> urn <em>: str</em><a href="#property-urn--str-12" class="hash-link" aria-label="Direct link to property-urn--str-12" title="Direct link to property-urn--str-12"></a></h4><p>URN for the entity the metadata snapshot is associated with.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.GlossaryRelatedTermsClass"><span class="visually-hidden">GlossaryRelatedTermsClass</span><a href="#datahub.metadata.schema_classes.GlossaryRelatedTermsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.GlossaryRelatedTermsClass" title="Direct link to datahub.metadata.schema_classes.GlossaryRelatedTermsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">GlossaryRelatedTermsClass</span>(<span class="arg-name">isRelatedTerms</span> = <span class="arg-default">None</span>, <span class="arg-name">hasRelatedTerms</span> = <span class="arg-default">None</span>, <span class="arg-name">values</span> = <span class="arg-default">None</span>, <span class="arg-name">relatedTerms</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.GlossaryRelatedTermsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Has A / Is A lineage information about a glossary Term reporting the lineage</p><ul><li><strong>Parameters:</strong><ul><li><strong>isRelatedTerms</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>hasRelatedTerms</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>values</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>relatedTerms</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-hasrelatedterms--none--liststr"><em>property</em> hasRelatedTerms <em>: None | List<!-- -->[str]</em><a href="#property-hasrelatedterms--none--liststr" class="hash-link" aria-label="Direct link to property-hasrelatedterms--none--liststr" title="Direct link to property-hasrelatedterms--none--liststr"></a></h4><p>The relationship Has A with glossary term</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-isrelatedterms--none--liststr"><em>property</em> isRelatedTerms <em>: None | List<!-- -->[str]</em><a href="#property-isrelatedterms--none--liststr" class="hash-link" aria-label="Direct link to property-isrelatedterms--none--liststr" title="Direct link to property-isrelatedterms--none--liststr"></a></h4><p>The relationship Is A with glossary term</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-relatedterms--none--liststr"><em>property</em> relatedTerms <em>: None | List<!-- -->[str]</em><a href="#property-relatedterms--none--liststr" class="hash-link" aria-label="Direct link to property-relatedterms--none--liststr" title="Direct link to property-relatedterms--none--liststr"></a></h4><p>The relationship isRelatedTo with glossary term</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-values--none--liststr"><em>property</em> values <em>: None | List<!-- -->[str]</em><a href="#property-values--none--liststr" class="hash-link" aria-label="Direct link to property-values--none--liststr" title="Direct link to property-values--none--liststr"></a></h4><p>The relationship Has Value with glossary term.
|
||
These are fixed value a term has. For example a ColorEnum where RED, GREEN and YELLOW are fixed values.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.GlossaryTermAssociationClass"><span class="visually-hidden">GlossaryTermAssociationClass</span><a href="#datahub.metadata.schema_classes.GlossaryTermAssociationClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.GlossaryTermAssociationClass" title="Direct link to datahub.metadata.schema_classes.GlossaryTermAssociationClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">GlossaryTermAssociationClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">actor</span> = <span class="arg-default">None</span>, <span class="arg-name">context</span> = <span class="arg-default">None</span>, <span class="arg-name">attribution</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.GlossaryTermAssociationClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Properties of an applied glossary term.</p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>actor</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>context</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>attribution</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.MetadataAttributionClass"><code>MetadataAttributionClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-actor--none--str-1"><em>property</em> actor <em>: None | str</em><a href="#property-actor--none--str-1" class="hash-link" aria-label="Direct link to property-actor--none--str-1" title="Direct link to property-actor--none--str-1"></a></h4><p>The user URN which will be credited for adding associating this term to the entity</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-attribution--none--metadataattributionclass-1"><em>property</em> attribution <em>: None | <a href="#datahub.metadata.schema_classes.MetadataAttributionClass">MetadataAttributionClass</a></em><a href="#property-attribution--none--metadataattributionclass-1" class="hash-link" aria-label="Direct link to property-attribution--none--metadataattributionclass-1" title="Direct link to property-attribution--none--metadataattributionclass-1"></a></h4><p>Information about who, why, and how this metadata was applied</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-context--none--str"><em>property</em> context <em>: None | str</em><a href="#property-context--none--str" class="hash-link" aria-label="Direct link to property-context--none--str" title="Direct link to property-context--none--str"></a></h4><p>Additional context about the association</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-13"><em>property</em> urn <em>: str</em><a href="#property-urn--str-13" class="hash-link" aria-label="Direct link to property-urn--str-13" title="Direct link to property-urn--str-13"></a></h4><p>Urn of the applied glossary term</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.GlossaryTermInfoClass"><span class="visually-hidden">GlossaryTermInfoClass</span><a href="#datahub.metadata.schema_classes.GlossaryTermInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.GlossaryTermInfoClass" title="Direct link to datahub.metadata.schema_classes.GlossaryTermInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">GlossaryTermInfoClass</span>(<span class="arg-name">definition</span>, <span class="arg-name">termSource</span>, <span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">id</span> = <span class="arg-default">None</span>, <span class="arg-name">name</span> = <span class="arg-default">None</span>, <span class="arg-name">parentNode</span> = <span class="arg-default">None</span>, <span class="arg-name">sourceRef</span> = <span class="arg-default">None</span>, <span class="arg-name">sourceUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">rawSchema</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.GlossaryTermInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties associated with a GlossaryTerm</p><ul><li><strong>Parameters:</strong><ul><li><strong>definition</strong> (<code>str</code>)</li><li><strong>termSource</strong> (<code>str</code>)</li><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>id</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>parentNode</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>sourceRef</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>sourceUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>rawSchema</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-18"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-18" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-18" title="Direct link to property-customproperties--dictstr-str-18"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-definition--str-1"><em>property</em> definition <em>: str</em><a href="#property-definition--str-1" class="hash-link" aria-label="Direct link to property-definition--str-1" title="Direct link to property-definition--str-1"></a></h4><p>Definition of business term.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--none--str-1"><em>property</em> id <em>: None | str</em><a href="#property-id--none--str-1" class="hash-link" aria-label="Direct link to property-id--none--str-1" title="Direct link to property-id--none--str-1"></a></h4><p>Optional id for the term</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--none--str-8"><em>property</em> name <em>: None | str</em><a href="#property-name--none--str-8" class="hash-link" aria-label="Direct link to property-name--none--str-8" title="Direct link to property-name--none--str-8"></a></h4><p>Display name of the term</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-parentnode--none--str-1"><em>property</em> parentNode <em>: None | str</em><a href="#property-parentnode--none--str-1" class="hash-link" aria-label="Direct link to property-parentnode--none--str-1" title="Direct link to property-parentnode--none--str-1"></a></h4><p>Parent node of the glossary term</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-rawschema--none--str"><em>property</em> rawSchema <em>: None | str</em><a href="#property-rawschema--none--str" class="hash-link" aria-label="Direct link to property-rawschema--none--str" title="Direct link to property-rawschema--none--str"></a></h4><p>Schema definition of the glossary term</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-sourceref--none--str"><em>property</em> sourceRef <em>: None | str</em><a href="#property-sourceref--none--str" class="hash-link" aria-label="Direct link to property-sourceref--none--str" title="Direct link to property-sourceref--none--str"></a></h4><p>External Reference to the business-term</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-sourceurl--none--str"><em>property</em> sourceUrl <em>: None | str</em><a href="#property-sourceurl--none--str" class="hash-link" aria-label="Direct link to property-sourceurl--none--str" title="Direct link to property-sourceurl--none--str"></a></h4><p>//spec.edmcouncil.org/fibo/ontology/FBC/FinancialInstruments/FinancialInstruments/CashInstrument.</p><ul><li><strong>Type:</strong>
|
||
The abstracted URL such as https</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-termsource--str"><em>property</em> termSource <em>: str</em><a href="#property-termsource--str" class="hash-link" aria-label="Direct link to property-termsource--str" title="Direct link to property-termsource--str"></a></h4><p>Source of the Business Term (INTERNAL or EXTERNAL) with default value as INTERNAL</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.GlossaryTermKeyClass"><span class="visually-hidden">GlossaryTermKeyClass</span><a href="#datahub.metadata.schema_classes.GlossaryTermKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.GlossaryTermKeyClass" title="Direct link to datahub.metadata.schema_classes.GlossaryTermKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">GlossaryTermKeyClass</span>(<span class="arg-name">name</span>)<a href="#datahub.metadata.schema_classes.GlossaryTermKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a GlossaryTerm</p><ul><li><strong>Parameters:</strong><strong>name</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-20"><em>property</em> name <em>: str</em><a href="#property-name--str-20" class="hash-link" aria-label="Direct link to property-name--str-20" title="Direct link to property-name--str-20"></a></h4><p>The term name, which serves as a unique id</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.GlossaryTermSnapshotClass"><span class="visually-hidden">GlossaryTermSnapshotClass</span><a href="#datahub.metadata.schema_classes.GlossaryTermSnapshotClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.GlossaryTermSnapshotClass" title="Direct link to datahub.metadata.schema_classes.GlossaryTermSnapshotClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">GlossaryTermSnapshotClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">aspects</span>)<a href="#datahub.metadata.schema_classes.GlossaryTermSnapshotClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A metadata snapshot for a specific GlossaryTerm entity.</p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>aspects</strong> (<code>List</code>[<code>Union</code>[<a href="#datahub.metadata.schema_classes.GlossaryTermKeyClass"><code>GlossaryTermKeyClass</code></a>, <a href="#datahub.metadata.schema_classes.GlossaryTermInfoClass"><code>GlossaryTermInfoClass</code></a>, <a href="#datahub.metadata.schema_classes.OwnershipClass"><code>OwnershipClass</code></a>, <a href="#datahub.metadata.schema_classes.StatusClass"><code>StatusClass</code></a>, <a href="#datahub.metadata.schema_classes.BrowsePathsClass"><code>BrowsePathsClass</code></a>, <a href="#datahub.metadata.schema_classes.GlossaryRelatedTermsClass"><code>GlossaryRelatedTermsClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspects--listglossarytermkeyclass--glossaryterminfoclass--ownershipclass--statusclass--browsepathsclass--glossaryrelatedtermsclass"><em>property</em> aspects <em>: List[<a href="#datahub.metadata.schema_classes.GlossaryTermKeyClass">GlossaryTermKeyClass</a> | <a href="#datahub.metadata.schema_classes.GlossaryTermInfoClass">GlossaryTermInfoClass</a> | <a href="#datahub.metadata.schema_classes.OwnershipClass">OwnershipClass</a> | <a href="#datahub.metadata.schema_classes.StatusClass">StatusClass</a> | <a href="#datahub.metadata.schema_classes.BrowsePathsClass">BrowsePathsClass</a> | <a href="#datahub.metadata.schema_classes.GlossaryRelatedTermsClass">GlossaryRelatedTermsClass</a>]</em><a href="#property-aspects--listglossarytermkeyclass--glossaryterminfoclass--ownershipclass--statusclass--browsepathsclass--glossaryrelatedtermsclass" class="hash-link" aria-label="Direct link to property-aspects--listglossarytermkeyclass--glossaryterminfoclass--ownershipclass--statusclass--browsepathsclass--glossaryrelatedtermsclass" title="Direct link to property-aspects--listglossarytermkeyclass--glossaryterminfoclass--ownershipclass--statusclass--browsepathsclass--glossaryrelatedtermsclass"></a></h4><p>The list of metadata aspects associated with the GlossaryTerm. Depending on the use case, this can either be all, or a selection, of supported aspects.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-14"><em>property</em> urn <em>: str</em><a href="#property-urn--str-14" class="hash-link" aria-label="Direct link to property-urn--str-14" title="Direct link to property-urn--str-14"></a></h4><p>URN for the entity the metadata snapshot is associated with.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.GlossaryTermsClass"><span class="visually-hidden">GlossaryTermsClass</span><a href="#datahub.metadata.schema_classes.GlossaryTermsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.GlossaryTermsClass" title="Direct link to datahub.metadata.schema_classes.GlossaryTermsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">GlossaryTermsClass</span>(<span class="arg-name">terms</span>, <span class="arg-name">auditStamp</span>)<a href="#datahub.metadata.schema_classes.GlossaryTermsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Related business terms information</p><ul><li><strong>Parameters:</strong><ul><li><strong>terms</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.GlossaryTermAssociationClass"><code>GlossaryTermAssociationClass</code></a>]) – </li><li><strong>auditStamp</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-auditstamp--auditstampclass-1"><em>property</em> auditStamp <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-auditstamp--auditstampclass-1" class="hash-link" aria-label="Direct link to property-auditstamp--auditstampclass-1" title="Direct link to property-auditstamp--auditstampclass-1"></a></h4><p>Audit stamp containing who reported the related business term</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-terms--listglossarytermassociationclass"><em>property</em> terms <em>: List[<a href="#datahub.metadata.schema_classes.GlossaryTermAssociationClass">GlossaryTermAssociationClass</a>]</em><a href="#property-terms--listglossarytermassociationclass" class="hash-link" aria-label="Direct link to property-terms--listglossarytermassociationclass" title="Direct link to property-terms--listglossarytermassociationclass"></a></h4><p>The related business terms</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.GroupMembershipClass"><span class="visually-hidden">GroupMembershipClass</span><a href="#datahub.metadata.schema_classes.GroupMembershipClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.GroupMembershipClass" title="Direct link to datahub.metadata.schema_classes.GroupMembershipClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">GroupMembershipClass</span>(<span class="arg-name">groups</span>)<a href="#datahub.metadata.schema_classes.GroupMembershipClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Carries information about the CorpGroups a user is in.</p><ul><li><strong>Parameters:</strong><strong>groups</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-groups--liststr-1"><em>property</em> groups <em>: List<!-- -->[str]</em><a href="#property-groups--liststr-1" class="hash-link" aria-label="Direct link to property-groups--liststr-1" title="Direct link to property-groups--liststr-1"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.HistogramClass"><span class="visually-hidden">HistogramClass</span><a href="#datahub.metadata.schema_classes.HistogramClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.HistogramClass" title="Direct link to datahub.metadata.schema_classes.HistogramClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">HistogramClass</span>(<span class="arg-name">boundaries</span>, <span class="arg-name">heights</span>)<a href="#datahub.metadata.schema_classes.HistogramClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>boundaries</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li><li><strong>heights</strong> (<code>List</code>[<code>float</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-boundaries--liststr"><em>property</em> boundaries <em>: List<!-- -->[str]</em><a href="#property-boundaries--liststr" class="hash-link" aria-label="Direct link to property-boundaries--liststr" title="Direct link to property-boundaries--liststr"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-heights--listfloat"><em>property</em> heights <em>: List<!-- -->[float]</em><a href="#property-heights--listfloat" class="hash-link" aria-label="Direct link to property-heights--listfloat" title="Direct link to property-heights--listfloat"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IcebergCatalogInfoClass"><span class="visually-hidden">IcebergCatalogInfoClass</span><a href="#datahub.metadata.schema_classes.IcebergCatalogInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IcebergCatalogInfoClass" title="Direct link to datahub.metadata.schema_classes.IcebergCatalogInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IcebergCatalogInfoClass</span>(<span class="arg-name">metadataPointer</span> = <span class="arg-default">None</span>, <span class="arg-name">view</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.IcebergCatalogInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Iceberg Catalog metadata associated with an Iceberg table/view</p><ul><li><strong>Parameters:</strong><ul><li><strong>metadataPointer</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>view</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-metadatapointer--none--str"><em>property</em> metadataPointer <em>: None | str</em><a href="#property-metadatapointer--none--str" class="hash-link" aria-label="Direct link to property-metadatapointer--none--str" title="Direct link to property-metadatapointer--none--str"></a></h4><p>When Datahub is the REST Catalog for an Iceberg Table, stores the current metadata pointer.
|
||
If the Iceberg table is managed by an external catalog, the metadata pointer is not set.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-view--none--bool"><em>property</em> view <em>: None | bool</em><a href="#property-view--none--bool" class="hash-link" aria-label="Direct link to property-view--none--bool" title="Direct link to property-view--none--bool"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IcebergWarehouseInfoClass"><span class="visually-hidden">IcebergWarehouseInfoClass</span><a href="#datahub.metadata.schema_classes.IcebergWarehouseInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IcebergWarehouseInfoClass" title="Direct link to datahub.metadata.schema_classes.IcebergWarehouseInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IcebergWarehouseInfoClass</span>(<span class="arg-name">dataRoot</span>, <span class="arg-name">clientId</span>, <span class="arg-name">clientSecret</span>, <span class="arg-name">region</span>, <span class="arg-name">env</span>, <span class="arg-name">role</span> = <span class="arg-default">None</span>, <span class="arg-name">tempCredentialExpirationSeconds</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.IcebergWarehouseInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>An Iceberg warehouse location and credentails whose read/writes are governed by datahub catalog.</p><ul><li><strong>Parameters:</strong><ul><li><strong>dataRoot</strong> (<code>str</code>)</li><li><strong>clientId</strong> (<code>str</code>)</li><li><strong>clientSecret</strong> (<code>str</code>)</li><li><strong>region</strong> (<code>str</code>)</li><li><strong>env</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.FabricTypeClass"><code>FabricTypeClass</code></a>]) – </li><li><strong>role</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>tempCredentialExpirationSeconds</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-clientid--str"><em>property</em> clientId <em>: str</em><a href="#property-clientid--str" class="hash-link" aria-label="Direct link to property-clientid--str" title="Direct link to property-clientid--str"></a></h4><p>clientId to be used to authenticate with storage hosting this warehouse</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-clientsecret--str"><em>property</em> clientSecret <em>: str</em><a href="#property-clientsecret--str" class="hash-link" aria-label="Direct link to property-clientsecret--str" title="Direct link to property-clientsecret--str"></a></h4><p>client secret to authenticate with storage hosting this warehouse</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-dataroot--str"><em>property</em> dataRoot <em>: str</em><a href="#property-dataroot--str" class="hash-link" aria-label="Direct link to property-dataroot--str" title="Direct link to property-dataroot--str"></a></h4><p>Path of the root for the backing store of the tables in the warehouse.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-env--str--fabrictypeclass"><em>property</em> env <em>: str | <a href="#datahub.metadata.schema_classes.FabricTypeClass">FabricTypeClass</a></em><a href="#property-env--str--fabrictypeclass" class="hash-link" aria-label="Direct link to property-env--str--fabrictypeclass" title="Direct link to property-env--str--fabrictypeclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-region--str"><em>property</em> region <em>: str</em><a href="#property-region--str" class="hash-link" aria-label="Direct link to property-region--str" title="Direct link to property-region--str"></a></h4><p>region where the warehouse is located.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-role--none--str"><em>property</em> role <em>: None | str</em><a href="#property-role--none--str" class="hash-link" aria-label="Direct link to property-role--none--str" title="Direct link to property-role--none--str"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-tempcredentialexpirationseconds--none--int"><em>property</em> tempCredentialExpirationSeconds <em>: None | int</em><a href="#property-tempcredentialexpirationseconds--none--int" class="hash-link" aria-label="Direct link to property-tempcredentialexpirationseconds--none--int" title="Direct link to property-tempcredentialexpirationseconds--none--int"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IconLibraryClass"><span class="visually-hidden">IconLibraryClass</span><a href="#datahub.metadata.schema_classes.IconLibraryClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IconLibraryClass" title="Direct link to datahub.metadata.schema_classes.IconLibraryClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IconLibraryClass</span>()<a href="#datahub.metadata.schema_classes.IconLibraryClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>Enum of possible icon sources</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="material--material">MATERIAL <em>= 'MATERIAL'</em><a href="#material--material" class="hash-link" aria-label="Direct link to material--material" title="Direct link to material--material"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IconPropertiesClass"><span class="visually-hidden">IconPropertiesClass</span><a href="#datahub.metadata.schema_classes.IconPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IconPropertiesClass" title="Direct link to datahub.metadata.schema_classes.IconPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IconPropertiesClass</span>(<span class="arg-name">iconLibrary</span>, <span class="arg-name">name</span>, <span class="arg-name">style</span>)<a href="#datahub.metadata.schema_classes.IconPropertiesClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Properties describing an icon associated with an entity</p><ul><li><strong>Parameters:</strong><ul><li><strong>iconLibrary</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.IconLibraryClass"><code>IconLibraryClass</code></a>]) – </li><li><strong>name</strong> (<code>str</code>)</li><li><strong>style</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-iconlibrary--str--iconlibraryclass"><em>property</em> iconLibrary <em>: str | <a href="#datahub.metadata.schema_classes.IconLibraryClass">IconLibraryClass</a></em><a href="#property-iconlibrary--str--iconlibraryclass" class="hash-link" aria-label="Direct link to property-iconlibrary--str--iconlibraryclass" title="Direct link to property-iconlibrary--str--iconlibraryclass"></a></h4><p>e.g. Antd, Material, etc</p><ul><li><strong>Type:</strong>
|
||
The source of the icon</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-21"><em>property</em> name <em>: str</em><a href="#property-name--str-21" class="hash-link" aria-label="Direct link to property-name--str-21" title="Direct link to property-name--str-21"></a></h4><p>The name of the icon</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-style--str"><em>property</em> style <em>: str</em><a href="#property-style--str" class="hash-link" aria-label="Direct link to property-style--str" title="Direct link to property-style--str"></a></h4><p>Any modifier for the icon, this will be library-specific, e.g. filled/outlined, etc</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IncidentAssigneeClass"><span class="visually-hidden">IncidentAssigneeClass</span><a href="#datahub.metadata.schema_classes.IncidentAssigneeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IncidentAssigneeClass" title="Direct link to datahub.metadata.schema_classes.IncidentAssigneeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IncidentAssigneeClass</span>(<span class="arg-name">actor</span>, <span class="arg-name">assignedAt</span>)<a href="#datahub.metadata.schema_classes.IncidentAssigneeClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>The incident assignee type.
|
||
This is in a record so that we can add additional fields if we need to later (e.g.
|
||
the type of the assignee.</p><ul><li><strong>Parameters:</strong><ul><li><strong>actor</strong> (<code>str</code>)</li><li><strong>assignedAt</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-actor--str-2"><em>property</em> actor <em>: str</em><a href="#property-actor--str-2" class="hash-link" aria-label="Direct link to property-actor--str-2" title="Direct link to property-actor--str-2"></a></h4><p>The user or group assigned to the incident.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-assignedat--auditstampclass"><em>property</em> assignedAt <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-assignedat--auditstampclass" class="hash-link" aria-label="Direct link to property-assignedat--auditstampclass" title="Direct link to property-assignedat--auditstampclass"></a></h4><p>The time & actor responsible for assiging the assignee.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IncidentInfoClass"><span class="visually-hidden">IncidentInfoClass</span><a href="#datahub.metadata.schema_classes.IncidentInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IncidentInfoClass" title="Direct link to datahub.metadata.schema_classes.IncidentInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IncidentInfoClass</span>(<span class="arg-name">type</span>, <span class="arg-name">entities</span>, <span class="arg-name">status</span>, <span class="arg-name">created</span>, <span class="arg-name">customType</span> = <span class="arg-default">None</span>, <span class="arg-name">title</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">priority</span> = <span class="arg-default">None</span>, <span class="arg-name">assignees</span> = <span class="arg-default">None</span>, <span class="arg-name">source</span> = <span class="arg-default">None</span>, <span class="arg-name">startedAt</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.IncidentInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about an incident raised on an asset.</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.IncidentTypeClass"><code>IncidentTypeClass</code></a>]) – </li><li><strong>entities</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li><li><strong>status</strong> (<a href="#datahub.metadata.schema_classes.IncidentStatusClass"><code>IncidentStatusClass</code></a>) – </li><li><strong>created</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li><li><strong>customType</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>title</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>priority</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>assignees</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.IncidentAssigneeClass"><code>IncidentAssigneeClass</code></a>]]) – </li><li><strong>source</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.IncidentSourceClass"><code>IncidentSourceClass</code></a>]) – </li><li><strong>startedAt</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-assignees--none--listincidentassigneeclass"><em>property</em> assignees <em>: None | List[<a href="#datahub.metadata.schema_classes.IncidentAssigneeClass">IncidentAssigneeClass</a>]</em><a href="#property-assignees--none--listincidentassigneeclass" class="hash-link" aria-label="Direct link to property-assignees--none--listincidentassigneeclass" title="Direct link to property-assignees--none--listincidentassigneeclass"></a></h4><p>The parties assigned with resolving the incident</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--auditstampclass-15"><em>property</em> created <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--auditstampclass-15" class="hash-link" aria-label="Direct link to property-created--auditstampclass-15" title="Direct link to property-created--auditstampclass-15"></a></h4><p>The time at which the request was initially created</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customtype--none--str"><em>property</em> customType <em>: None | str</em><a href="#property-customtype--none--str" class="hash-link" aria-label="Direct link to property-customtype--none--str" title="Direct link to property-customtype--none--str"></a></h4><p>An optional custom incident type. Present only if type is ‘CUSTOM’.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-33"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-33" class="hash-link" aria-label="Direct link to property-description--none--str-33" title="Direct link to property-description--none--str-33"></a></h4><p>Optional description associated with the incident</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-entities--liststr"><em>property</em> entities <em>: List<!-- -->[str]</em><a href="#property-entities--liststr" class="hash-link" aria-label="Direct link to property-entities--liststr" title="Direct link to property-entities--liststr"></a></h4><p>A reference to the entity associated with the incident.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-priority--int--none"><em>property</em> priority <em>: int | None</em><a href="#property-priority--int--none" class="hash-link" aria-label="Direct link to property-priority--int--none" title="Direct link to property-priority--int--none"></a></h4><p>A numeric severity or priority for the incident. On the UI we will translate this into something easy to understand.
|
||
Currently supported: 0 - CRITICAL, 1 - HIGH, 2 - MED, 3 - LOW
|
||
(We probably should have modeled as an enum)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-source--none--incidentsourceclass"><em>property</em> source <em>: None | <a href="#datahub.metadata.schema_classes.IncidentSourceClass">IncidentSourceClass</a></em><a href="#property-source--none--incidentsourceclass" class="hash-link" aria-label="Direct link to property-source--none--incidentsourceclass" title="Direct link to property-source--none--incidentsourceclass"></a></h4><p>The source of an incident, i.e. how it was generated.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-startedat--none--int"><em>property</em> startedAt <em>: None | int</em><a href="#property-startedat--none--int" class="hash-link" aria-label="Direct link to property-startedat--none--int" title="Direct link to property-startedat--none--int"></a></h4><p>The time at which the incident actually started (may be before the date it was raised).</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-status--incidentstatusclass"><em>property</em> status <em>: <a href="#datahub.metadata.schema_classes.IncidentStatusClass">IncidentStatusClass</a></em><a href="#property-status--incidentstatusclass" class="hash-link" aria-label="Direct link to property-status--incidentstatusclass" title="Direct link to property-status--incidentstatusclass"></a></h4><p>The current status of an incident, i.e. active or inactive.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-title--none--str-2"><em>property</em> title <em>: None | str</em><a href="#property-title--none--str-2" class="hash-link" aria-label="Direct link to property-title--none--str-2" title="Direct link to property-title--none--str-2"></a></h4><p>Optional title associated with the incident</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--incidenttypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.IncidentTypeClass">IncidentTypeClass</a></em><a href="#property-type--str--incidenttypeclass" class="hash-link" aria-label="Direct link to property-type--str--incidenttypeclass" title="Direct link to property-type--str--incidenttypeclass"></a></h4><p>The type of incident</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IncidentKeyClass"><span class="visually-hidden">IncidentKeyClass</span><a href="#datahub.metadata.schema_classes.IncidentKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IncidentKeyClass" title="Direct link to datahub.metadata.schema_classes.IncidentKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IncidentKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.IncidentKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for an asset Incident</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-29"><em>property</em> id <em>: str</em><a href="#property-id--str-29" class="hash-link" aria-label="Direct link to property-id--str-29" title="Direct link to property-id--str-29"></a></h4><p>A unique id for the incident. Generated on the server side at incident creation time.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IncidentSourceClass"><span class="visually-hidden">IncidentSourceClass</span><a href="#datahub.metadata.schema_classes.IncidentSourceClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IncidentSourceClass" title="Direct link to datahub.metadata.schema_classes.IncidentSourceClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IncidentSourceClass</span>(<span class="arg-name">type</span>, <span class="arg-name">sourceUrn</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.IncidentSourceClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about the source of an incident raised on an asset.</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.IncidentSourceTypeClass"><code>IncidentSourceTypeClass</code></a>]) – </li><li><strong>sourceUrn</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-sourceurn--none--str-2"><em>property</em> sourceUrn <em>: None | str</em><a href="#property-sourceurn--none--str-2" class="hash-link" aria-label="Direct link to property-sourceurn--none--str-2" title="Direct link to property-sourceurn--none--str-2"></a></h4><p>Reference to an URN related to the source of an incident.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--incidentsourcetypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.IncidentSourceTypeClass">IncidentSourceTypeClass</a></em><a href="#property-type--str--incidentsourcetypeclass" class="hash-link" aria-label="Direct link to property-type--str--incidentsourcetypeclass" title="Direct link to property-type--str--incidentsourcetypeclass"></a></h4><p>Message associated with the incident</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IncidentSourceTypeClass"><span class="visually-hidden">IncidentSourceTypeClass</span><a href="#datahub.metadata.schema_classes.IncidentSourceTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IncidentSourceTypeClass" title="Direct link to datahub.metadata.schema_classes.IncidentSourceTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IncidentSourceTypeClass</span>()<a href="#datahub.metadata.schema_classes.IncidentSourceTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="assertion_failure--assertion_failure">ASSERTION_FAILURE <em>= 'ASSERTION_FAILURE'</em><a href="#assertion_failure--assertion_failure" class="hash-link" aria-label="Direct link to assertion_failure--assertion_failure" title="Direct link to assertion_failure--assertion_failure"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="manual--manual">MANUAL <em>= 'MANUAL'</em><a href="#manual--manual" class="hash-link" aria-label="Direct link to manual--manual" title="Direct link to manual--manual"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IncidentStageClass"><span class="visually-hidden">IncidentStageClass</span><a href="#datahub.metadata.schema_classes.IncidentStageClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IncidentStageClass" title="Direct link to datahub.metadata.schema_classes.IncidentStageClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IncidentStageClass</span>()<a href="#datahub.metadata.schema_classes.IncidentStageClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="fixed--fixed">FIXED <em>= 'FIXED'</em><a href="#fixed--fixed" class="hash-link" aria-label="Direct link to fixed--fixed" title="Direct link to fixed--fixed"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="investigation--investigation">INVESTIGATION <em>= 'INVESTIGATION'</em><a href="#investigation--investigation" class="hash-link" aria-label="Direct link to investigation--investigation" title="Direct link to investigation--investigation"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="no_action_required--no_action_required">NO_ACTION_REQUIRED <em>= 'NO_ACTION_REQUIRED'</em><a href="#no_action_required--no_action_required" class="hash-link" aria-label="Direct link to no_action_required--no_action_required" title="Direct link to no_action_required--no_action_required"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="triage--triage">TRIAGE <em>= 'TRIAGE'</em><a href="#triage--triage" class="hash-link" aria-label="Direct link to triage--triage" title="Direct link to triage--triage"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="work_in_progress--work_in_progress">WORK_IN_PROGRESS <em>= 'WORK_IN_PROGRESS'</em><a href="#work_in_progress--work_in_progress" class="hash-link" aria-label="Direct link to work_in_progress--work_in_progress" title="Direct link to work_in_progress--work_in_progress"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IncidentStateClass"><span class="visually-hidden">IncidentStateClass</span><a href="#datahub.metadata.schema_classes.IncidentStateClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IncidentStateClass" title="Direct link to datahub.metadata.schema_classes.IncidentStateClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IncidentStateClass</span>()<a href="#datahub.metadata.schema_classes.IncidentStateClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="active--active-1">ACTIVE <em>= 'ACTIVE'</em><a href="#active--active-1" class="hash-link" aria-label="Direct link to active--active-1" title="Direct link to active--active-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="resolved--resolved">RESOLVED <em>= 'RESOLVED'</em><a href="#resolved--resolved" class="hash-link" aria-label="Direct link to resolved--resolved" title="Direct link to resolved--resolved"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IncidentStatusClass"><span class="visually-hidden">IncidentStatusClass</span><a href="#datahub.metadata.schema_classes.IncidentStatusClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IncidentStatusClass" title="Direct link to datahub.metadata.schema_classes.IncidentStatusClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IncidentStatusClass</span>(<span class="arg-name">state</span>, <span class="arg-name">lastUpdated</span>, <span class="arg-name">stage</span> = <span class="arg-default">None</span>, <span class="arg-name">message</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.IncidentStatusClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Information about an incident raised on an asset</p><ul><li><strong>Parameters:</strong><ul><li><strong>state</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.IncidentStateClass"><code>IncidentStateClass</code></a>]) – </li><li><strong>lastUpdated</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li><li><strong>stage</strong> (<code>Union</code>[<code>None</code>, <code>str</code>, <a href="#datahub.metadata.schema_classes.IncidentStageClass"><code>IncidentStageClass</code></a>]) – </li><li><strong>message</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastupdated--auditstampclass"><em>property</em> lastUpdated <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastupdated--auditstampclass" class="hash-link" aria-label="Direct link to property-lastupdated--auditstampclass" title="Direct link to property-lastupdated--auditstampclass"></a></h4><p>The time at which the request was initially created</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-message--none--str-1"><em>property</em> message <em>: None | str</em><a href="#property-message--none--str-1" class="hash-link" aria-label="Direct link to property-message--none--str-1" title="Direct link to property-message--none--str-1"></a></h4><p>Optional message associated with the incident</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-stage--none--str--incidentstageclass"><em>property</em> stage <em>: None | str | <a href="#datahub.metadata.schema_classes.IncidentStageClass">IncidentStageClass</a></em><a href="#property-stage--none--str--incidentstageclass" class="hash-link" aria-label="Direct link to property-stage--none--str--incidentstageclass" title="Direct link to property-stage--none--str--incidentstageclass"></a></h4><p>The lifecycle stage for the incident - Null means no stage was assigned yet.
|
||
In the future, we may add CUSTOM here with a customStage string field for user-defined stages.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-state--str--incidentstateclass"><em>property</em> state <em>: str | <a href="#datahub.metadata.schema_classes.IncidentStateClass">IncidentStateClass</a></em><a href="#property-state--str--incidentstateclass" class="hash-link" aria-label="Direct link to property-state--str--incidentstateclass" title="Direct link to property-state--str--incidentstateclass"></a></h4><p>The top-level state of the incident, whether it’s active or resolved.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IncidentSummaryDetailsClass"><span class="visually-hidden">IncidentSummaryDetailsClass</span><a href="#datahub.metadata.schema_classes.IncidentSummaryDetailsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IncidentSummaryDetailsClass" title="Direct link to datahub.metadata.schema_classes.IncidentSummaryDetailsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IncidentSummaryDetailsClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">type</span>, <span class="arg-name">createdAt</span>, <span class="arg-name">resolvedAt</span> = <span class="arg-default">None</span>, <span class="arg-name">priority</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.IncidentSummaryDetailsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Summary statistics about incidents on an entity.</p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>type</strong> (<code>str</code>)</li><li><strong>createdAt</strong> (<code>int</code>)</li><li><strong>resolvedAt</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>priority</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-createdat--int-1"><em>property</em> createdAt <em>: int</em><a href="#property-createdat--int-1" class="hash-link" aria-label="Direct link to property-createdat--int-1" title="Direct link to property-createdat--int-1"></a></h4><p>The time at which the incident was raised in milliseconds since epoch.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-priority--none--int"><em>property</em> priority <em>: None | int</em><a href="#property-priority--none--int" class="hash-link" aria-label="Direct link to property-priority--none--int" title="Direct link to property-priority--none--int"></a></h4><p>The priority of the incident</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-resolvedat--none--int"><em>property</em> resolvedAt <em>: None | int</em><a href="#property-resolvedat--none--int" class="hash-link" aria-label="Direct link to property-resolvedat--none--int" title="Direct link to property-resolvedat--none--int"></a></h4><p>The time at which the incident was marked as resolved in milliseconds since epoch. Null if the incident is still active.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str-4"><em>property</em> type <em>: str</em><a href="#property-type--str-4" class="hash-link" aria-label="Direct link to property-type--str-4" title="Direct link to property-type--str-4"></a></h4><p>The type of an incident</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-15"><em>property</em> urn <em>: str</em><a href="#property-urn--str-15" class="hash-link" aria-label="Direct link to property-urn--str-15" title="Direct link to property-urn--str-15"></a></h4><p>The urn of the incident</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IncidentTypeClass"><span class="visually-hidden">IncidentTypeClass</span><a href="#datahub.metadata.schema_classes.IncidentTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IncidentTypeClass" title="Direct link to datahub.metadata.schema_classes.IncidentTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IncidentTypeClass</span>()<a href="#datahub.metadata.schema_classes.IncidentTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>A type of asset incident</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="custom--custom-1">CUSTOM <em>= 'CUSTOM'</em><a href="#custom--custom-1" class="hash-link" aria-label="Direct link to custom--custom-1" title="Direct link to custom--custom-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="data_schema--data_schema-1">DATA_SCHEMA <em>= 'DATA_SCHEMA'</em><a href="#data_schema--data_schema-1" class="hash-link" aria-label="Direct link to data_schema--data_schema-1" title="Direct link to data_schema--data_schema-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="field--field-2">FIELD <em>= 'FIELD'</em><a href="#field--field-2" class="hash-link" aria-label="Direct link to field--field-2" title="Direct link to field--field-2"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="freshness--freshness-1">FRESHNESS <em>= 'FRESHNESS'</em><a href="#freshness--freshness-1" class="hash-link" aria-label="Direct link to freshness--freshness-1" title="Direct link to freshness--freshness-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="operational--operational">OPERATIONAL <em>= 'OPERATIONAL'</em><a href="#operational--operational" class="hash-link" aria-label="Direct link to operational--operational" title="Direct link to operational--operational"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sql--sql-4">SQL <em>= 'SQL'</em><a href="#sql--sql-4" class="hash-link" aria-label="Direct link to sql--sql-4" title="Direct link to sql--sql-4"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="volume--volume-1">VOLUME <em>= 'VOLUME'</em><a href="#volume--volume-1" class="hash-link" aria-label="Direct link to volume--volume-1" title="Direct link to volume--volume-1"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IncidentsSummaryClass"><span class="visually-hidden">IncidentsSummaryClass</span><a href="#datahub.metadata.schema_classes.IncidentsSummaryClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IncidentsSummaryClass" title="Direct link to datahub.metadata.schema_classes.IncidentsSummaryClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IncidentsSummaryClass</span>(<span class="arg-name">resolvedIncidents</span> = <span class="arg-default">None</span>, <span class="arg-name">activeIncidents</span> = <span class="arg-default">None</span>, <span class="arg-name">resolvedIncidentDetails</span> = <span class="arg-default">None</span>, <span class="arg-name">activeIncidentDetails</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.IncidentsSummaryClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Summary related incidents on an entity.</p><ul><li><strong>Parameters:</strong><ul><li><strong>resolvedIncidents</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>activeIncidents</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>resolvedIncidentDetails</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.IncidentSummaryDetailsClass"><code>IncidentSummaryDetailsClass</code></a>]]) – </li><li><strong>activeIncidentDetails</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.IncidentSummaryDetailsClass"><code>IncidentSummaryDetailsClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-activeincidentdetails--listincidentsummarydetailsclass"><em>property</em> activeIncidentDetails <em>: List[<a href="#datahub.metadata.schema_classes.IncidentSummaryDetailsClass">IncidentSummaryDetailsClass</a>]</em><a href="#property-activeincidentdetails--listincidentsummarydetailsclass" class="hash-link" aria-label="Direct link to property-activeincidentdetails--listincidentsummarydetailsclass" title="Direct link to property-activeincidentdetails--listincidentsummarydetailsclass"></a></h4><p>Summary details about the set of active incidents</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-activeincidents--liststr"><em>property</em> activeIncidents <em>: List<!-- -->[str]</em><a href="#property-activeincidents--liststr" class="hash-link" aria-label="Direct link to property-activeincidents--liststr" title="Direct link to property-activeincidents--liststr"></a></h4><p>Active incidents for an asset
|
||
Deprecated! Use the richer activeIncidentsDetails instead.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-resolvedincidentdetails--listincidentsummarydetailsclass"><em>property</em> resolvedIncidentDetails <em>: List[<a href="#datahub.metadata.schema_classes.IncidentSummaryDetailsClass">IncidentSummaryDetailsClass</a>]</em><a href="#property-resolvedincidentdetails--listincidentsummarydetailsclass" class="hash-link" aria-label="Direct link to property-resolvedincidentdetails--listincidentsummarydetailsclass" title="Direct link to property-resolvedincidentdetails--listincidentsummarydetailsclass"></a></h4><p>Summary details about the set of resolved incidents</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-resolvedincidents--liststr"><em>property</em> resolvedIncidents <em>: List<!-- -->[str]</em><a href="#property-resolvedincidents--liststr" class="hash-link" aria-label="Direct link to property-resolvedincidents--liststr" title="Direct link to property-resolvedincidents--liststr"></a></h4><p>Resolved incidents for an asset
|
||
Deprecated! Use the richer resolvedIncidentsDetails instead.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerClass"><span class="visually-hidden">IncrementingSegmentFieldTransformerClass</span><a href="#datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerClass" title="Direct link to datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IncrementingSegmentFieldTransformerClass</span>(<span class="arg-name">type</span>, <span class="arg-name">nativeType</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>The definition of the transformer function that should be applied to a given field / column value in a dataset
|
||
in order to determine the segment or bucket that it belongs to, which in turn is used to evaluate
|
||
volume assertions.</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerTypeClass"><code>IncrementingSegmentFieldTransformerTypeClass</code></a>]) – </li><li><strong>nativeType</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-nativetype--none--str-1"><em>property</em> nativeType <em>: None | str</em><a href="#property-nativetype--none--str-1" class="hash-link" aria-label="Direct link to property-nativetype--none--str-1" title="Direct link to property-nativetype--none--str-1"></a></h4><p>The ‘native’ transformer type, useful as a back door if a custom operator is required.
|
||
This field is required if the type is NATIVE.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--incrementingsegmentfieldtransformertypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerTypeClass">IncrementingSegmentFieldTransformerTypeClass</a></em><a href="#property-type--str--incrementingsegmentfieldtransformertypeclass" class="hash-link" aria-label="Direct link to property-type--str--incrementingsegmentfieldtransformertypeclass" title="Direct link to property-type--str--incrementingsegmentfieldtransformertypeclass"></a></h4><p>A ‘standard’ transformer type. Note that not all source systems will support all operators.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerTypeClass"><span class="visually-hidden">IncrementingSegmentFieldTransformerTypeClass</span><a href="#datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerTypeClass" title="Direct link to datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IncrementingSegmentFieldTransformerTypeClass</span>()<a href="#datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="ceiling--ceiling">CEILING <em>= 'CEILING'</em><a href="#ceiling--ceiling" class="hash-link" aria-label="Direct link to ceiling--ceiling" title="Direct link to ceiling--ceiling"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="floor--floor">FLOOR <em>= 'FLOOR'</em><a href="#floor--floor" class="hash-link" aria-label="Direct link to floor--floor" title="Direct link to floor--floor"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="native--native-1">NATIVE <em>= 'NATIVE'</em><a href="#native--native-1" class="hash-link" aria-label="Direct link to native--native-1" title="Direct link to native--native-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="timestamp_ms_to_date--timestamp_ms_to_date">TIMESTAMP_MS_TO_DATE <em>= 'TIMESTAMP_MS_TO_DATE'</em><a href="#timestamp_ms_to_date--timestamp_ms_to_date" class="hash-link" aria-label="Direct link to timestamp_ms_to_date--timestamp_ms_to_date" title="Direct link to timestamp_ms_to_date--timestamp_ms_to_date"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="timestamp_ms_to_hour--timestamp_ms_to_hour">TIMESTAMP_MS_TO_HOUR <em>= 'TIMESTAMP_MS_TO_HOUR'</em><a href="#timestamp_ms_to_hour--timestamp_ms_to_hour" class="hash-link" aria-label="Direct link to timestamp_ms_to_hour--timestamp_ms_to_hour" title="Direct link to timestamp_ms_to_hour--timestamp_ms_to_hour"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="timestamp_ms_to_minute--timestamp_ms_to_minute">TIMESTAMP_MS_TO_MINUTE <em>= 'TIMESTAMP_MS_TO_MINUTE'</em><a href="#timestamp_ms_to_minute--timestamp_ms_to_minute" class="hash-link" aria-label="Direct link to timestamp_ms_to_minute--timestamp_ms_to_minute" title="Direct link to timestamp_ms_to_minute--timestamp_ms_to_minute"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="timestamp_ms_to_month--timestamp_ms_to_month">TIMESTAMP_MS_TO_MONTH <em>= 'TIMESTAMP_MS_TO_MONTH'</em><a href="#timestamp_ms_to_month--timestamp_ms_to_month" class="hash-link" aria-label="Direct link to timestamp_ms_to_month--timestamp_ms_to_month" title="Direct link to timestamp_ms_to_month--timestamp_ms_to_month"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="timestamp_ms_to_year--timestamp_ms_to_year">TIMESTAMP_MS_TO_YEAR <em>= 'TIMESTAMP_MS_TO_YEAR'</em><a href="#timestamp_ms_to_year--timestamp_ms_to_year" class="hash-link" aria-label="Direct link to timestamp_ms_to_year--timestamp_ms_to_year" title="Direct link to timestamp_ms_to_year--timestamp_ms_to_year"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IncrementingSegmentRowCountChangeClass"><span class="visually-hidden">IncrementingSegmentRowCountChangeClass</span><a href="#datahub.metadata.schema_classes.IncrementingSegmentRowCountChangeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IncrementingSegmentRowCountChangeClass" title="Direct link to datahub.metadata.schema_classes.IncrementingSegmentRowCountChangeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IncrementingSegmentRowCountChangeClass</span>(<span class="arg-name">segment</span>, <span class="arg-name">type</span>, <span class="arg-name">operator</span>, <span class="arg-name">parameters</span>)<a href="#datahub.metadata.schema_classes.IncrementingSegmentRowCountChangeClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Attributes defining an INCREMENTING_SEGMENT_ROW_COUNT_CHANGE volume assertion.</p><ul><li><strong>Parameters:</strong><ul><li><strong>segment</strong> (<a href="#datahub.metadata.schema_classes.IncrementingSegmentSpecClass"><code>IncrementingSegmentSpecClass</code></a>) – </li><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.AssertionValueChangeTypeClass"><code>AssertionValueChangeTypeClass</code></a>]) – </li><li><strong>operator</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.AssertionStdOperatorClass"><code>AssertionStdOperatorClass</code></a>]) – </li><li><strong>parameters</strong> (<a href="#datahub.metadata.schema_classes.AssertionStdParametersClass"><code>AssertionStdParametersClass</code></a>) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-operator--str--assertionstdoperatorclass-3"><em>property</em> operator <em>: str | <a href="#datahub.metadata.schema_classes.AssertionStdOperatorClass">AssertionStdOperatorClass</a></em><a href="#property-operator--str--assertionstdoperatorclass-3" class="hash-link" aria-label="Direct link to property-operator--str--assertionstdoperatorclass-3" title="Direct link to property-operator--str--assertionstdoperatorclass-3"></a></h4><p>The operator you’d like to apply to the row count value</p><p>Note that only numeric operators are valid inputs:
|
||
GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO,
|
||
BETWEEN.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-parameters--assertionstdparametersclass"><em>property</em> parameters <em>: <a href="#datahub.metadata.schema_classes.AssertionStdParametersClass">AssertionStdParametersClass</a></em><a href="#property-parameters--assertionstdparametersclass" class="hash-link" aria-label="Direct link to property-parameters--assertionstdparametersclass" title="Direct link to property-parameters--assertionstdparametersclass"></a></h4><p>The parameters you’d like to provide as input to the operator.</p><p>Note that only numeric parameter types are valid inputs: NUMBER.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-segment--incrementingsegmentspecclass"><em>property</em> segment <em>: <a href="#datahub.metadata.schema_classes.IncrementingSegmentSpecClass">IncrementingSegmentSpecClass</a></em><a href="#property-segment--incrementingsegmentspecclass" class="hash-link" aria-label="Direct link to property-segment--incrementingsegmentspecclass" title="Direct link to property-segment--incrementingsegmentspecclass"></a></h4><p>A specification of how the ‘segment’ can be derived using a column and an optional transformer function.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--assertionvaluechangetypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.AssertionValueChangeTypeClass">AssertionValueChangeTypeClass</a></em><a href="#property-type--str--assertionvaluechangetypeclass" class="hash-link" aria-label="Direct link to property-type--str--assertionvaluechangetypeclass" title="Direct link to property-type--str--assertionvaluechangetypeclass"></a></h4><p>a fixed absolute value or a relative percentage.</p><ul><li><strong>Type:</strong>
|
||
The type of the value used to evaluate the assertion</li></ul></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IncrementingSegmentRowCountTotalClass"><span class="visually-hidden">IncrementingSegmentRowCountTotalClass</span><a href="#datahub.metadata.schema_classes.IncrementingSegmentRowCountTotalClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IncrementingSegmentRowCountTotalClass" title="Direct link to datahub.metadata.schema_classes.IncrementingSegmentRowCountTotalClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IncrementingSegmentRowCountTotalClass</span>(<span class="arg-name">segment</span>, <span class="arg-name">operator</span>, <span class="arg-name">parameters</span>)<a href="#datahub.metadata.schema_classes.IncrementingSegmentRowCountTotalClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Attributes defining an INCREMENTING_SEGMENT_ROW_COUNT_TOTAL volume assertion.</p><ul><li><strong>Parameters:</strong><ul><li><strong>segment</strong> (<a href="#datahub.metadata.schema_classes.IncrementingSegmentSpecClass"><code>IncrementingSegmentSpecClass</code></a>) – </li><li><strong>operator</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.AssertionStdOperatorClass"><code>AssertionStdOperatorClass</code></a>]) – </li><li><strong>parameters</strong> (<a href="#datahub.metadata.schema_classes.AssertionStdParametersClass"><code>AssertionStdParametersClass</code></a>) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-operator--str--assertionstdoperatorclass-4"><em>property</em> operator <em>: str | <a href="#datahub.metadata.schema_classes.AssertionStdOperatorClass">AssertionStdOperatorClass</a></em><a href="#property-operator--str--assertionstdoperatorclass-4" class="hash-link" aria-label="Direct link to property-operator--str--assertionstdoperatorclass-4" title="Direct link to property-operator--str--assertionstdoperatorclass-4"></a></h4><p>The operator you’d like to apply.</p><p>Note that only numeric operators are valid inputs:
|
||
GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO,
|
||
BETWEEN.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-parameters--assertionstdparametersclass-1"><em>property</em> parameters <em>: <a href="#datahub.metadata.schema_classes.AssertionStdParametersClass">AssertionStdParametersClass</a></em><a href="#property-parameters--assertionstdparametersclass-1" class="hash-link" aria-label="Direct link to property-parameters--assertionstdparametersclass-1" title="Direct link to property-parameters--assertionstdparametersclass-1"></a></h4><p>The parameters you’d like to provide as input to the operator.</p><p>Note that only numeric parameter types are valid inputs: NUMBER.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-segment--incrementingsegmentspecclass-1"><em>property</em> segment <em>: <a href="#datahub.metadata.schema_classes.IncrementingSegmentSpecClass">IncrementingSegmentSpecClass</a></em><a href="#property-segment--incrementingsegmentspecclass-1" class="hash-link" aria-label="Direct link to property-segment--incrementingsegmentspecclass-1" title="Direct link to property-segment--incrementingsegmentspecclass-1"></a></h4><p>A specification of how the ‘segment’ can be derived using a column and an optional transformer function.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IncrementingSegmentSpecClass"><span class="visually-hidden">IncrementingSegmentSpecClass</span><a href="#datahub.metadata.schema_classes.IncrementingSegmentSpecClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IncrementingSegmentSpecClass" title="Direct link to datahub.metadata.schema_classes.IncrementingSegmentSpecClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IncrementingSegmentSpecClass</span>(<span class="arg-name">field</span>, <span class="arg-name">transformer</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.IncrementingSegmentSpecClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Core attributes required to identify an incrementing segment in a table. This type is mainly useful
|
||
for tables that constantly increase with new rows being added on a particular cadence (e.g. fact or event tables)</p><p>An incrementing segment represents a logical chunk of data which is INSERTED
|
||
into a dataset on a regular interval, along with the presence of a constantly-incrementing column
|
||
value such as an event time, date partition, or last modified column.</p><p>An incrementing segment is principally identified by 2 key attributes combined:</p><blockquote><ol><li>A field or column that represents the incrementing value. New rows that are inserted will be identified using this column.
|
||
Note that the value of this column may not by itself represent the “bucket” or the “segment” in which the row falls.</li><li>[Optional]<!-- --> An transformer function that may be applied to the selected column value in order
|
||
to obtain the final “segment identifier” or “bucket identifier”. Rows that have the same value after applying the transformation
|
||
will be grouped into the same segment, using which the final value (e.g. row count) will be determined.</li></ol><ul><li><strong>Parameters:</strong><ul><li><strong>field</strong> (<a href="#datahub.metadata.schema_classes.SchemaFieldSpecClass"><code>SchemaFieldSpecClass</code></a>) – </li><li><strong>transformer</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerClass"><code>IncrementingSegmentFieldTransformerClass</code></a>]) – </li></ul></li></ul></blockquote><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-field--schemafieldspecclass-2"><em>property</em> field <em>: <a href="#datahub.metadata.schema_classes.SchemaFieldSpecClass">SchemaFieldSpecClass</a></em><a href="#property-field--schemafieldspecclass-2" class="hash-link" aria-label="Direct link to property-field--schemafieldspecclass-2" title="Direct link to property-field--schemafieldspecclass-2"></a></h4><p>The field to use to generate segments. It must be constantly incrementing as new rows are inserted.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-transformer--none--incrementingsegmentfieldtransformerclass"><em>property</em> transformer <em>: None | <a href="#datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerClass">IncrementingSegmentFieldTransformerClass</a></em><a href="#property-transformer--none--incrementingsegmentfieldtransformerclass" class="hash-link" aria-label="Direct link to property-transformer--none--incrementingsegmentfieldtransformerclass" title="Direct link to property-transformer--none--incrementingsegmentfieldtransformerclass"></a></h4><p>Optional transformer function to apply to the field in order to obtain the final segment or bucket identifier.
|
||
If not provided, then no operator will be applied to the field. (identity function)</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IngestionCheckpointStateClass"><span class="visually-hidden">IngestionCheckpointStateClass</span><a href="#datahub.metadata.schema_classes.IngestionCheckpointStateClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IngestionCheckpointStateClass" title="Direct link to datahub.metadata.schema_classes.IngestionCheckpointStateClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IngestionCheckpointStateClass</span>(<span class="arg-name">formatVersion</span>, <span class="arg-name">serde</span>, <span class="arg-name">payload</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.IngestionCheckpointStateClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>The checkpoint state object of a datahub ingestion run for a given job.</p><ul><li><strong>Parameters:</strong><ul><li><strong>formatVersion</strong> (<code>str</code>)</li><li><strong>serde</strong> (<code>str</code>)</li><li><strong>payload</strong> (<code>Optional</code>[<code>bytes</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-formatversion--str"><em>property</em> formatVersion <em>: str</em><a href="#property-formatversion--str" class="hash-link" aria-label="Direct link to property-formatversion--str" title="Direct link to property-formatversion--str"></a></h4><p>The version of the state format.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-payload--none--bytes"><em>property</em> payload <em>: None | bytes</em><a href="#property-payload--none--bytes" class="hash-link" aria-label="Direct link to property-payload--none--bytes" title="Direct link to property-payload--none--bytes"></a></h4><p>Opaque blob of the state representation.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-serde--str"><em>property</em> serde <em>: str</em><a href="#property-serde--str" class="hash-link" aria-label="Direct link to property-serde--str" title="Direct link to property-serde--str"></a></h4><p>The serialization/deserialization protocol.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.InputFieldClass"><span class="visually-hidden">InputFieldClass</span><a href="#datahub.metadata.schema_classes.InputFieldClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.InputFieldClass" title="Direct link to datahub.metadata.schema_classes.InputFieldClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">InputFieldClass</span>(<span class="arg-name">schemaFieldUrn</span>, <span class="arg-name">schemaField</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.InputFieldClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Information about a field a chart or dashboard references</p><ul><li><strong>Parameters:</strong><ul><li><strong>schemaFieldUrn</strong> (<code>str</code>)</li><li><strong>schemaField</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.SchemaFieldClass"><code>SchemaFieldClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-schemafield--none--schemafieldclass"><em>property</em> schemaField <em>: None | <a href="#datahub.metadata.schema_classes.SchemaFieldClass">SchemaFieldClass</a></em><a href="#property-schemafield--none--schemafieldclass" class="hash-link" aria-label="Direct link to property-schemafield--none--schemafieldclass" title="Direct link to property-schemafield--none--schemafieldclass"></a></h4><p>Copied version of the referenced schema field object for indexing purposes</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-schemafieldurn--str"><em>property</em> schemaFieldUrn <em>: str</em><a href="#property-schemafieldurn--str" class="hash-link" aria-label="Direct link to property-schemafieldurn--str" title="Direct link to property-schemafieldurn--str"></a></h4><p>Urn of the schema being referenced for lineage purposes</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.InputFieldsClass"><span class="visually-hidden">InputFieldsClass</span><a href="#datahub.metadata.schema_classes.InputFieldsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.InputFieldsClass" title="Direct link to datahub.metadata.schema_classes.InputFieldsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">InputFieldsClass</span>(<span class="arg-name">fields</span>)<a href="#datahub.metadata.schema_classes.InputFieldsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about the fields a chart or dashboard references</p><ul><li><strong>Parameters:</strong><strong>fields</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.InputFieldClass"><code>InputFieldClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fields--listinputfieldclass"><em>property</em> fields <em>: List[<a href="#datahub.metadata.schema_classes.InputFieldClass">InputFieldClass</a>]</em><a href="#property-fields--listinputfieldclass" class="hash-link" aria-label="Direct link to property-fields--listinputfieldclass" title="Direct link to property-fields--listinputfieldclass"></a></h4><p>List of fields being referenced</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.InstitutionalMemoryClass"><span class="visually-hidden">InstitutionalMemoryClass</span><a href="#datahub.metadata.schema_classes.InstitutionalMemoryClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.InstitutionalMemoryClass" title="Direct link to datahub.metadata.schema_classes.InstitutionalMemoryClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">InstitutionalMemoryClass</span>(<span class="arg-name">elements</span>)<a href="#datahub.metadata.schema_classes.InstitutionalMemoryClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Institutional memory of an entity. This is a way to link to relevant documentation and provide description of the documentation. Institutional or tribal knowledge is very important for users to leverage the entity.</p><ul><li><strong>Parameters:</strong><strong>elements</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass"><code>InstitutionalMemoryMetadataClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-elements--listinstitutionalmemorymetadataclass"><em>property</em> elements <em>: List[<a href="#datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass">InstitutionalMemoryMetadataClass</a>]</em><a href="#property-elements--listinstitutionalmemorymetadataclass" class="hash-link" aria-label="Direct link to property-elements--listinstitutionalmemorymetadataclass" title="Direct link to property-elements--listinstitutionalmemorymetadataclass"></a></h4><p>List of records that represent institutional memory of an entity. Each record consists of a link, description, creator and timestamps associated with that record.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass"><span class="visually-hidden">InstitutionalMemoryMetadataClass</span><a href="#datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass" title="Direct link to datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">InstitutionalMemoryMetadataClass</span>(<span class="arg-name">url</span>, <span class="arg-name">description</span>, <span class="arg-name">createStamp</span>)<a href="#datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Metadata corresponding to a record of institutional memory.</p><ul><li><strong>Parameters:</strong><ul><li><strong>url</strong> (<code>str</code>)</li><li><strong>description</strong> (<code>str</code>)</li><li><strong>createStamp</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-createstamp--auditstampclass"><em>property</em> createStamp <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-createstamp--auditstampclass" class="hash-link" aria-label="Direct link to property-createstamp--auditstampclass" title="Direct link to property-createstamp--auditstampclass"></a></h4><p>Audit stamp associated with creation of this record</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--str-4"><em>property</em> description <em>: str</em><a href="#property-description--str-4" class="hash-link" aria-label="Direct link to property-description--str-4" title="Direct link to property-description--str-4"></a></h4><p>Description of the link.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-url--str"><em>property</em> url <em>: str</em><a href="#property-url--str" class="hash-link" aria-label="Direct link to property-url--str" title="Direct link to property-url--str"></a></h4><p>Link to an engineering design document or a wiki page.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IntendedUseClass"><span class="visually-hidden">IntendedUseClass</span><a href="#datahub.metadata.schema_classes.IntendedUseClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IntendedUseClass" title="Direct link to datahub.metadata.schema_classes.IntendedUseClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IntendedUseClass</span>(<span class="arg-name">primaryUses</span> = <span class="arg-default">None</span>, <span class="arg-name">primaryUsers</span> = <span class="arg-default">None</span>, <span class="arg-name">outOfScopeUses</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.IntendedUseClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Intended Use for the ML Model</p><ul><li><strong>Parameters:</strong><ul><li><strong>primaryUses</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>primaryUsers</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.IntendedUserTypeClass"><code>IntendedUserTypeClass</code></a>]]]) – </li><li><strong>outOfScopeUses</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-outofscopeuses--none--liststr"><em>property</em> outOfScopeUses <em>: None | List<!-- -->[str]</em><a href="#property-outofscopeuses--none--liststr" class="hash-link" aria-label="Direct link to property-outofscopeuses--none--liststr" title="Direct link to property-outofscopeuses--none--liststr"></a></h4><p>Highlight technology that the MLModel might easily be confused with, or related contexts that users could try to apply the MLModel to.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-primaryusers--none--liststr--intendedusertypeclass"><em>property</em> primaryUsers <em>: None | List[str | <a href="#datahub.metadata.schema_classes.IntendedUserTypeClass">IntendedUserTypeClass</a>]</em><a href="#property-primaryusers--none--liststr--intendedusertypeclass" class="hash-link" aria-label="Direct link to property-primaryusers--none--liststr--intendedusertypeclass" title="Direct link to property-primaryusers--none--liststr--intendedusertypeclass"></a></h4><p>Primary Intended Users - For example, was the MLModel developed for entertainment purposes, for hobbyists, or enterprise solutions?</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-primaryuses--none--liststr"><em>property</em> primaryUses <em>: None | List<!-- -->[str]</em><a href="#property-primaryuses--none--liststr" class="hash-link" aria-label="Direct link to property-primaryuses--none--liststr" title="Direct link to property-primaryuses--none--liststr"></a></h4><p>Primary Use cases for the MLModel.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.IntendedUserTypeClass"><span class="visually-hidden">IntendedUserTypeClass</span><a href="#datahub.metadata.schema_classes.IntendedUserTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.IntendedUserTypeClass" title="Direct link to datahub.metadata.schema_classes.IntendedUserTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">IntendedUserTypeClass</span>()<a href="#datahub.metadata.schema_classes.IntendedUserTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="enterprise--enterprise">ENTERPRISE <em>= 'ENTERPRISE'</em><a href="#enterprise--enterprise" class="hash-link" aria-label="Direct link to enterprise--enterprise" title="Direct link to enterprise--enterprise"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="entertainment--entertainment">ENTERTAINMENT <em>= 'ENTERTAINMENT'</em><a href="#entertainment--entertainment" class="hash-link" aria-label="Direct link to entertainment--entertainment" title="Direct link to entertainment--entertainment"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="hobby--hobby">HOBBY <em>= 'HOBBY'</em><a href="#hobby--hobby" class="hash-link" aria-label="Direct link to hobby--hobby" title="Direct link to hobby--hobby"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.InviteTokenClass"><span class="visually-hidden">InviteTokenClass</span><a href="#datahub.metadata.schema_classes.InviteTokenClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.InviteTokenClass" title="Direct link to datahub.metadata.schema_classes.InviteTokenClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">InviteTokenClass</span>(<span class="arg-name">token</span>, <span class="arg-name">role</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.InviteTokenClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Aspect used to store invite tokens.</p><ul><li><strong>Parameters:</strong><ul><li><strong>token</strong> (<code>str</code>)</li><li><strong>role</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-role--none--str-1"><em>property</em> role <em>: None | str</em><a href="#property-role--none--str-1" class="hash-link" aria-label="Direct link to property-role--none--str-1" title="Direct link to property-role--none--str-1"></a></h4><p>The role that this invite token may be associated with</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-token--str"><em>property</em> token <em>: str</em><a href="#property-token--str" class="hash-link" aria-label="Direct link to property-token--str" title="Direct link to property-token--str"></a></h4><p>The encrypted invite token.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.InviteTokenKeyClass"><span class="visually-hidden">InviteTokenKeyClass</span><a href="#datahub.metadata.schema_classes.InviteTokenKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.InviteTokenKeyClass" title="Direct link to datahub.metadata.schema_classes.InviteTokenKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">InviteTokenKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.InviteTokenKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for an InviteToken.</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-30"><em>property</em> id <em>: str</em><a href="#property-id--str-30" class="hash-link" aria-label="Direct link to property-id--str-30" title="Direct link to property-id--str-30"></a></h4><p>A unique id for the invite token.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.JobStatusClass"><span class="visually-hidden">JobStatusClass</span><a href="#datahub.metadata.schema_classes.JobStatusClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.JobStatusClass" title="Direct link to datahub.metadata.schema_classes.JobStatusClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">JobStatusClass</span>()<a href="#datahub.metadata.schema_classes.JobStatusClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>Job statuses</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="completed--completed">COMPLETED <em>= 'COMPLETED'</em><a href="#completed--completed" class="hash-link" aria-label="Direct link to completed--completed" title="Direct link to completed--completed"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="failed--failed-2">FAILED <em>= 'FAILED'</em><a href="#failed--failed-2" class="hash-link" aria-label="Direct link to failed--failed-2" title="Direct link to failed--failed-2"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="in_progress--in_progress-1">IN_PROGRESS <em>= 'IN_PROGRESS'</em><a href="#in_progress--in_progress-1" class="hash-link" aria-label="Direct link to in_progress--in_progress-1" title="Direct link to in_progress--in_progress-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="skipped--skipped">SKIPPED <em>= 'SKIPPED'</em><a href="#skipped--skipped" class="hash-link" aria-label="Direct link to skipped--skipped" title="Direct link to skipped--skipped"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="starting--starting">STARTING <em>= 'STARTING'</em><a href="#starting--starting" class="hash-link" aria-label="Direct link to starting--starting" title="Direct link to starting--starting"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="stopped--stopped">STOPPED <em>= 'STOPPED'</em><a href="#stopped--stopped" class="hash-link" aria-label="Direct link to stopped--stopped" title="Direct link to stopped--stopped"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="stopping--stopping">STOPPING <em>= 'STOPPING'</em><a href="#stopping--stopping" class="hash-link" aria-label="Direct link to stopping--stopping" title="Direct link to stopping--stopping"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="unknown--unknown-3">UNKNOWN <em>= 'UNKNOWN'</em><a href="#unknown--unknown-3" class="hash-link" aria-label="Direct link to unknown--unknown-3" title="Direct link to unknown--unknown-3"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.KafkaAuditHeaderClass"><span class="visually-hidden">KafkaAuditHeaderClass</span><a href="#datahub.metadata.schema_classes.KafkaAuditHeaderClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.KafkaAuditHeaderClass" title="Direct link to datahub.metadata.schema_classes.KafkaAuditHeaderClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">KafkaAuditHeaderClass</span>(<span class="arg-name">time</span>, <span class="arg-name">server</span>, <span class="arg-name">appName</span>, <span class="arg-name">messageId</span>, <span class="arg-name">instance</span> = <span class="arg-default">None</span>, <span class="arg-name">auditVersion</span> = <span class="arg-default">None</span>, <span class="arg-name">fabricUrn</span> = <span class="arg-default">None</span>, <span class="arg-name">clusterConnectionString</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.KafkaAuditHeaderClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>This header records information about the context of an event as it is emitted into kafka and is intended to be used by the kafka audit application. For more information see go/kafkaauditheader</p><ul><li><strong>Parameters:</strong><ul><li><strong>time</strong> (<code>int</code>)</li><li><strong>server</strong> (<code>str</code>)</li><li><strong>appName</strong> (<code>str</code>)</li><li><strong>messageId</strong> (<code>bytes</code>)</li><li><strong>instance</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>auditVersion</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>fabricUrn</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>clusterConnectionString</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-appname--str"><em>property</em> appName <em>: str</em><a href="#property-appname--str" class="hash-link" aria-label="Direct link to property-appname--str" title="Direct link to property-appname--str"></a></h4><p>The name of the application from which the event is being emitted. see go/appname</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-auditversion--none--int"><em>property</em> auditVersion <em>: None | int</em><a href="#property-auditversion--none--int" class="hash-link" aria-label="Direct link to property-auditversion--none--int" title="Direct link to property-auditversion--none--int"></a></h4><p>if the schema has an outer KafkaAuditHeader, use the outer audit header timestamp for bucketing; else if the EventHeader has an inner KafkaAuditHeader use that inner audit header’s timestamp for bucketing</p><ul><li><strong>Type:</strong>
|
||
The version that is being used for auditing. In version 0, the audit trail buckets events into 10 minute audit windows based on the EventHeader timestamp. In version 1, the audit trail buckets events as follows</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-clusterconnectionstring--none--str"><em>property</em> clusterConnectionString <em>: None | str</em><a href="#property-clusterconnectionstring--none--str" class="hash-link" aria-label="Direct link to property-clusterconnectionstring--none--str" title="Direct link to property-clusterconnectionstring--none--str"></a></h4><p>This is a String that the client uses to establish some kind of connection with the Kafka cluster. The exact format of it depends on specific versions of clients and brokers. This information could potentially identify the fabric and cluster with which the client is producing to or consuming from.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fabricurn--none--str"><em>property</em> fabricUrn <em>: None | str</em><a href="#property-fabricurn--none--str" class="hash-link" aria-label="Direct link to property-fabricurn--none--str" title="Direct link to property-fabricurn--none--str"></a></h4><p>fabric:{fabric_name}. See go/fabric.</p><ul><li><strong>Type:</strong>
|
||
The fabricUrn of the host from which the event is being emitted. Fabric Urn in the format of urn</li><li><strong>Type:</strong>
|
||
li</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-instance--none--str-1"><em>property</em> instance <em>: None | str</em><a href="#property-instance--none--str-1" class="hash-link" aria-label="Direct link to property-instance--none--str-1" title="Direct link to property-instance--none--str-1"></a></h4><p>The instance on the server from which the event is being emitted. e.g. i001</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-messageid--bytes"><em>property</em> messageId <em>: bytes</em><a href="#property-messageid--bytes" class="hash-link" aria-label="Direct link to property-messageid--bytes" title="Direct link to property-messageid--bytes"></a></h4><p>A unique identifier for the message</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-server--str"><em>property</em> server <em>: str</em><a href="#property-server--str" class="hash-link" aria-label="Direct link to property-server--str" title="Direct link to property-server--str"></a></h4><p>The fully qualified name of the host from which the event is being emitted.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-time--int-1"><em>property</em> time <em>: int</em><a href="#property-time--int-1" class="hash-link" aria-label="Direct link to property-time--int-1" title="Direct link to property-time--int-1"></a></h4><p>The time at which the event was emitted into kafka.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.KafkaSchemaClass"><span class="visually-hidden">KafkaSchemaClass</span><a href="#datahub.metadata.schema_classes.KafkaSchemaClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.KafkaSchemaClass" title="Direct link to datahub.metadata.schema_classes.KafkaSchemaClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">KafkaSchemaClass</span>(<span class="arg-name">documentSchema</span>, <span class="arg-name">documentSchemaType</span> = <span class="arg-default">None</span>, <span class="arg-name">keySchema</span> = <span class="arg-default">None</span>, <span class="arg-name">keySchemaType</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.KafkaSchemaClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Schema holder for kafka schema.</p><ul><li><strong>Parameters:</strong><ul><li><strong>documentSchema</strong> (<code>str</code>)</li><li><strong>documentSchemaType</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>keySchema</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>keySchemaType</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-documentschema--str-1"><em>property</em> documentSchema <em>: str</em><a href="#property-documentschema--str-1" class="hash-link" aria-label="Direct link to property-documentschema--str-1" title="Direct link to property-documentschema--str-1"></a></h4><p>The native kafka document schema. This is a human readable avro document schema.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-documentschematype--none--str"><em>property</em> documentSchemaType <em>: None | str</em><a href="#property-documentschematype--none--str" class="hash-link" aria-label="Direct link to property-documentschematype--none--str" title="Direct link to property-documentschematype--none--str"></a></h4><p>The native kafka document schema type. This can be AVRO/PROTOBUF/JSON.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-keyschema--none--str"><em>property</em> keySchema <em>: None | str</em><a href="#property-keyschema--none--str" class="hash-link" aria-label="Direct link to property-keyschema--none--str" title="Direct link to property-keyschema--none--str"></a></h4><p>The native kafka key schema as retrieved from Schema Registry</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-keyschematype--none--str"><em>property</em> keySchemaType <em>: None | str</em><a href="#property-keyschematype--none--str" class="hash-link" aria-label="Direct link to property-keyschematype--none--str" title="Direct link to property-keyschematype--none--str"></a></h4><p>The native kafka key schema type. This can be AVRO/PROTOBUF/JSON.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.KeyValueSchemaClass"><span class="visually-hidden">KeyValueSchemaClass</span><a href="#datahub.metadata.schema_classes.KeyValueSchemaClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.KeyValueSchemaClass" title="Direct link to datahub.metadata.schema_classes.KeyValueSchemaClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">KeyValueSchemaClass</span>(<span class="arg-name">keySchema</span>, <span class="arg-name">valueSchema</span>)<a href="#datahub.metadata.schema_classes.KeyValueSchemaClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Schema text of a key-value store schema.</p><ul><li><strong>Parameters:</strong><ul><li><strong>keySchema</strong> (<code>str</code>)</li><li><strong>valueSchema</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-keyschema--str"><em>property</em> keySchema <em>: str</em><a href="#property-keyschema--str" class="hash-link" aria-label="Direct link to property-keyschema--str" title="Direct link to property-keyschema--str"></a></h4><p>The raw schema for the key in the key-value store.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-valueschema--str"><em>property</em> valueSchema <em>: str</em><a href="#property-valueschema--str" class="hash-link" aria-label="Direct link to property-valueschema--str" title="Direct link to property-valueschema--str"></a></h4><p>The raw schema for the value in the key-value store.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.LinkModuleParamsClass"><span class="visually-hidden">LinkModuleParamsClass</span><a href="#datahub.metadata.schema_classes.LinkModuleParamsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.LinkModuleParamsClass" title="Direct link to datahub.metadata.schema_classes.LinkModuleParamsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">LinkModuleParamsClass</span>(<span class="arg-name">linkUrn</span>)<a href="#datahub.metadata.schema_classes.LinkModuleParamsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><strong>linkUrn</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-linkurn--str"><em>property</em> linkUrn <em>: str</em><a href="#property-linkurn--str" class="hash-link" aria-label="Direct link to property-linkurn--str" title="Direct link to property-linkurn--str"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLFeatureDataTypeClass"><span class="visually-hidden">MLFeatureDataTypeClass</span><a href="#datahub.metadata.schema_classes.MLFeatureDataTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLFeatureDataTypeClass" title="Direct link to datahub.metadata.schema_classes.MLFeatureDataTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLFeatureDataTypeClass</span>()<a href="#datahub.metadata.schema_classes.MLFeatureDataTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>MLFeature Data Type</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="audio--audio">AUDIO <em>= 'AUDIO'</em><a href="#audio--audio" class="hash-link" aria-label="Direct link to audio--audio" title="Direct link to audio--audio"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="binary--binary">BINARY <em>= 'BINARY'</em><a href="#binary--binary" class="hash-link" aria-label="Direct link to binary--binary" title="Direct link to binary--binary"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="byte--byte">BYTE <em>= 'BYTE'</em><a href="#byte--byte" class="hash-link" aria-label="Direct link to byte--byte" title="Direct link to byte--byte"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="continuous--continuous">CONTINUOUS <em>= 'CONTINUOUS'</em><a href="#continuous--continuous" class="hash-link" aria-label="Direct link to continuous--continuous" title="Direct link to continuous--continuous"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="count--count-1">COUNT <em>= 'COUNT'</em><a href="#count--count-1" class="hash-link" aria-label="Direct link to count--count-1" title="Direct link to count--count-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="image--image">IMAGE <em>= 'IMAGE'</em><a href="#image--image" class="hash-link" aria-label="Direct link to image--image" title="Direct link to image--image"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="interval--interval">INTERVAL <em>= 'INTERVAL'</em><a href="#interval--interval" class="hash-link" aria-label="Direct link to interval--interval" title="Direct link to interval--interval"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="map--map">MAP <em>= 'MAP'</em><a href="#map--map" class="hash-link" aria-label="Direct link to map--map" title="Direct link to map--map"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="nominal--nominal">NOMINAL <em>= 'NOMINAL'</em><a href="#nominal--nominal" class="hash-link" aria-label="Direct link to nominal--nominal" title="Direct link to nominal--nominal"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="ordinal--ordinal">ORDINAL <em>= 'ORDINAL'</em><a href="#ordinal--ordinal" class="hash-link" aria-label="Direct link to ordinal--ordinal" title="Direct link to ordinal--ordinal"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sequence--sequence">SEQUENCE <em>= 'SEQUENCE'</em><a href="#sequence--sequence" class="hash-link" aria-label="Direct link to sequence--sequence" title="Direct link to sequence--sequence"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set--set-1">SET <em>= 'SET'</em><a href="#set--set-1" class="hash-link" aria-label="Direct link to set--set-1" title="Direct link to set--set-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="text--text-1">TEXT <em>= 'TEXT'</em><a href="#text--text-1" class="hash-link" aria-label="Direct link to text--text-1" title="Direct link to text--text-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="time--time">TIME <em>= 'TIME'</em><a href="#time--time" class="hash-link" aria-label="Direct link to time--time" title="Direct link to time--time"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="unknown--unknown-4">UNKNOWN <em>= 'UNKNOWN'</em><a href="#unknown--unknown-4" class="hash-link" aria-label="Direct link to unknown--unknown-4" title="Direct link to unknown--unknown-4"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="useless--useless">USELESS <em>= 'USELESS'</em><a href="#useless--useless" class="hash-link" aria-label="Direct link to useless--useless" title="Direct link to useless--useless"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="video--video">VIDEO <em>= 'VIDEO'</em><a href="#video--video" class="hash-link" aria-label="Direct link to video--video" title="Direct link to video--video"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLFeatureKeyClass"><span class="visually-hidden">MLFeatureKeyClass</span><a href="#datahub.metadata.schema_classes.MLFeatureKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLFeatureKeyClass" title="Direct link to datahub.metadata.schema_classes.MLFeatureKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLFeatureKeyClass</span>(<span class="arg-name">featureNamespace</span>, <span class="arg-name">name</span>)<a href="#datahub.metadata.schema_classes.MLFeatureKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for an MLFeature</p><ul><li><strong>Parameters:</strong><ul><li><strong>featureNamespace</strong> (<code>str</code>)</li><li><strong>name</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-featurenamespace--str"><em>property</em> featureNamespace <em>: str</em><a href="#property-featurenamespace--str" class="hash-link" aria-label="Direct link to property-featurenamespace--str" title="Direct link to property-featurenamespace--str"></a></h4><p>Namespace for the feature</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-22"><em>property</em> name <em>: str</em><a href="#property-name--str-22" class="hash-link" aria-label="Direct link to property-name--str-22" title="Direct link to property-name--str-22"></a></h4><p>Name of the feature</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLFeaturePropertiesClass"><span class="visually-hidden">MLFeaturePropertiesClass</span><a href="#datahub.metadata.schema_classes.MLFeaturePropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLFeaturePropertiesClass" title="Direct link to datahub.metadata.schema_classes.MLFeaturePropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLFeaturePropertiesClass</span>(<span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">dataType</span> = <span class="arg-default">None</span>, <span class="arg-name">version</span> = <span class="arg-default">None</span>, <span class="arg-name">sources</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.MLFeaturePropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties associated with a MLFeature</p><ul><li><strong>Parameters:</strong><ul><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>dataType</strong> (<code>Union</code>[<code>None</code>, <code>str</code>, <a href="#datahub.metadata.schema_classes.MLFeatureDataTypeClass"><code>MLFeatureDataTypeClass</code></a>]) – </li><li><strong>version</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.VersionTagClass"><code>VersionTagClass</code></a>]) – </li><li><strong>sources</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-19"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-19" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-19" title="Direct link to property-customproperties--dictstr-str-19"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-datatype--none--str--mlfeaturedatatypeclass"><em>property</em> dataType <em>: None | str | <a href="#datahub.metadata.schema_classes.MLFeatureDataTypeClass">MLFeatureDataTypeClass</a></em><a href="#property-datatype--none--str--mlfeaturedatatypeclass" class="hash-link" aria-label="Direct link to property-datatype--none--str--mlfeaturedatatypeclass" title="Direct link to property-datatype--none--str--mlfeaturedatatypeclass"></a></h4><p>Data Type of the MLFeature</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-34"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-34" class="hash-link" aria-label="Direct link to property-description--none--str-34" title="Direct link to property-description--none--str-34"></a></h4><p>Documentation of the MLFeature</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-sources--none--liststr"><em>property</em> sources <em>: None | List<!-- -->[str]</em><a href="#property-sources--none--liststr" class="hash-link" aria-label="Direct link to property-sources--none--liststr" title="Direct link to property-sources--none--liststr"></a></h4><p>Source of the MLFeature</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-version--none--versiontagclass"><em>property</em> version <em>: None | <a href="#datahub.metadata.schema_classes.VersionTagClass">VersionTagClass</a></em><a href="#property-version--none--versiontagclass" class="hash-link" aria-label="Direct link to property-version--none--versiontagclass" title="Direct link to property-version--none--versiontagclass"></a></h4><p>Version of the MLFeature</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLFeatureSnapshotClass"><span class="visually-hidden">MLFeatureSnapshotClass</span><a href="#datahub.metadata.schema_classes.MLFeatureSnapshotClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLFeatureSnapshotClass" title="Direct link to datahub.metadata.schema_classes.MLFeatureSnapshotClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLFeatureSnapshotClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">aspects</span>)<a href="#datahub.metadata.schema_classes.MLFeatureSnapshotClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>aspects</strong> (<code>List</code>[<code>Union</code>[<a href="#datahub.metadata.schema_classes.MLFeatureKeyClass"><code>MLFeatureKeyClass</code></a>, <a href="#datahub.metadata.schema_classes.MLFeaturePropertiesClass"><code>MLFeaturePropertiesClass</code></a>, <a href="#datahub.metadata.schema_classes.OwnershipClass"><code>OwnershipClass</code></a>, <a href="#datahub.metadata.schema_classes.InstitutionalMemoryClass"><code>InstitutionalMemoryClass</code></a>, <a href="#datahub.metadata.schema_classes.StatusClass"><code>StatusClass</code></a>, <a href="#datahub.metadata.schema_classes.DeprecationClass"><code>DeprecationClass</code></a>, <a href="#datahub.metadata.schema_classes.BrowsePathsClass"><code>BrowsePathsClass</code></a>, <a href="#datahub.metadata.schema_classes.GlobalTagsClass"><code>GlobalTagsClass</code></a>, <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass"><code>DataPlatformInstanceClass</code></a>, <a href="#datahub.metadata.schema_classes.BrowsePathsV2Class"><code>BrowsePathsV2Class</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspects--listmlfeaturekeyclass--mlfeaturepropertiesclass--ownershipclass--institutionalmemoryclass--statusclass--deprecationclass--browsepathsclass--globaltagsclass--dataplatforminstanceclass--browsepathsv2class"><em>property</em> aspects <em>: List[<a href="#datahub.metadata.schema_classes.MLFeatureKeyClass">MLFeatureKeyClass</a> | <a href="#datahub.metadata.schema_classes.MLFeaturePropertiesClass">MLFeaturePropertiesClass</a> | <a href="#datahub.metadata.schema_classes.OwnershipClass">OwnershipClass</a> | <a href="#datahub.metadata.schema_classes.InstitutionalMemoryClass">InstitutionalMemoryClass</a> | <a href="#datahub.metadata.schema_classes.StatusClass">StatusClass</a> | <a href="#datahub.metadata.schema_classes.DeprecationClass">DeprecationClass</a> | <a href="#datahub.metadata.schema_classes.BrowsePathsClass">BrowsePathsClass</a> | <a href="#datahub.metadata.schema_classes.GlobalTagsClass">GlobalTagsClass</a> | <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass">DataPlatformInstanceClass</a> | <a href="#datahub.metadata.schema_classes.BrowsePathsV2Class">BrowsePathsV2Class</a>]</em><a href="#property-aspects--listmlfeaturekeyclass--mlfeaturepropertiesclass--ownershipclass--institutionalmemoryclass--statusclass--deprecationclass--browsepathsclass--globaltagsclass--dataplatforminstanceclass--browsepathsv2class" class="hash-link" aria-label="Direct link to property-aspects--listmlfeaturekeyclass--mlfeaturepropertiesclass--ownershipclass--institutionalmemoryclass--statusclass--deprecationclass--browsepathsclass--globaltagsclass--dataplatforminstanceclass--browsepathsv2class" title="Direct link to property-aspects--listmlfeaturekeyclass--mlfeaturepropertiesclass--ownershipclass--institutionalmemoryclass--statusclass--deprecationclass--browsepathsclass--globaltagsclass--dataplatforminstanceclass--browsepathsv2class"></a></h4><p>The list of metadata aspects associated with the MLFeature. Depending on the use case, this can either be all, or a selection, of supported aspects.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-16"><em>property</em> urn <em>: str</em><a href="#property-urn--str-16" class="hash-link" aria-label="Direct link to property-urn--str-16" title="Direct link to property-urn--str-16"></a></h4><p>URN for the entity the metadata snapshot is associated with.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLFeatureTableKeyClass"><span class="visually-hidden">MLFeatureTableKeyClass</span><a href="#datahub.metadata.schema_classes.MLFeatureTableKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLFeatureTableKeyClass" title="Direct link to datahub.metadata.schema_classes.MLFeatureTableKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLFeatureTableKeyClass</span>(<span class="arg-name">platform</span>, <span class="arg-name">name</span>)<a href="#datahub.metadata.schema_classes.MLFeatureTableKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for an MLFeatureTable</p><ul><li><strong>Parameters:</strong><ul><li><strong>platform</strong> (<code>str</code>)</li><li><strong>name</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-23"><em>property</em> name <em>: str</em><a href="#property-name--str-23" class="hash-link" aria-label="Direct link to property-name--str-23" title="Direct link to property-name--str-23"></a></h4><p>Name of the feature table</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-platform--str-3"><em>property</em> platform <em>: str</em><a href="#property-platform--str-3" class="hash-link" aria-label="Direct link to property-platform--str-3" title="Direct link to property-platform--str-3"></a></h4><p>Data platform urn associated with the feature table</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLFeatureTablePropertiesClass"><span class="visually-hidden">MLFeatureTablePropertiesClass</span><a href="#datahub.metadata.schema_classes.MLFeatureTablePropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLFeatureTablePropertiesClass" title="Direct link to datahub.metadata.schema_classes.MLFeatureTablePropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLFeatureTablePropertiesClass</span>(<span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">mlFeatures</span> = <span class="arg-default">None</span>, <span class="arg-name">mlPrimaryKeys</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.MLFeatureTablePropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties associated with a MLFeatureTable</p><ul><li><strong>Parameters:</strong><ul><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>mlFeatures</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>mlPrimaryKeys</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-20"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-20" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-20" title="Direct link to property-customproperties--dictstr-str-20"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-35"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-35" class="hash-link" aria-label="Direct link to property-description--none--str-35" title="Direct link to property-description--none--str-35"></a></h4><p>Documentation of the MLFeatureTable</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-mlfeatures--none--liststr"><em>property</em> mlFeatures <em>: None | List<!-- -->[str]</em><a href="#property-mlfeatures--none--liststr" class="hash-link" aria-label="Direct link to property-mlfeatures--none--liststr" title="Direct link to property-mlfeatures--none--liststr"></a></h4><p>List of features contained in the feature table</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-mlprimarykeys--none--liststr"><em>property</em> mlPrimaryKeys <em>: None | List<!-- -->[str]</em><a href="#property-mlprimarykeys--none--liststr" class="hash-link" aria-label="Direct link to property-mlprimarykeys--none--liststr" title="Direct link to property-mlprimarykeys--none--liststr"></a></h4><p>List of primary keys in the feature table (if multiple, assumed to act as a composite key)</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLFeatureTableSnapshotClass"><span class="visually-hidden">MLFeatureTableSnapshotClass</span><a href="#datahub.metadata.schema_classes.MLFeatureTableSnapshotClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLFeatureTableSnapshotClass" title="Direct link to datahub.metadata.schema_classes.MLFeatureTableSnapshotClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLFeatureTableSnapshotClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">aspects</span>)<a href="#datahub.metadata.schema_classes.MLFeatureTableSnapshotClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>aspects</strong> (<code>List</code>[<code>Union</code>[<a href="#datahub.metadata.schema_classes.MLFeatureTableKeyClass"><code>MLFeatureTableKeyClass</code></a>, <a href="#datahub.metadata.schema_classes.MLFeatureTablePropertiesClass"><code>MLFeatureTablePropertiesClass</code></a>, <a href="#datahub.metadata.schema_classes.OwnershipClass"><code>OwnershipClass</code></a>, <a href="#datahub.metadata.schema_classes.InstitutionalMemoryClass"><code>InstitutionalMemoryClass</code></a>, <a href="#datahub.metadata.schema_classes.StatusClass"><code>StatusClass</code></a>, <a href="#datahub.metadata.schema_classes.DeprecationClass"><code>DeprecationClass</code></a>, <a href="#datahub.metadata.schema_classes.BrowsePathsClass"><code>BrowsePathsClass</code></a>, <a href="#datahub.metadata.schema_classes.GlobalTagsClass"><code>GlobalTagsClass</code></a>, <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass"><code>DataPlatformInstanceClass</code></a>, <a href="#datahub.metadata.schema_classes.BrowsePathsV2Class"><code>BrowsePathsV2Class</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspects--listmlfeaturetablekeyclass--mlfeaturetablepropertiesclass--ownershipclass--institutionalmemoryclass--statusclass--deprecationclass--browsepathsclass--globaltagsclass--dataplatforminstanceclass--browsepathsv2class"><em>property</em> aspects <em>: List[<a href="#datahub.metadata.schema_classes.MLFeatureTableKeyClass">MLFeatureTableKeyClass</a> | <a href="#datahub.metadata.schema_classes.MLFeatureTablePropertiesClass">MLFeatureTablePropertiesClass</a> | <a href="#datahub.metadata.schema_classes.OwnershipClass">OwnershipClass</a> | <a href="#datahub.metadata.schema_classes.InstitutionalMemoryClass">InstitutionalMemoryClass</a> | <a href="#datahub.metadata.schema_classes.StatusClass">StatusClass</a> | <a href="#datahub.metadata.schema_classes.DeprecationClass">DeprecationClass</a> | <a href="#datahub.metadata.schema_classes.BrowsePathsClass">BrowsePathsClass</a> | <a href="#datahub.metadata.schema_classes.GlobalTagsClass">GlobalTagsClass</a> | <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass">DataPlatformInstanceClass</a> | <a href="#datahub.metadata.schema_classes.BrowsePathsV2Class">BrowsePathsV2Class</a>]</em><a href="#property-aspects--listmlfeaturetablekeyclass--mlfeaturetablepropertiesclass--ownershipclass--institutionalmemoryclass--statusclass--deprecationclass--browsepathsclass--globaltagsclass--dataplatforminstanceclass--browsepathsv2class" class="hash-link" aria-label="Direct link to property-aspects--listmlfeaturetablekeyclass--mlfeaturetablepropertiesclass--ownershipclass--institutionalmemoryclass--statusclass--deprecationclass--browsepathsclass--globaltagsclass--dataplatforminstanceclass--browsepathsv2class" title="Direct link to property-aspects--listmlfeaturetablekeyclass--mlfeaturetablepropertiesclass--ownershipclass--institutionalmemoryclass--statusclass--deprecationclass--browsepathsclass--globaltagsclass--dataplatforminstanceclass--browsepathsv2class"></a></h4><p>The list of metadata aspects associated with the MLFeatureTable. Depending on the use case, this can either be all, or a selection, of supported aspects.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-17"><em>property</em> urn <em>: str</em><a href="#property-urn--str-17" class="hash-link" aria-label="Direct link to property-urn--str-17" title="Direct link to property-urn--str-17"></a></h4><p>URN for the entity the metadata snapshot is associated with.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLHyperParamClass"><span class="visually-hidden">MLHyperParamClass</span><a href="#datahub.metadata.schema_classes.MLHyperParamClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLHyperParamClass" title="Direct link to datahub.metadata.schema_classes.MLHyperParamClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLHyperParamClass</span>(<span class="arg-name">name</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">value</span> = <span class="arg-default">None</span>, <span class="arg-name">createdAt</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.MLHyperParamClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties associated with an ML Hyper Param</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>value</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>createdAt</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-createdat--none--int"><em>property</em> createdAt <em>: None | int</em><a href="#property-createdat--none--int" class="hash-link" aria-label="Direct link to property-createdat--none--int" title="Direct link to property-createdat--none--int"></a></h4><p>Date when the MLHyperParam was developed</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-36"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-36" class="hash-link" aria-label="Direct link to property-description--none--str-36" title="Direct link to property-description--none--str-36"></a></h4><p>Documentation of the MLHyperParam</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-24"><em>property</em> name <em>: str</em><a href="#property-name--str-24" class="hash-link" aria-label="Direct link to property-name--str-24" title="Direct link to property-name--str-24"></a></h4><p>Name of the MLHyperParam</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-value--none--str"><em>property</em> value <em>: None | str</em><a href="#property-value--none--str" class="hash-link" aria-label="Direct link to property-value--none--str" title="Direct link to property-value--none--str"></a></h4><p>The value of the MLHyperParam</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLMetricClass"><span class="visually-hidden">MLMetricClass</span><a href="#datahub.metadata.schema_classes.MLMetricClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLMetricClass" title="Direct link to datahub.metadata.schema_classes.MLMetricClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLMetricClass</span>(<span class="arg-name">name</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">value</span> = <span class="arg-default">None</span>, <span class="arg-name">createdAt</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.MLMetricClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties associated with an ML Metric</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>value</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>createdAt</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-createdat--none--int-1"><em>property</em> createdAt <em>: None | int</em><a href="#property-createdat--none--int-1" class="hash-link" aria-label="Direct link to property-createdat--none--int-1" title="Direct link to property-createdat--none--int-1"></a></h4><p>Date when the mlMetric was developed</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-37"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-37" class="hash-link" aria-label="Direct link to property-description--none--str-37" title="Direct link to property-description--none--str-37"></a></h4><p>Documentation of the mlMetric</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-25"><em>property</em> name <em>: str</em><a href="#property-name--str-25" class="hash-link" aria-label="Direct link to property-name--str-25" title="Direct link to property-name--str-25"></a></h4><p>Name of the mlMetric</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-value--none--str-1"><em>property</em> value <em>: None | str</em><a href="#property-value--none--str-1" class="hash-link" aria-label="Direct link to property-value--none--str-1" title="Direct link to property-value--none--str-1"></a></h4><p>The value of the mlMetric</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLModelDeploymentKeyClass"><span class="visually-hidden">MLModelDeploymentKeyClass</span><a href="#datahub.metadata.schema_classes.MLModelDeploymentKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLModelDeploymentKeyClass" title="Direct link to datahub.metadata.schema_classes.MLModelDeploymentKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLModelDeploymentKeyClass</span>(<span class="arg-name">platform</span>, <span class="arg-name">name</span>, <span class="arg-name">origin</span>)<a href="#datahub.metadata.schema_classes.MLModelDeploymentKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for an ML model deployment</p><ul><li><strong>Parameters:</strong><ul><li><strong>platform</strong> (<code>str</code>)</li><li><strong>name</strong> (<code>str</code>)</li><li><strong>origin</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.FabricTypeClass"><code>FabricTypeClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-26"><em>property</em> name <em>: str</em><a href="#property-name--str-26" class="hash-link" aria-label="Direct link to property-name--str-26" title="Direct link to property-name--str-26"></a></h4><p>Name of the MLModelDeployment</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-origin--str--fabrictypeclass-2"><em>property</em> origin <em>: str | <a href="#datahub.metadata.schema_classes.FabricTypeClass">FabricTypeClass</a></em><a href="#property-origin--str--fabrictypeclass-2" class="hash-link" aria-label="Direct link to property-origin--str--fabrictypeclass-2" title="Direct link to property-origin--str--fabrictypeclass-2"></a></h4><p>Fabric type where model Deployment belongs to or where it was generated</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-platform--str-4"><em>property</em> platform <em>: str</em><a href="#property-platform--str-4" class="hash-link" aria-label="Direct link to property-platform--str-4" title="Direct link to property-platform--str-4"></a></h4><p>Standardized platform urn for the model Deployment</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLModelDeploymentPropertiesClass"><span class="visually-hidden">MLModelDeploymentPropertiesClass</span><a href="#datahub.metadata.schema_classes.MLModelDeploymentPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLModelDeploymentPropertiesClass" title="Direct link to datahub.metadata.schema_classes.MLModelDeploymentPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLModelDeploymentPropertiesClass</span>(<span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">externalUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">createdAt</span> = <span class="arg-default">None</span>, <span class="arg-name">version</span> = <span class="arg-default">None</span>, <span class="arg-name">status</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.MLModelDeploymentPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties associated with an ML Model Deployment</p><ul><li><strong>Parameters:</strong><ul><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>externalUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>createdAt</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>version</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.VersionTagClass"><code>VersionTagClass</code></a>]) – </li><li><strong>status</strong> (<code>Union</code>[<code>None</code>, <code>str</code>, <a href="#datahub.metadata.schema_classes.DeploymentStatusClass"><code>DeploymentStatusClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-createdat--none--int-2"><em>property</em> createdAt <em>: None | int</em><a href="#property-createdat--none--int-2" class="hash-link" aria-label="Direct link to property-createdat--none--int-2" title="Direct link to property-createdat--none--int-2"></a></h4><p>Date when the MLModelDeployment was developed</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-21"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-21" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-21" title="Direct link to property-customproperties--dictstr-str-21"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-38"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-38" class="hash-link" aria-label="Direct link to property-description--none--str-38" title="Direct link to property-description--none--str-38"></a></h4><p>Documentation of the MLModelDeployment</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-externalurl--none--str-13"><em>property</em> externalUrl <em>: None | str</em><a href="#property-externalurl--none--str-13" class="hash-link" aria-label="Direct link to property-externalurl--none--str-13" title="Direct link to property-externalurl--none--str-13"></a></h4><p>URL where the reference exist</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-status--none--str--deploymentstatusclass"><em>property</em> status <em>: None | str | <a href="#datahub.metadata.schema_classes.DeploymentStatusClass">DeploymentStatusClass</a></em><a href="#property-status--none--str--deploymentstatusclass" class="hash-link" aria-label="Direct link to property-status--none--str--deploymentstatusclass" title="Direct link to property-status--none--str--deploymentstatusclass"></a></h4><p>Status of the deployment</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-version--none--versiontagclass-1"><em>property</em> version <em>: None | <a href="#datahub.metadata.schema_classes.VersionTagClass">VersionTagClass</a></em><a href="#property-version--none--versiontagclass-1" class="hash-link" aria-label="Direct link to property-version--none--versiontagclass-1" title="Direct link to property-version--none--versiontagclass-1"></a></h4><p>Version of the MLModelDeployment</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLModelDeploymentSnapshotClass"><span class="visually-hidden">MLModelDeploymentSnapshotClass</span><a href="#datahub.metadata.schema_classes.MLModelDeploymentSnapshotClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLModelDeploymentSnapshotClass" title="Direct link to datahub.metadata.schema_classes.MLModelDeploymentSnapshotClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLModelDeploymentSnapshotClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">aspects</span>)<a href="#datahub.metadata.schema_classes.MLModelDeploymentSnapshotClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>aspects</strong> (<code>List</code>[<code>Union</code>[<a href="#datahub.metadata.schema_classes.MLModelDeploymentKeyClass"><code>MLModelDeploymentKeyClass</code></a>, <a href="#datahub.metadata.schema_classes.MLModelDeploymentPropertiesClass"><code>MLModelDeploymentPropertiesClass</code></a>, <a href="#datahub.metadata.schema_classes.OwnershipClass"><code>OwnershipClass</code></a>, <a href="#datahub.metadata.schema_classes.StatusClass"><code>StatusClass</code></a>, <a href="#datahub.metadata.schema_classes.DeprecationClass"><code>DeprecationClass</code></a>, <a href="#datahub.metadata.schema_classes.GlobalTagsClass"><code>GlobalTagsClass</code></a>, <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass"><code>DataPlatformInstanceClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspects--listmlmodeldeploymentkeyclass--mlmodeldeploymentpropertiesclass--ownershipclass--statusclass--deprecationclass--globaltagsclass--dataplatforminstanceclass"><em>property</em> aspects <em>: List[<a href="#datahub.metadata.schema_classes.MLModelDeploymentKeyClass">MLModelDeploymentKeyClass</a> | <a href="#datahub.metadata.schema_classes.MLModelDeploymentPropertiesClass">MLModelDeploymentPropertiesClass</a> | <a href="#datahub.metadata.schema_classes.OwnershipClass">OwnershipClass</a> | <a href="#datahub.metadata.schema_classes.StatusClass">StatusClass</a> | <a href="#datahub.metadata.schema_classes.DeprecationClass">DeprecationClass</a> | <a href="#datahub.metadata.schema_classes.GlobalTagsClass">GlobalTagsClass</a> | <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass">DataPlatformInstanceClass</a>]</em><a href="#property-aspects--listmlmodeldeploymentkeyclass--mlmodeldeploymentpropertiesclass--ownershipclass--statusclass--deprecationclass--globaltagsclass--dataplatforminstanceclass" class="hash-link" aria-label="Direct link to property-aspects--listmlmodeldeploymentkeyclass--mlmodeldeploymentpropertiesclass--ownershipclass--statusclass--deprecationclass--globaltagsclass--dataplatforminstanceclass" title="Direct link to property-aspects--listmlmodeldeploymentkeyclass--mlmodeldeploymentpropertiesclass--ownershipclass--statusclass--deprecationclass--globaltagsclass--dataplatforminstanceclass"></a></h4><p>The list of metadata aspects associated with the MLModelDeployment. Depending on the use case, this can either be all, or a selection, of supported aspects.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-18"><em>property</em> urn <em>: str</em><a href="#property-urn--str-18" class="hash-link" aria-label="Direct link to property-urn--str-18" title="Direct link to property-urn--str-18"></a></h4><p>URN for the entity the metadata snapshot is associated with.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLModelFactorPromptsClass"><span class="visually-hidden">MLModelFactorPromptsClass</span><a href="#datahub.metadata.schema_classes.MLModelFactorPromptsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLModelFactorPromptsClass" title="Direct link to datahub.metadata.schema_classes.MLModelFactorPromptsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLModelFactorPromptsClass</span>(<span class="arg-name">relevantFactors</span> = <span class="arg-default">None</span>, <span class="arg-name">evaluationFactors</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.MLModelFactorPromptsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Prompts which affect the performance of the MLModel</p><ul><li><strong>Parameters:</strong><ul><li><strong>relevantFactors</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.MLModelFactorsClass"><code>MLModelFactorsClass</code></a>]]) – </li><li><strong>evaluationFactors</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.MLModelFactorsClass"><code>MLModelFactorsClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-evaluationfactors--none--listmlmodelfactorsclass"><em>property</em> evaluationFactors <em>: None | List[<a href="#datahub.metadata.schema_classes.MLModelFactorsClass">MLModelFactorsClass</a>]</em><a href="#property-evaluationfactors--none--listmlmodelfactorsclass" class="hash-link" aria-label="Direct link to property-evaluationfactors--none--listmlmodelfactorsclass" title="Direct link to property-evaluationfactors--none--listmlmodelfactorsclass"></a></h4><p>Which factors are being reported, and why were these chosen?</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-relevantfactors--none--listmlmodelfactorsclass"><em>property</em> relevantFactors <em>: None | List[<a href="#datahub.metadata.schema_classes.MLModelFactorsClass">MLModelFactorsClass</a>]</em><a href="#property-relevantfactors--none--listmlmodelfactorsclass" class="hash-link" aria-label="Direct link to property-relevantfactors--none--listmlmodelfactorsclass" title="Direct link to property-relevantfactors--none--listmlmodelfactorsclass"></a></h4><p>What are foreseeable salient factors for which MLModel performance may vary, and how were these determined?</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLModelFactorsClass"><span class="visually-hidden">MLModelFactorsClass</span><a href="#datahub.metadata.schema_classes.MLModelFactorsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLModelFactorsClass" title="Direct link to datahub.metadata.schema_classes.MLModelFactorsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLModelFactorsClass</span>(<span class="arg-name">groups</span> = <span class="arg-default">None</span>, <span class="arg-name">instrumentation</span> = <span class="arg-default">None</span>, <span class="arg-name">environment</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.MLModelFactorsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Factors affecting the performance of the MLModel.</p><ul><li><strong>Parameters:</strong><ul><li><strong>groups</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>instrumentation</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>environment</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-environment--none--liststr"><em>property</em> environment <em>: None | List<!-- -->[str]</em><a href="#property-environment--none--liststr" class="hash-link" aria-label="Direct link to property-environment--none--liststr" title="Direct link to property-environment--none--liststr"></a></h4><p>A further factor affecting MLModel performance is the environment in which it is deployed.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-groups--none--liststr-2"><em>property</em> groups <em>: None | List<!-- -->[str]</em><a href="#property-groups--none--liststr-2" class="hash-link" aria-label="Direct link to property-groups--none--liststr-2" title="Direct link to property-groups--none--liststr-2"></a></h4><p>Groups refers to distinct categories with similar characteristics that are present in the evaluation data instances.
|
||
For human-centric machine learning MLModels, groups are people who share one or multiple characteristics.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-instrumentation--none--liststr"><em>property</em> instrumentation <em>: None | List<!-- -->[str]</em><a href="#property-instrumentation--none--liststr" class="hash-link" aria-label="Direct link to property-instrumentation--none--liststr" title="Direct link to property-instrumentation--none--liststr"></a></h4><p>The performance of a MLModel can vary depending on what instruments were used to capture the input to the MLModel.
|
||
For example, a face detection model may perform differently depending on the camera’s hardware and software,
|
||
including lens, image stabilization, high dynamic range techniques, and background blurring for portrait mode.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLModelGroupKeyClass"><span class="visually-hidden">MLModelGroupKeyClass</span><a href="#datahub.metadata.schema_classes.MLModelGroupKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLModelGroupKeyClass" title="Direct link to datahub.metadata.schema_classes.MLModelGroupKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLModelGroupKeyClass</span>(<span class="arg-name">platform</span>, <span class="arg-name">name</span>, <span class="arg-name">origin</span>)<a href="#datahub.metadata.schema_classes.MLModelGroupKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for an ML model group</p><ul><li><strong>Parameters:</strong><ul><li><strong>platform</strong> (<code>str</code>)</li><li><strong>name</strong> (<code>str</code>)</li><li><strong>origin</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.FabricTypeClass"><code>FabricTypeClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-27"><em>property</em> name <em>: str</em><a href="#property-name--str-27" class="hash-link" aria-label="Direct link to property-name--str-27" title="Direct link to property-name--str-27"></a></h4><p>Name of the MLModelGroup</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-origin--str--fabrictypeclass-3"><em>property</em> origin <em>: str | <a href="#datahub.metadata.schema_classes.FabricTypeClass">FabricTypeClass</a></em><a href="#property-origin--str--fabrictypeclass-3" class="hash-link" aria-label="Direct link to property-origin--str--fabrictypeclass-3" title="Direct link to property-origin--str--fabrictypeclass-3"></a></h4><p>Fabric type where model group belongs to or where it was generated</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-platform--str-5"><em>property</em> platform <em>: str</em><a href="#property-platform--str-5" class="hash-link" aria-label="Direct link to property-platform--str-5" title="Direct link to property-platform--str-5"></a></h4><p>Standardized platform urn for the model group</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLModelGroupPropertiesClass"><span class="visually-hidden">MLModelGroupPropertiesClass</span><a href="#datahub.metadata.schema_classes.MLModelGroupPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLModelGroupPropertiesClass" title="Direct link to datahub.metadata.schema_classes.MLModelGroupPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLModelGroupPropertiesClass</span>(<span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">trainingJobs</span> = <span class="arg-default">None</span>, <span class="arg-name">downstreamJobs</span> = <span class="arg-default">None</span>, <span class="arg-name">externalUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">name</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">createdAt</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>, <span class="arg-name">version</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.MLModelGroupPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties associated with an ML Model Group</p><ul><li><strong>Parameters:</strong><ul><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>trainingJobs</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>downstreamJobs</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>externalUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>createdAt</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeStampClass"><code>TimeStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeStampClass"><code>TimeStampClass</code></a>]) – </li><li><strong>version</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.VersionTagClass"><code>VersionTagClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--none--timestampclass-4"><em>property</em> created <em>: None | <a href="#datahub.metadata.schema_classes.TimeStampClass">TimeStampClass</a></em><a href="#property-created--none--timestampclass-4" class="hash-link" aria-label="Direct link to property-created--none--timestampclass-4" title="Direct link to property-created--none--timestampclass-4"></a></h4><p>Time and Actor who created the MLModelGroup</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-createdat--none--int-3"><em>property</em> createdAt <em>: None | int</em><a href="#property-createdat--none--int-3" class="hash-link" aria-label="Direct link to property-createdat--none--int-3" title="Direct link to property-createdat--none--int-3"></a></h4><p>Date when the MLModelGroup was developed</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-22"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-22" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-22" title="Direct link to property-customproperties--dictstr-str-22"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-39"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-39" class="hash-link" aria-label="Direct link to property-description--none--str-39" title="Direct link to property-description--none--str-39"></a></h4><p>Documentation of the MLModelGroup</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-downstreamjobs--none--liststr"><em>property</em> downstreamJobs <em>: None | List<!-- -->[str]</em><a href="#property-downstreamjobs--none--liststr" class="hash-link" aria-label="Direct link to property-downstreamjobs--none--liststr" title="Direct link to property-downstreamjobs--none--liststr"></a></h4><p>List of jobs or process instances (if any) that use the model or group.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-externalurl--none--str-14"><em>property</em> externalUrl <em>: None | str</em><a href="#property-externalurl--none--str-14" class="hash-link" aria-label="Direct link to property-externalurl--none--str-14" title="Direct link to property-externalurl--none--str-14"></a></h4><p>URL where the reference exist</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--none--timestampclass-4"><em>property</em> lastModified <em>: None | <a href="#datahub.metadata.schema_classes.TimeStampClass">TimeStampClass</a></em><a href="#property-lastmodified--none--timestampclass-4" class="hash-link" aria-label="Direct link to property-lastmodified--none--timestampclass-4" title="Direct link to property-lastmodified--none--timestampclass-4"></a></h4><p>Date when the MLModelGroup was last modified</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--none--str-9"><em>property</em> name <em>: None | str</em><a href="#property-name--none--str-9" class="hash-link" aria-label="Direct link to property-name--none--str-9" title="Direct link to property-name--none--str-9"></a></h4><p>Display name of the MLModelGroup</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-trainingjobs--none--liststr"><em>property</em> trainingJobs <em>: None | List<!-- -->[str]</em><a href="#property-trainingjobs--none--liststr" class="hash-link" aria-label="Direct link to property-trainingjobs--none--liststr" title="Direct link to property-trainingjobs--none--liststr"></a></h4><p>List of jobs or process instances (if any) used to train the model or group. Visible in Lineage. Note that ML Models can also be specified as the output of a specific Data Process Instances (runs) via the DataProcessInstanceOutputs aspect.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-version--none--versiontagclass-2"><em>property</em> version <em>: None | <a href="#datahub.metadata.schema_classes.VersionTagClass">VersionTagClass</a></em><a href="#property-version--none--versiontagclass-2" class="hash-link" aria-label="Direct link to property-version--none--versiontagclass-2" title="Direct link to property-version--none--versiontagclass-2"></a></h4><p>Version of the MLModelGroup</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLModelGroupSnapshotClass"><span class="visually-hidden">MLModelGroupSnapshotClass</span><a href="#datahub.metadata.schema_classes.MLModelGroupSnapshotClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLModelGroupSnapshotClass" title="Direct link to datahub.metadata.schema_classes.MLModelGroupSnapshotClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLModelGroupSnapshotClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">aspects</span>)<a href="#datahub.metadata.schema_classes.MLModelGroupSnapshotClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>aspects</strong> (<code>List</code>[<code>Union</code>[<a href="#datahub.metadata.schema_classes.MLModelGroupKeyClass"><code>MLModelGroupKeyClass</code></a>, <a href="#datahub.metadata.schema_classes.MLModelGroupPropertiesClass"><code>MLModelGroupPropertiesClass</code></a>, <a href="#datahub.metadata.schema_classes.OwnershipClass"><code>OwnershipClass</code></a>, <a href="#datahub.metadata.schema_classes.StatusClass"><code>StatusClass</code></a>, <a href="#datahub.metadata.schema_classes.DeprecationClass"><code>DeprecationClass</code></a>, <a href="#datahub.metadata.schema_classes.BrowsePathsClass"><code>BrowsePathsClass</code></a>, <a href="#datahub.metadata.schema_classes.GlobalTagsClass"><code>GlobalTagsClass</code></a>, <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass"><code>DataPlatformInstanceClass</code></a>, <a href="#datahub.metadata.schema_classes.BrowsePathsV2Class"><code>BrowsePathsV2Class</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspects--listmlmodelgroupkeyclass--mlmodelgrouppropertiesclass--ownershipclass--statusclass--deprecationclass--browsepathsclass--globaltagsclass--dataplatforminstanceclass--browsepathsv2class"><em>property</em> aspects <em>: List[<a href="#datahub.metadata.schema_classes.MLModelGroupKeyClass">MLModelGroupKeyClass</a> | <a href="#datahub.metadata.schema_classes.MLModelGroupPropertiesClass">MLModelGroupPropertiesClass</a> | <a href="#datahub.metadata.schema_classes.OwnershipClass">OwnershipClass</a> | <a href="#datahub.metadata.schema_classes.StatusClass">StatusClass</a> | <a href="#datahub.metadata.schema_classes.DeprecationClass">DeprecationClass</a> | <a href="#datahub.metadata.schema_classes.BrowsePathsClass">BrowsePathsClass</a> | <a href="#datahub.metadata.schema_classes.GlobalTagsClass">GlobalTagsClass</a> | <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass">DataPlatformInstanceClass</a> | <a href="#datahub.metadata.schema_classes.BrowsePathsV2Class">BrowsePathsV2Class</a>]</em><a href="#property-aspects--listmlmodelgroupkeyclass--mlmodelgrouppropertiesclass--ownershipclass--statusclass--deprecationclass--browsepathsclass--globaltagsclass--dataplatforminstanceclass--browsepathsv2class" class="hash-link" aria-label="Direct link to property-aspects--listmlmodelgroupkeyclass--mlmodelgrouppropertiesclass--ownershipclass--statusclass--deprecationclass--browsepathsclass--globaltagsclass--dataplatforminstanceclass--browsepathsv2class" title="Direct link to property-aspects--listmlmodelgroupkeyclass--mlmodelgrouppropertiesclass--ownershipclass--statusclass--deprecationclass--browsepathsclass--globaltagsclass--dataplatforminstanceclass--browsepathsv2class"></a></h4><p>The list of metadata aspects associated with the MLModelGroup. Depending on the use case, this can either be all, or a selection, of supported aspects.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-19"><em>property</em> urn <em>: str</em><a href="#property-urn--str-19" class="hash-link" aria-label="Direct link to property-urn--str-19" title="Direct link to property-urn--str-19"></a></h4><p>URN for the entity the metadata snapshot is associated with.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLModelKeyClass"><span class="visually-hidden">MLModelKeyClass</span><a href="#datahub.metadata.schema_classes.MLModelKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLModelKeyClass" title="Direct link to datahub.metadata.schema_classes.MLModelKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLModelKeyClass</span>(<span class="arg-name">platform</span>, <span class="arg-name">name</span>, <span class="arg-name">origin</span>)<a href="#datahub.metadata.schema_classes.MLModelKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for an ML model</p><ul><li><strong>Parameters:</strong><ul><li><strong>platform</strong> (<code>str</code>)</li><li><strong>name</strong> (<code>str</code>)</li><li><strong>origin</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.FabricTypeClass"><code>FabricTypeClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-28"><em>property</em> name <em>: str</em><a href="#property-name--str-28" class="hash-link" aria-label="Direct link to property-name--str-28" title="Direct link to property-name--str-28"></a></h4><p>Name of the MLModel</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-origin--str--fabrictypeclass-4"><em>property</em> origin <em>: str | <a href="#datahub.metadata.schema_classes.FabricTypeClass">FabricTypeClass</a></em><a href="#property-origin--str--fabrictypeclass-4" class="hash-link" aria-label="Direct link to property-origin--str--fabrictypeclass-4" title="Direct link to property-origin--str--fabrictypeclass-4"></a></h4><p>Fabric type where model belongs to or where it was generated</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-platform--str-6"><em>property</em> platform <em>: str</em><a href="#property-platform--str-6" class="hash-link" aria-label="Direct link to property-platform--str-6" title="Direct link to property-platform--str-6"></a></h4><p>Standardized platform urn for the model</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLModelPropertiesClass"><span class="visually-hidden">MLModelPropertiesClass</span><a href="#datahub.metadata.schema_classes.MLModelPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLModelPropertiesClass" title="Direct link to datahub.metadata.schema_classes.MLModelPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLModelPropertiesClass</span>(<span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">externalUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">trainingJobs</span> = <span class="arg-default">None</span>, <span class="arg-name">downstreamJobs</span> = <span class="arg-default">None</span>, <span class="arg-name">name</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">date</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>, <span class="arg-name">version</span> = <span class="arg-default">None</span>, <span class="arg-name">type</span> = <span class="arg-default">None</span>, <span class="arg-name">hyperParameters</span> = <span class="arg-default">None</span>, <span class="arg-name">hyperParams</span> = <span class="arg-default">None</span>, <span class="arg-name">trainingMetrics</span> = <span class="arg-default">None</span>, <span class="arg-name">onlineMetrics</span> = <span class="arg-default">None</span>, <span class="arg-name">mlFeatures</span> = <span class="arg-default">None</span>, <span class="arg-name">tags</span> = <span class="arg-default">None</span>, <span class="arg-name">deployments</span> = <span class="arg-default">None</span>, <span class="arg-name">groups</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.MLModelPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties associated with a ML Model</p><ul><li><strong>Parameters:</strong><ul><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>externalUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>trainingJobs</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>downstreamJobs</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>date</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeStampClass"><code>TimeStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeStampClass"><code>TimeStampClass</code></a>]) – </li><li><strong>version</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.VersionTagClass"><code>VersionTagClass</code></a>]) – </li><li><strong>type</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>hyperParameters</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>Union</code>[<code>str</code>, <code>int</code>, <code>float</code>, <code>bool</code>]<!-- -->]])</li><li><strong>hyperParams</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.MLHyperParamClass"><code>MLHyperParamClass</code></a>]]) – </li><li><strong>trainingMetrics</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.MLMetricClass"><code>MLMetricClass</code></a>]]) – </li><li><strong>onlineMetrics</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.MLMetricClass"><code>MLMetricClass</code></a>]]) – </li><li><strong>mlFeatures</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>tags</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>deployments</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>groups</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--none--timestampclass-5"><em>property</em> created <em>: None | <a href="#datahub.metadata.schema_classes.TimeStampClass">TimeStampClass</a></em><a href="#property-created--none--timestampclass-5" class="hash-link" aria-label="Direct link to property-created--none--timestampclass-5" title="Direct link to property-created--none--timestampclass-5"></a></h4><p>Audit stamp containing who created this and when</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-23"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-23" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-23" title="Direct link to property-customproperties--dictstr-str-23"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-date--none--int"><em>property</em> date <em>: None | int</em><a href="#property-date--none--int" class="hash-link" aria-label="Direct link to property-date--none--int" title="Direct link to property-date--none--int"></a></h4><p>Date when the MLModel was developed</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-deployments--none--liststr"><em>property</em> deployments <em>: None | List<!-- -->[str]</em><a href="#property-deployments--none--liststr" class="hash-link" aria-label="Direct link to property-deployments--none--liststr" title="Direct link to property-deployments--none--liststr"></a></h4><p>Deployments for the MLModel</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-40"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-40" class="hash-link" aria-label="Direct link to property-description--none--str-40" title="Direct link to property-description--none--str-40"></a></h4><p>Documentation of the MLModel</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-downstreamjobs--none--liststr-1"><em>property</em> downstreamJobs <em>: None | List<!-- -->[str]</em><a href="#property-downstreamjobs--none--liststr-1" class="hash-link" aria-label="Direct link to property-downstreamjobs--none--liststr-1" title="Direct link to property-downstreamjobs--none--liststr-1"></a></h4><p>List of jobs or process instances (if any) that use the model or group.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-externalurl--none--str-15"><em>property</em> externalUrl <em>: None | str</em><a href="#property-externalurl--none--str-15" class="hash-link" aria-label="Direct link to property-externalurl--none--str-15" title="Direct link to property-externalurl--none--str-15"></a></h4><p>URL where the reference exist</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-groups--none--liststr-3"><em>property</em> groups <em>: None | List<!-- -->[str]</em><a href="#property-groups--none--liststr-3" class="hash-link" aria-label="Direct link to property-groups--none--liststr-3" title="Direct link to property-groups--none--liststr-3"></a></h4><p>Groups the model belongs to</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-hyperparameters--none--dictstr-str--int--float--bool"><em>property</em> hyperParameters <em>: None | Dict<!-- -->[str, str | int | float | bool]</em><a href="#property-hyperparameters--none--dictstr-str--int--float--bool" class="hash-link" aria-label="Direct link to property-hyperparameters--none--dictstr-str--int--float--bool" title="Direct link to property-hyperparameters--none--dictstr-str--int--float--bool"></a></h4><p>Hyper Parameters of the MLModel</p><p>NOTE: these are deprecated in favor of hyperParams</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-hyperparams--none--listmlhyperparamclass"><em>property</em> hyperParams <em>: None | List[<a href="#datahub.metadata.schema_classes.MLHyperParamClass">MLHyperParamClass</a>]</em><a href="#property-hyperparams--none--listmlhyperparamclass" class="hash-link" aria-label="Direct link to property-hyperparams--none--listmlhyperparamclass" title="Direct link to property-hyperparams--none--listmlhyperparamclass"></a></h4><p>Hyperparameters of the MLModel</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--none--timestampclass-5"><em>property</em> lastModified <em>: None | <a href="#datahub.metadata.schema_classes.TimeStampClass">TimeStampClass</a></em><a href="#property-lastmodified--none--timestampclass-5" class="hash-link" aria-label="Direct link to property-lastmodified--none--timestampclass-5" title="Direct link to property-lastmodified--none--timestampclass-5"></a></h4><p>Date when the MLModel was last modified</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-mlfeatures--none--liststr-1"><em>property</em> mlFeatures <em>: None | List<!-- -->[str]</em><a href="#property-mlfeatures--none--liststr-1" class="hash-link" aria-label="Direct link to property-mlfeatures--none--liststr-1" title="Direct link to property-mlfeatures--none--liststr-1"></a></h4><p>List of features used for MLModel training</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--none--str-10"><em>property</em> name <em>: None | str</em><a href="#property-name--none--str-10" class="hash-link" aria-label="Direct link to property-name--none--str-10" title="Direct link to property-name--none--str-10"></a></h4><p>Display name of the MLModel</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-onlinemetrics--none--listmlmetricclass"><em>property</em> onlineMetrics <em>: None | List[<a href="#datahub.metadata.schema_classes.MLMetricClass">MLMetricClass</a>]</em><a href="#property-onlinemetrics--none--listmlmetricclass" class="hash-link" aria-label="Direct link to property-onlinemetrics--none--listmlmetricclass" title="Direct link to property-onlinemetrics--none--listmlmetricclass"></a></h4><p>Metrics of the MLModel used in production</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-tags--liststr-1"><em>property</em> tags <em>: List<!-- -->[str]</em><a href="#property-tags--liststr-1" class="hash-link" aria-label="Direct link to property-tags--liststr-1" title="Direct link to property-tags--liststr-1"></a></h4><p>Tags for the MLModel</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-trainingjobs--none--liststr-1"><em>property</em> trainingJobs <em>: None | List<!-- -->[str]</em><a href="#property-trainingjobs--none--liststr-1" class="hash-link" aria-label="Direct link to property-trainingjobs--none--liststr-1" title="Direct link to property-trainingjobs--none--liststr-1"></a></h4><p>List of jobs or process instances (if any) used to train the model or group. Visible in Lineage. Note that ML Models can also be specified as the output of a specific Data Process Instances (runs) via the DataProcessInstanceOutputs aspect.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-trainingmetrics--none--listmlmetricclass"><em>property</em> trainingMetrics <em>: None | List[<a href="#datahub.metadata.schema_classes.MLMetricClass">MLMetricClass</a>]</em><a href="#property-trainingmetrics--none--listmlmetricclass" class="hash-link" aria-label="Direct link to property-trainingmetrics--none--listmlmetricclass" title="Direct link to property-trainingmetrics--none--listmlmetricclass"></a></h4><p>Metrics of the MLModel used in training</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--none--str-1"><em>property</em> type <em>: None | str</em><a href="#property-type--none--str-1" class="hash-link" aria-label="Direct link to property-type--none--str-1" title="Direct link to property-type--none--str-1"></a></h4><p>Type of Algorithm or MLModel such as whether it is a Naive Bayes classifier, Convolutional Neural Network, etc</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-version--none--versiontagclass-3"><em>property</em> version <em>: None | <a href="#datahub.metadata.schema_classes.VersionTagClass">VersionTagClass</a></em><a href="#property-version--none--versiontagclass-3" class="hash-link" aria-label="Direct link to property-version--none--versiontagclass-3" title="Direct link to property-version--none--versiontagclass-3"></a></h4><p>Version of the MLModel</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLModelSnapshotClass"><span class="visually-hidden">MLModelSnapshotClass</span><a href="#datahub.metadata.schema_classes.MLModelSnapshotClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLModelSnapshotClass" title="Direct link to datahub.metadata.schema_classes.MLModelSnapshotClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLModelSnapshotClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">aspects</span>)<a href="#datahub.metadata.schema_classes.MLModelSnapshotClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>MLModel Snapshot entity details.</p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>aspects</strong> (<code>List</code>[<code>Union</code>[<a href="#datahub.metadata.schema_classes.MLModelKeyClass"><code>MLModelKeyClass</code></a>, <a href="#datahub.metadata.schema_classes.OwnershipClass"><code>OwnershipClass</code></a>, <a href="#datahub.metadata.schema_classes.MLModelPropertiesClass"><code>MLModelPropertiesClass</code></a>, <a href="#datahub.metadata.schema_classes.IntendedUseClass"><code>IntendedUseClass</code></a>, <a href="#datahub.metadata.schema_classes.MLModelFactorPromptsClass"><code>MLModelFactorPromptsClass</code></a>, <a href="#datahub.metadata.schema_classes.MetricsClass"><code>MetricsClass</code></a>, <a href="#datahub.metadata.schema_classes.EvaluationDataClass"><code>EvaluationDataClass</code></a>, <a href="#datahub.metadata.schema_classes.TrainingDataClass"><code>TrainingDataClass</code></a>, <a href="#datahub.metadata.schema_classes.QuantitativeAnalysesClass"><code>QuantitativeAnalysesClass</code></a>, <a href="#datahub.metadata.schema_classes.EthicalConsiderationsClass"><code>EthicalConsiderationsClass</code></a>, <a href="#datahub.metadata.schema_classes.CaveatsAndRecommendationsClass"><code>CaveatsAndRecommendationsClass</code></a>, <a href="#datahub.metadata.schema_classes.InstitutionalMemoryClass"><code>InstitutionalMemoryClass</code></a>, <a href="#datahub.metadata.schema_classes.SourceCodeClass"><code>SourceCodeClass</code></a>, <a href="#datahub.metadata.schema_classes.StatusClass"><code>StatusClass</code></a>, <a href="#datahub.metadata.schema_classes.CostClass"><code>CostClass</code></a>, <a href="#datahub.metadata.schema_classes.DeprecationClass"><code>DeprecationClass</code></a>, <a href="#datahub.metadata.schema_classes.BrowsePathsClass"><code>BrowsePathsClass</code></a>, <a href="#datahub.metadata.schema_classes.GlobalTagsClass"><code>GlobalTagsClass</code></a>, <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass"><code>DataPlatformInstanceClass</code></a>, <a href="#datahub.metadata.schema_classes.BrowsePathsV2Class"><code>BrowsePathsV2Class</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspects--listmlmodelkeyclass--ownershipclass--mlmodelpropertiesclass--intendeduseclass--mlmodelfactorpromptsclass--metricsclass--evaluationdataclass--trainingdataclass--quantitativeanalysesclass--ethicalconsiderationsclass--caveatsandrecommendationsclass--institutionalmemoryclass--sourcecodeclass--statusclass--costclass--deprecationclass--browsepathsclass--globaltagsclass--dataplatforminstanceclass--browsepathsv2class"><em>property</em> aspects <em>: List[<a href="#datahub.metadata.schema_classes.MLModelKeyClass">MLModelKeyClass</a> | <a href="#datahub.metadata.schema_classes.OwnershipClass">OwnershipClass</a> | <a href="#datahub.metadata.schema_classes.MLModelPropertiesClass">MLModelPropertiesClass</a> | <a href="#datahub.metadata.schema_classes.IntendedUseClass">IntendedUseClass</a> | <a href="#datahub.metadata.schema_classes.MLModelFactorPromptsClass">MLModelFactorPromptsClass</a> | <a href="#datahub.metadata.schema_classes.MetricsClass">MetricsClass</a> | <a href="#datahub.metadata.schema_classes.EvaluationDataClass">EvaluationDataClass</a> | <a href="#datahub.metadata.schema_classes.TrainingDataClass">TrainingDataClass</a> | <a href="#datahub.metadata.schema_classes.QuantitativeAnalysesClass">QuantitativeAnalysesClass</a> | <a href="#datahub.metadata.schema_classes.EthicalConsiderationsClass">EthicalConsiderationsClass</a> | <a href="#datahub.metadata.schema_classes.CaveatsAndRecommendationsClass">CaveatsAndRecommendationsClass</a> | <a href="#datahub.metadata.schema_classes.InstitutionalMemoryClass">InstitutionalMemoryClass</a> | <a href="#datahub.metadata.schema_classes.SourceCodeClass">SourceCodeClass</a> | <a href="#datahub.metadata.schema_classes.StatusClass">StatusClass</a> | <a href="#datahub.metadata.schema_classes.CostClass">CostClass</a> | <a href="#datahub.metadata.schema_classes.DeprecationClass">DeprecationClass</a> | <a href="#datahub.metadata.schema_classes.BrowsePathsClass">BrowsePathsClass</a> | <a href="#datahub.metadata.schema_classes.GlobalTagsClass">GlobalTagsClass</a> | <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass">DataPlatformInstanceClass</a> | <a href="#datahub.metadata.schema_classes.BrowsePathsV2Class">BrowsePathsV2Class</a>]</em><a href="#property-aspects--listmlmodelkeyclass--ownershipclass--mlmodelpropertiesclass--intendeduseclass--mlmodelfactorpromptsclass--metricsclass--evaluationdataclass--trainingdataclass--quantitativeanalysesclass--ethicalconsiderationsclass--caveatsandrecommendationsclass--institutionalmemoryclass--sourcecodeclass--statusclass--costclass--deprecationclass--browsepathsclass--globaltagsclass--dataplatforminstanceclass--browsepathsv2class" class="hash-link" aria-label="Direct link to property-aspects--listmlmodelkeyclass--ownershipclass--mlmodelpropertiesclass--intendeduseclass--mlmodelfactorpromptsclass--metricsclass--evaluationdataclass--trainingdataclass--quantitativeanalysesclass--ethicalconsiderationsclass--caveatsandrecommendationsclass--institutionalmemoryclass--sourcecodeclass--statusclass--costclass--deprecationclass--browsepathsclass--globaltagsclass--dataplatforminstanceclass--browsepathsv2class" title="Direct link to property-aspects--listmlmodelkeyclass--ownershipclass--mlmodelpropertiesclass--intendeduseclass--mlmodelfactorpromptsclass--metricsclass--evaluationdataclass--trainingdataclass--quantitativeanalysesclass--ethicalconsiderationsclass--caveatsandrecommendationsclass--institutionalmemoryclass--sourcecodeclass--statusclass--costclass--deprecationclass--browsepathsclass--globaltagsclass--dataplatforminstanceclass--browsepathsv2class"></a></h4><p>The list of metadata aspects associated with the MLModel. Depending on the use case, this can either be all, or a selection, of supported aspects.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-20"><em>property</em> urn <em>: str</em><a href="#property-urn--str-20" class="hash-link" aria-label="Direct link to property-urn--str-20" title="Direct link to property-urn--str-20"></a></h4><p>URN for the entity the metadata snapshot is associated with.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLPrimaryKeyKeyClass"><span class="visually-hidden">MLPrimaryKeyKeyClass</span><a href="#datahub.metadata.schema_classes.MLPrimaryKeyKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLPrimaryKeyKeyClass" title="Direct link to datahub.metadata.schema_classes.MLPrimaryKeyKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLPrimaryKeyKeyClass</span>(<span class="arg-name">featureNamespace</span>, <span class="arg-name">name</span>)<a href="#datahub.metadata.schema_classes.MLPrimaryKeyKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for an MLPrimaryKey</p><ul><li><strong>Parameters:</strong><ul><li><strong>featureNamespace</strong> (<code>str</code>)</li><li><strong>name</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-featurenamespace--str-1"><em>property</em> featureNamespace <em>: str</em><a href="#property-featurenamespace--str-1" class="hash-link" aria-label="Direct link to property-featurenamespace--str-1" title="Direct link to property-featurenamespace--str-1"></a></h4><p>Namespace for the primary key</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-29"><em>property</em> name <em>: str</em><a href="#property-name--str-29" class="hash-link" aria-label="Direct link to property-name--str-29" title="Direct link to property-name--str-29"></a></h4><p>Name of the primary key</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLPrimaryKeyPropertiesClass"><span class="visually-hidden">MLPrimaryKeyPropertiesClass</span><a href="#datahub.metadata.schema_classes.MLPrimaryKeyPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLPrimaryKeyPropertiesClass" title="Direct link to datahub.metadata.schema_classes.MLPrimaryKeyPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLPrimaryKeyPropertiesClass</span>(<span class="arg-name">sources</span>, <span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">dataType</span> = <span class="arg-default">None</span>, <span class="arg-name">version</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.MLPrimaryKeyPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties associated with a MLPrimaryKey</p><ul><li><strong>Parameters:</strong><ul><li><strong>sources</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>dataType</strong> (<code>Union</code>[<code>None</code>, <code>str</code>, <a href="#datahub.metadata.schema_classes.MLFeatureDataTypeClass"><code>MLFeatureDataTypeClass</code></a>]) – </li><li><strong>version</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.VersionTagClass"><code>VersionTagClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-24"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-24" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-24" title="Direct link to property-customproperties--dictstr-str-24"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-datatype--none--str--mlfeaturedatatypeclass-1"><em>property</em> dataType <em>: None | str | <a href="#datahub.metadata.schema_classes.MLFeatureDataTypeClass">MLFeatureDataTypeClass</a></em><a href="#property-datatype--none--str--mlfeaturedatatypeclass-1" class="hash-link" aria-label="Direct link to property-datatype--none--str--mlfeaturedatatypeclass-1" title="Direct link to property-datatype--none--str--mlfeaturedatatypeclass-1"></a></h4><p>Data Type of the MLPrimaryKey</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-41"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-41" class="hash-link" aria-label="Direct link to property-description--none--str-41" title="Direct link to property-description--none--str-41"></a></h4><p>Documentation of the MLPrimaryKey</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-sources--liststr"><em>property</em> sources <em>: List<!-- -->[str]</em><a href="#property-sources--liststr" class="hash-link" aria-label="Direct link to property-sources--liststr" title="Direct link to property-sources--liststr"></a></h4><p>Source of the MLPrimaryKey</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-version--none--versiontagclass-4"><em>property</em> version <em>: None | <a href="#datahub.metadata.schema_classes.VersionTagClass">VersionTagClass</a></em><a href="#property-version--none--versiontagclass-4" class="hash-link" aria-label="Direct link to property-version--none--versiontagclass-4" title="Direct link to property-version--none--versiontagclass-4"></a></h4><p>Version of the MLPrimaryKey</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLPrimaryKeySnapshotClass"><span class="visually-hidden">MLPrimaryKeySnapshotClass</span><a href="#datahub.metadata.schema_classes.MLPrimaryKeySnapshotClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLPrimaryKeySnapshotClass" title="Direct link to datahub.metadata.schema_classes.MLPrimaryKeySnapshotClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLPrimaryKeySnapshotClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">aspects</span>)<a href="#datahub.metadata.schema_classes.MLPrimaryKeySnapshotClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>aspects</strong> (<code>List</code>[<code>Union</code>[<a href="#datahub.metadata.schema_classes.MLPrimaryKeyKeyClass"><code>MLPrimaryKeyKeyClass</code></a>, <a href="#datahub.metadata.schema_classes.MLPrimaryKeyPropertiesClass"><code>MLPrimaryKeyPropertiesClass</code></a>, <a href="#datahub.metadata.schema_classes.OwnershipClass"><code>OwnershipClass</code></a>, <a href="#datahub.metadata.schema_classes.InstitutionalMemoryClass"><code>InstitutionalMemoryClass</code></a>, <a href="#datahub.metadata.schema_classes.StatusClass"><code>StatusClass</code></a>, <a href="#datahub.metadata.schema_classes.DeprecationClass"><code>DeprecationClass</code></a>, <a href="#datahub.metadata.schema_classes.GlobalTagsClass"><code>GlobalTagsClass</code></a>, <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass"><code>DataPlatformInstanceClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspects--listmlprimarykeykeyclass--mlprimarykeypropertiesclass--ownershipclass--institutionalmemoryclass--statusclass--deprecationclass--globaltagsclass--dataplatforminstanceclass"><em>property</em> aspects <em>: List[<a href="#datahub.metadata.schema_classes.MLPrimaryKeyKeyClass">MLPrimaryKeyKeyClass</a> | <a href="#datahub.metadata.schema_classes.MLPrimaryKeyPropertiesClass">MLPrimaryKeyPropertiesClass</a> | <a href="#datahub.metadata.schema_classes.OwnershipClass">OwnershipClass</a> | <a href="#datahub.metadata.schema_classes.InstitutionalMemoryClass">InstitutionalMemoryClass</a> | <a href="#datahub.metadata.schema_classes.StatusClass">StatusClass</a> | <a href="#datahub.metadata.schema_classes.DeprecationClass">DeprecationClass</a> | <a href="#datahub.metadata.schema_classes.GlobalTagsClass">GlobalTagsClass</a> | <a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass">DataPlatformInstanceClass</a>]</em><a href="#property-aspects--listmlprimarykeykeyclass--mlprimarykeypropertiesclass--ownershipclass--institutionalmemoryclass--statusclass--deprecationclass--globaltagsclass--dataplatforminstanceclass" class="hash-link" aria-label="Direct link to property-aspects--listmlprimarykeykeyclass--mlprimarykeypropertiesclass--ownershipclass--institutionalmemoryclass--statusclass--deprecationclass--globaltagsclass--dataplatforminstanceclass" title="Direct link to property-aspects--listmlprimarykeykeyclass--mlprimarykeypropertiesclass--ownershipclass--institutionalmemoryclass--statusclass--deprecationclass--globaltagsclass--dataplatforminstanceclass"></a></h4><p>The list of metadata aspects associated with the MLPrimaryKey. Depending on the use case, this can either be all, or a selection, of supported aspects.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-21"><em>property</em> urn <em>: str</em><a href="#property-urn--str-21" class="hash-link" aria-label="Direct link to property-urn--str-21" title="Direct link to property-urn--str-21"></a></h4><p>URN for the entity the metadata snapshot is associated with.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MLTrainingRunPropertiesClass"><span class="visually-hidden">MLTrainingRunPropertiesClass</span><a href="#datahub.metadata.schema_classes.MLTrainingRunPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MLTrainingRunPropertiesClass" title="Direct link to datahub.metadata.schema_classes.MLTrainingRunPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MLTrainingRunPropertiesClass</span>(<span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">externalUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">id</span> = <span class="arg-default">None</span>, <span class="arg-name">outputUrls</span> = <span class="arg-default">None</span>, <span class="arg-name">hyperParams</span> = <span class="arg-default">None</span>, <span class="arg-name">trainingMetrics</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.MLTrainingRunPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>The inputs and outputs of this training run</p><ul><li><strong>Parameters:</strong><ul><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>externalUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>id</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>outputUrls</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>hyperParams</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.MLHyperParamClass"><code>MLHyperParamClass</code></a>]]) – </li><li><strong>trainingMetrics</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.MLMetricClass"><code>MLMetricClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-25"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-25" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-25" title="Direct link to property-customproperties--dictstr-str-25"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-externalurl--none--str-16"><em>property</em> externalUrl <em>: None | str</em><a href="#property-externalurl--none--str-16" class="hash-link" aria-label="Direct link to property-externalurl--none--str-16" title="Direct link to property-externalurl--none--str-16"></a></h4><p>URL where the reference exist</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-hyperparams--none--listmlhyperparamclass-1"><em>property</em> hyperParams <em>: None | List[<a href="#datahub.metadata.schema_classes.MLHyperParamClass">MLHyperParamClass</a>]</em><a href="#property-hyperparams--none--listmlhyperparamclass-1" class="hash-link" aria-label="Direct link to property-hyperparams--none--listmlhyperparamclass-1" title="Direct link to property-hyperparams--none--listmlhyperparamclass-1"></a></h4><p>Hyperparameters of the ML Training Run</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--none--str-2"><em>property</em> id <em>: None | str</em><a href="#property-id--none--str-2" class="hash-link" aria-label="Direct link to property-id--none--str-2" title="Direct link to property-id--none--str-2"></a></h4><p>Run Id of the ML Training Run</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-outputurls--none--liststr"><em>property</em> outputUrls <em>: None | List<!-- -->[str]</em><a href="#property-outputurls--none--liststr" class="hash-link" aria-label="Direct link to property-outputurls--none--liststr" title="Direct link to property-outputurls--none--liststr"></a></h4><p>List of URLs for the Outputs of the ML Training Run</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-trainingmetrics--none--listmlmetricclass-1"><em>property</em> trainingMetrics <em>: None | List[<a href="#datahub.metadata.schema_classes.MLMetricClass">MLMetricClass</a>]</em><a href="#property-trainingmetrics--none--listmlmetricclass-1" class="hash-link" aria-label="Direct link to property-trainingmetrics--none--listmlmetricclass-1" title="Direct link to property-trainingmetrics--none--listmlmetricclass-1"></a></h4><p>Metrics of the ML Training Run</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MapTypeClass"><span class="visually-hidden">MapTypeClass</span><a href="#datahub.metadata.schema_classes.MapTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MapTypeClass" title="Direct link to datahub.metadata.schema_classes.MapTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MapTypeClass</span>(<span class="arg-name">keyType</span> = <span class="arg-default">None</span>, <span class="arg-name">valueType</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.MapTypeClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Map field type.</p><ul><li><strong>Parameters:</strong><ul><li><strong>keyType</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>valueType</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-keytype--none--str"><em>property</em> keyType <em>: None | str</em><a href="#property-keytype--none--str" class="hash-link" aria-label="Direct link to property-keytype--none--str" title="Direct link to property-keytype--none--str"></a></h4><p>Key type in a map</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-valuetype--none--str"><em>property</em> valueType <em>: None | str</em><a href="#property-valuetype--none--str" class="hash-link" aria-label="Direct link to property-valuetype--none--str" title="Direct link to property-valuetype--none--str"></a></h4><p>Type of the value in a map</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MediaClass"><span class="visually-hidden">MediaClass</span><a href="#datahub.metadata.schema_classes.MediaClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MediaClass" title="Direct link to datahub.metadata.schema_classes.MediaClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MediaClass</span>(<span class="arg-name">type</span>, <span class="arg-name">location</span>)<a href="#datahub.metadata.schema_classes.MediaClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Carries information about which roles a user is assigned to.</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.MediaTypeClass"><code>MediaTypeClass</code></a>]) – </li><li><strong>location</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-location--str"><em>property</em> location <em>: str</em><a href="#property-location--str" class="hash-link" aria-label="Direct link to property-location--str" title="Direct link to property-location--str"></a></h4><p>Where the media content is stored.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--mediatypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.MediaTypeClass">MediaTypeClass</a></em><a href="#property-type--str--mediatypeclass" class="hash-link" aria-label="Direct link to property-type--str--mediatypeclass" title="Direct link to property-type--str--mediatypeclass"></a></h4><p>Type of content the Media is storing, e.g. image, video, etc.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MediaTypeClass"><span class="visually-hidden">MediaTypeClass</span><a href="#datahub.metadata.schema_classes.MediaTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MediaTypeClass" title="Direct link to datahub.metadata.schema_classes.MediaTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MediaTypeClass</span>()<a href="#datahub.metadata.schema_classes.MediaTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>Enum defining the type of content a Media object holds.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="image--image-1">IMAGE <em>= 'IMAGE'</em><a href="#image--image-1" class="hash-link" aria-label="Direct link to image--image-1" title="Direct link to image--image-1"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MetadataAttributionClass"><span class="visually-hidden">MetadataAttributionClass</span><a href="#datahub.metadata.schema_classes.MetadataAttributionClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MetadataAttributionClass" title="Direct link to datahub.metadata.schema_classes.MetadataAttributionClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MetadataAttributionClass</span>(<span class="arg-name">time</span>, <span class="arg-name">actor</span>, <span class="arg-name">source</span> = <span class="arg-default">None</span>, <span class="arg-name">sourceDetail</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.MetadataAttributionClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Information about who, why, and how this metadata was applied</p><ul><li><strong>Parameters:</strong><ul><li><strong>time</strong> (<code>int</code>)</li><li><strong>actor</strong> (<code>str</code>)</li><li><strong>source</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>sourceDetail</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-actor--str-3"><em>property</em> actor <em>: str</em><a href="#property-actor--str-3" class="hash-link" aria-label="Direct link to property-actor--str-3" title="Direct link to property-actor--str-3"></a></h4><p>The entity (e.g. a member URN) responsible for applying the assocated metadata. This can
|
||
either be a user (in case of UI edits) or the datahub system for automation.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-source--none--str"><em>property</em> source <em>: None | str</em><a href="#property-source--none--str" class="hash-link" aria-label="Direct link to property-source--none--str" title="Direct link to property-source--none--str"></a></h4><p>The DataHub source responsible for applying the associated metadata. This will only be filled out
|
||
when a DataHub source is responsible. This includes the specific metadata test urn, the automation urn.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-sourcedetail--dictstr-str"><em>property</em> sourceDetail <em>: Dict<!-- -->[str, str]</em><a href="#property-sourcedetail--dictstr-str" class="hash-link" aria-label="Direct link to property-sourcedetail--dictstr-str" title="Direct link to property-sourcedetail--dictstr-str"></a></h4><p>The details associated with why this metadata was applied. For example, this could include
|
||
the actual regex rule, sql statement, ingestion pipeline ID, etc.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-time--int-2"><em>property</em> time <em>: int</em><a href="#property-time--int-2" class="hash-link" aria-label="Direct link to property-time--int-2" title="Direct link to property-time--int-2"></a></h4><p>When this metadata was updated.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MetadataChangeEventClass"><span class="visually-hidden">MetadataChangeEventClass</span><a href="#datahub.metadata.schema_classes.MetadataChangeEventClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MetadataChangeEventClass" title="Direct link to datahub.metadata.schema_classes.MetadataChangeEventClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MetadataChangeEventClass</span>(<span class="arg-name">proposedSnapshot</span>, <span class="arg-name">auditHeader</span> = <span class="arg-default">None</span>, <span class="arg-name">proposedDelta</span> = <span class="arg-default">None</span>, <span class="arg-name">systemMetadata</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.MetadataChangeEventClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Kafka event for proposing a metadata change for an entity. A corresponding MetadataAuditEvent is emitted when the change is accepted and committed, otherwise a FailedMetadataChangeEvent will be emitted instead.</p><ul><li><strong>Parameters:</strong><ul><li><strong>proposedSnapshot</strong> (<code>Union</code>[<a href="#datahub.metadata.schema_classes.ChartSnapshotClass"><code>ChartSnapshotClass</code></a>, <a href="#datahub.metadata.schema_classes.CorpGroupSnapshotClass"><code>CorpGroupSnapshotClass</code></a>, <a href="#datahub.metadata.schema_classes.CorpUserSnapshotClass"><code>CorpUserSnapshotClass</code></a>, <a href="#datahub.metadata.schema_classes.DashboardSnapshotClass"><code>DashboardSnapshotClass</code></a>, <a href="#datahub.metadata.schema_classes.DataFlowSnapshotClass"><code>DataFlowSnapshotClass</code></a>, <a href="#datahub.metadata.schema_classes.DataJobSnapshotClass"><code>DataJobSnapshotClass</code></a>, <a href="#datahub.metadata.schema_classes.DatasetSnapshotClass"><code>DatasetSnapshotClass</code></a>, <a href="#datahub.metadata.schema_classes.DataProcessSnapshotClass"><code>DataProcessSnapshotClass</code></a>, <a href="#datahub.metadata.schema_classes.DataPlatformSnapshotClass"><code>DataPlatformSnapshotClass</code></a>, <a href="#datahub.metadata.schema_classes.MLModelSnapshotClass"><code>MLModelSnapshotClass</code></a>, <a href="#datahub.metadata.schema_classes.MLPrimaryKeySnapshotClass"><code>MLPrimaryKeySnapshotClass</code></a>, <a href="#datahub.metadata.schema_classes.MLFeatureSnapshotClass"><code>MLFeatureSnapshotClass</code></a>, <a href="#datahub.metadata.schema_classes.MLFeatureTableSnapshotClass"><code>MLFeatureTableSnapshotClass</code></a>, <a href="#datahub.metadata.schema_classes.MLModelDeploymentSnapshotClass"><code>MLModelDeploymentSnapshotClass</code></a>, <a href="#datahub.metadata.schema_classes.MLModelGroupSnapshotClass"><code>MLModelGroupSnapshotClass</code></a>, <a href="#datahub.metadata.schema_classes.TagSnapshotClass"><code>TagSnapshotClass</code></a>, <a href="#datahub.metadata.schema_classes.GlossaryTermSnapshotClass"><code>GlossaryTermSnapshotClass</code></a>, <a href="#datahub.metadata.schema_classes.GlossaryNodeSnapshotClass"><code>GlossaryNodeSnapshotClass</code></a>, <a href="#datahub.metadata.schema_classes.DataHubPolicySnapshotClass"><code>DataHubPolicySnapshotClass</code></a>, <a href="#datahub.metadata.schema_classes.SchemaFieldSnapshotClass"><code>SchemaFieldSnapshotClass</code></a>, <a href="#datahub.metadata.schema_classes.DataHubRetentionSnapshotClass"><code>DataHubRetentionSnapshotClass</code></a>]) – </li><li><strong>auditHeader</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.KafkaAuditHeaderClass"><code>KafkaAuditHeaderClass</code></a>]) – </li><li><strong>proposedDelta</strong> (<code>None</code>)</li><li><strong>systemMetadata</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.SystemMetadataClass"><code>SystemMetadataClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-auditheader--none--kafkaauditheaderclass"><em>property</em> auditHeader <em>: None | <a href="#datahub.metadata.schema_classes.KafkaAuditHeaderClass">KafkaAuditHeaderClass</a></em><a href="#property-auditheader--none--kafkaauditheaderclass" class="hash-link" aria-label="Direct link to property-auditheader--none--kafkaauditheaderclass" title="Direct link to property-auditheader--none--kafkaauditheaderclass"></a></h4><p>Kafka audit header. See go/kafkaauditheader for more info.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-proposeddelta--none"><em>property</em> proposedDelta <em>: None</em><a href="#property-proposeddelta--none" class="hash-link" aria-label="Direct link to property-proposeddelta--none" title="Direct link to property-proposeddelta--none"></a></h4><p>Delta of the proposed metadata partial update.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-proposedsnapshot--chartsnapshotclass--corpgroupsnapshotclass--corpusersnapshotclass--dashboardsnapshotclass--dataflowsnapshotclass--datajobsnapshotclass--datasetsnapshotclass--dataprocesssnapshotclass--dataplatformsnapshotclass--mlmodelsnapshotclass--mlprimarykeysnapshotclass--mlfeaturesnapshotclass--mlfeaturetablesnapshotclass--mlmodeldeploymentsnapshotclass--mlmodelgroupsnapshotclass--tagsnapshotclass--glossarytermsnapshotclass--glossarynodesnapshotclass--datahubpolicysnapshotclass--schemafieldsnapshotclass--datahubretentionsnapshotclass"><em>property</em> proposedSnapshot <em>: <a href="#datahub.metadata.schema_classes.ChartSnapshotClass">ChartSnapshotClass</a> | <a href="#datahub.metadata.schema_classes.CorpGroupSnapshotClass">CorpGroupSnapshotClass</a> | <a href="#datahub.metadata.schema_classes.CorpUserSnapshotClass">CorpUserSnapshotClass</a> | <a href="#datahub.metadata.schema_classes.DashboardSnapshotClass">DashboardSnapshotClass</a> | <a href="#datahub.metadata.schema_classes.DataFlowSnapshotClass">DataFlowSnapshotClass</a> | <a href="#datahub.metadata.schema_classes.DataJobSnapshotClass">DataJobSnapshotClass</a> | <a href="#datahub.metadata.schema_classes.DatasetSnapshotClass">DatasetSnapshotClass</a> | <a href="#datahub.metadata.schema_classes.DataProcessSnapshotClass">DataProcessSnapshotClass</a> | <a href="#datahub.metadata.schema_classes.DataPlatformSnapshotClass">DataPlatformSnapshotClass</a> | <a href="#datahub.metadata.schema_classes.MLModelSnapshotClass">MLModelSnapshotClass</a> | <a href="#datahub.metadata.schema_classes.MLPrimaryKeySnapshotClass">MLPrimaryKeySnapshotClass</a> | <a href="#datahub.metadata.schema_classes.MLFeatureSnapshotClass">MLFeatureSnapshotClass</a> | <a href="#datahub.metadata.schema_classes.MLFeatureTableSnapshotClass">MLFeatureTableSnapshotClass</a> | <a href="#datahub.metadata.schema_classes.MLModelDeploymentSnapshotClass">MLModelDeploymentSnapshotClass</a> | <a href="#datahub.metadata.schema_classes.MLModelGroupSnapshotClass">MLModelGroupSnapshotClass</a> | <a href="#datahub.metadata.schema_classes.TagSnapshotClass">TagSnapshotClass</a> | <a href="#datahub.metadata.schema_classes.GlossaryTermSnapshotClass">GlossaryTermSnapshotClass</a> | <a href="#datahub.metadata.schema_classes.GlossaryNodeSnapshotClass">GlossaryNodeSnapshotClass</a> | <a href="#datahub.metadata.schema_classes.DataHubPolicySnapshotClass">DataHubPolicySnapshotClass</a> | <a href="#datahub.metadata.schema_classes.SchemaFieldSnapshotClass">SchemaFieldSnapshotClass</a> | <a href="#datahub.metadata.schema_classes.DataHubRetentionSnapshotClass">DataHubRetentionSnapshotClass</a></em><a href="#property-proposedsnapshot--chartsnapshotclass--corpgroupsnapshotclass--corpusersnapshotclass--dashboardsnapshotclass--dataflowsnapshotclass--datajobsnapshotclass--datasetsnapshotclass--dataprocesssnapshotclass--dataplatformsnapshotclass--mlmodelsnapshotclass--mlprimarykeysnapshotclass--mlfeaturesnapshotclass--mlfeaturetablesnapshotclass--mlmodeldeploymentsnapshotclass--mlmodelgroupsnapshotclass--tagsnapshotclass--glossarytermsnapshotclass--glossarynodesnapshotclass--datahubpolicysnapshotclass--schemafieldsnapshotclass--datahubretentionsnapshotclass" class="hash-link" aria-label="Direct link to property-proposedsnapshot--chartsnapshotclass--corpgroupsnapshotclass--corpusersnapshotclass--dashboardsnapshotclass--dataflowsnapshotclass--datajobsnapshotclass--datasetsnapshotclass--dataprocesssnapshotclass--dataplatformsnapshotclass--mlmodelsnapshotclass--mlprimarykeysnapshotclass--mlfeaturesnapshotclass--mlfeaturetablesnapshotclass--mlmodeldeploymentsnapshotclass--mlmodelgroupsnapshotclass--tagsnapshotclass--glossarytermsnapshotclass--glossarynodesnapshotclass--datahubpolicysnapshotclass--schemafieldsnapshotclass--datahubretentionsnapshotclass" title="Direct link to property-proposedsnapshot--chartsnapshotclass--corpgroupsnapshotclass--corpusersnapshotclass--dashboardsnapshotclass--dataflowsnapshotclass--datajobsnapshotclass--datasetsnapshotclass--dataprocesssnapshotclass--dataplatformsnapshotclass--mlmodelsnapshotclass--mlprimarykeysnapshotclass--mlfeaturesnapshotclass--mlfeaturetablesnapshotclass--mlmodeldeploymentsnapshotclass--mlmodelgroupsnapshotclass--tagsnapshotclass--glossarytermsnapshotclass--glossarynodesnapshotclass--datahubpolicysnapshotclass--schemafieldsnapshotclass--datahubretentionsnapshotclass"></a></h4><p>Snapshot of the proposed metadata change. Include only the aspects affected by the change in the snapshot.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-systemmetadata--none--systemmetadataclass"><em>property</em> systemMetadata <em>: None | <a href="#datahub.metadata.schema_classes.SystemMetadataClass">SystemMetadataClass</a></em><a href="#property-systemmetadata--none--systemmetadataclass" class="hash-link" aria-label="Direct link to property-systemmetadata--none--systemmetadataclass" title="Direct link to property-systemmetadata--none--systemmetadataclass"></a></h4><p>Metadata around how the snapshot was ingested</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MetadataChangeLogClass"><span class="visually-hidden">MetadataChangeLogClass</span><a href="#datahub.metadata.schema_classes.MetadataChangeLogClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MetadataChangeLogClass" title="Direct link to datahub.metadata.schema_classes.MetadataChangeLogClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MetadataChangeLogClass</span>(<span class="arg-name">entityType</span>, <span class="arg-name">changeType</span>, <span class="arg-name">auditHeader</span> = <span class="arg-default">None</span>, <span class="arg-name">entityUrn</span> = <span class="arg-default">None</span>, <span class="arg-name">entityKeyAspect</span> = <span class="arg-default">None</span>, <span class="arg-name">aspectName</span> = <span class="arg-default">None</span>, <span class="arg-name">aspect</span> = <span class="arg-default">None</span>, <span class="arg-name">systemMetadata</span> = <span class="arg-default">None</span>, <span class="arg-name">headers</span> = <span class="arg-default">None</span>, <span class="arg-name">previousAspectValue</span> = <span class="arg-default">None</span>, <span class="arg-name">previousSystemMetadata</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.MetadataChangeLogClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Kafka event for capturing update made to an entity’s metadata.</p><ul><li><strong>Parameters:</strong><ul><li><strong>entityType</strong> (<code>str</code>)</li><li><strong>changeType</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.ChangeTypeClass"><code>ChangeTypeClass</code></a>]) – </li><li><strong>auditHeader</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.KafkaAuditHeaderClass"><code>KafkaAuditHeaderClass</code></a>]) – </li><li><strong>entityUrn</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>entityKeyAspect</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.GenericAspectClass"><code>GenericAspectClass</code></a>]) – </li><li><strong>aspectName</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>aspect</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.GenericAspectClass"><code>GenericAspectClass</code></a>]) – </li><li><strong>systemMetadata</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.SystemMetadataClass"><code>SystemMetadataClass</code></a>]) – </li><li><strong>headers</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>previousAspectValue</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.GenericAspectClass"><code>GenericAspectClass</code></a>]) – </li><li><strong>previousSystemMetadata</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.SystemMetadataClass"><code>SystemMetadataClass</code></a>]) – </li><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspect--none--genericaspectclass"><em>property</em> aspect <em>: None | <a href="#datahub.metadata.schema_classes.GenericAspectClass">GenericAspectClass</a></em><a href="#property-aspect--none--genericaspectclass" class="hash-link" aria-label="Direct link to property-aspect--none--genericaspectclass" title="Direct link to property-aspect--none--genericaspectclass"></a></h4><p>The value of the new aspect.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspectname--none--str"><em>property</em> aspectName <em>: None | str</em><a href="#property-aspectname--none--str" class="hash-link" aria-label="Direct link to property-aspectname--none--str" title="Direct link to property-aspectname--none--str"></a></h4><p>Aspect of the entity being written to
|
||
Not filling this out implies that the writer wants to affect the entire entity
|
||
Note: This is only valid for CREATE, UPSERT, and DELETE operations.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-auditheader--none--kafkaauditheaderclass-1"><em>property</em> auditHeader <em>: None | <a href="#datahub.metadata.schema_classes.KafkaAuditHeaderClass">KafkaAuditHeaderClass</a></em><a href="#property-auditheader--none--kafkaauditheaderclass-1" class="hash-link" aria-label="Direct link to property-auditheader--none--kafkaauditheaderclass-1" title="Direct link to property-auditheader--none--kafkaauditheaderclass-1"></a></h4><p>Kafka audit header. Currently remains unused in the open source.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-changetype--str--changetypeclass"><em>property</em> changeType <em>: str | <a href="#datahub.metadata.schema_classes.ChangeTypeClass">ChangeTypeClass</a></em><a href="#property-changetype--str--changetypeclass" class="hash-link" aria-label="Direct link to property-changetype--str--changetypeclass" title="Direct link to property-changetype--str--changetypeclass"></a></h4><p>Type of change being proposed</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--none--auditstampclass-7"><em>property</em> created <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--none--auditstampclass-7" class="hash-link" aria-label="Direct link to property-created--none--auditstampclass-7" title="Direct link to property-created--none--auditstampclass-7"></a></h4><p>An audit stamp detailing who and when the aspect was changed by. Required for all intents and purposes.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-entitykeyaspect--none--genericaspectclass"><em>property</em> entityKeyAspect <em>: None | <a href="#datahub.metadata.schema_classes.GenericAspectClass">GenericAspectClass</a></em><a href="#property-entitykeyaspect--none--genericaspectclass" class="hash-link" aria-label="Direct link to property-entitykeyaspect--none--genericaspectclass" title="Direct link to property-entitykeyaspect--none--genericaspectclass"></a></h4><p>Key aspect of the entity being written</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-entitytype--str-1"><em>property</em> entityType <em>: str</em><a href="#property-entitytype--str-1" class="hash-link" aria-label="Direct link to property-entitytype--str-1" title="Direct link to property-entitytype--str-1"></a></h4><p>Type of the entity being written to</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-entityurn--none--str"><em>property</em> entityUrn <em>: None | str</em><a href="#property-entityurn--none--str" class="hash-link" aria-label="Direct link to property-entityurn--none--str" title="Direct link to property-entityurn--none--str"></a></h4><p>Urn of the entity being written</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-headers--none--dictstr-str"><em>property</em> headers <em>: None | Dict<!-- -->[str, str]</em><a href="#property-headers--none--dictstr-str" class="hash-link" aria-label="Direct link to property-headers--none--dictstr-str" title="Direct link to property-headers--none--dictstr-str"></a></h4><p>Headers - intended to mimic http headers</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-previousaspectvalue--none--genericaspectclass"><em>property</em> previousAspectValue <em>: None | <a href="#datahub.metadata.schema_classes.GenericAspectClass">GenericAspectClass</a></em><a href="#property-previousaspectvalue--none--genericaspectclass" class="hash-link" aria-label="Direct link to property-previousaspectvalue--none--genericaspectclass" title="Direct link to property-previousaspectvalue--none--genericaspectclass"></a></h4><p>The previous value of the aspect that has changed.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-previoussystemmetadata--none--systemmetadataclass"><em>property</em> previousSystemMetadata <em>: None | <a href="#datahub.metadata.schema_classes.SystemMetadataClass">SystemMetadataClass</a></em><a href="#property-previoussystemmetadata--none--systemmetadataclass" class="hash-link" aria-label="Direct link to property-previoussystemmetadata--none--systemmetadataclass" title="Direct link to property-previoussystemmetadata--none--systemmetadataclass"></a></h4><p>The previous value of the system metadata field that has changed.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-systemmetadata--none--systemmetadataclass-1"><em>property</em> systemMetadata <em>: None | <a href="#datahub.metadata.schema_classes.SystemMetadataClass">SystemMetadataClass</a></em><a href="#property-systemmetadata--none--systemmetadataclass-1" class="hash-link" aria-label="Direct link to property-systemmetadata--none--systemmetadataclass-1" title="Direct link to property-systemmetadata--none--systemmetadataclass-1"></a></h4><p>System properties that one might want to attach to an event</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MetadataChangeProposalClass"><span class="visually-hidden">MetadataChangeProposalClass</span><a href="#datahub.metadata.schema_classes.MetadataChangeProposalClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MetadataChangeProposalClass" title="Direct link to datahub.metadata.schema_classes.MetadataChangeProposalClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MetadataChangeProposalClass</span>(<span class="arg-name">entityType</span>, <span class="arg-name">changeType</span>, <span class="arg-name">auditHeader</span> = <span class="arg-default">None</span>, <span class="arg-name">entityUrn</span> = <span class="arg-default">None</span>, <span class="arg-name">entityKeyAspect</span> = <span class="arg-default">None</span>, <span class="arg-name">aspectName</span> = <span class="arg-default">None</span>, <span class="arg-name">aspect</span> = <span class="arg-default">None</span>, <span class="arg-name">systemMetadata</span> = <span class="arg-default">None</span>, <span class="arg-name">headers</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.MetadataChangeProposalClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Kafka event for proposing a metadata change for an entity. A corresponding MetadataChangeLog is emitted when the change is accepted and committed, otherwise a FailedMetadataChangeProposal will be emitted instead.</p><ul><li><strong>Parameters:</strong><ul><li><strong>entityType</strong> (<code>str</code>)</li><li><strong>changeType</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.ChangeTypeClass"><code>ChangeTypeClass</code></a>]) – </li><li><strong>auditHeader</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.KafkaAuditHeaderClass"><code>KafkaAuditHeaderClass</code></a>]) – </li><li><strong>entityUrn</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>entityKeyAspect</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.GenericAspectClass"><code>GenericAspectClass</code></a>]) – </li><li><strong>aspectName</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>aspect</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.GenericAspectClass"><code>GenericAspectClass</code></a>]) – </li><li><strong>systemMetadata</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.SystemMetadataClass"><code>SystemMetadataClass</code></a>]) – </li><li><strong>headers</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspect--none--genericaspectclass-1"><em>property</em> aspect <em>: None | <a href="#datahub.metadata.schema_classes.GenericAspectClass">GenericAspectClass</a></em><a href="#property-aspect--none--genericaspectclass-1" class="hash-link" aria-label="Direct link to property-aspect--none--genericaspectclass-1" title="Direct link to property-aspect--none--genericaspectclass-1"></a></h4><p>The value of the new aspect.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspectname--none--str-1"><em>property</em> aspectName <em>: None | str</em><a href="#property-aspectname--none--str-1" class="hash-link" aria-label="Direct link to property-aspectname--none--str-1" title="Direct link to property-aspectname--none--str-1"></a></h4><p>Aspect of the entity being written to
|
||
Not filling this out implies that the writer wants to affect the entire entity
|
||
Note: This is only valid for CREATE, UPSERT, and DELETE operations.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-auditheader--none--kafkaauditheaderclass-2"><em>property</em> auditHeader <em>: None | <a href="#datahub.metadata.schema_classes.KafkaAuditHeaderClass">KafkaAuditHeaderClass</a></em><a href="#property-auditheader--none--kafkaauditheaderclass-2" class="hash-link" aria-label="Direct link to property-auditheader--none--kafkaauditheaderclass-2" title="Direct link to property-auditheader--none--kafkaauditheaderclass-2"></a></h4><p>Kafka audit header. Currently remains unused in the open source.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-changetype--str--changetypeclass-1"><em>property</em> changeType <em>: str | <a href="#datahub.metadata.schema_classes.ChangeTypeClass">ChangeTypeClass</a></em><a href="#property-changetype--str--changetypeclass-1" class="hash-link" aria-label="Direct link to property-changetype--str--changetypeclass-1" title="Direct link to property-changetype--str--changetypeclass-1"></a></h4><p>Type of change being proposed</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-entitykeyaspect--none--genericaspectclass-1"><em>property</em> entityKeyAspect <em>: None | <a href="#datahub.metadata.schema_classes.GenericAspectClass">GenericAspectClass</a></em><a href="#property-entitykeyaspect--none--genericaspectclass-1" class="hash-link" aria-label="Direct link to property-entitykeyaspect--none--genericaspectclass-1" title="Direct link to property-entitykeyaspect--none--genericaspectclass-1"></a></h4><p>Key aspect of the entity being written</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-entitytype--str-2"><em>property</em> entityType <em>: str</em><a href="#property-entitytype--str-2" class="hash-link" aria-label="Direct link to property-entitytype--str-2" title="Direct link to property-entitytype--str-2"></a></h4><p>Type of the entity being written to</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-entityurn--none--str-1"><em>property</em> entityUrn <em>: None | str</em><a href="#property-entityurn--none--str-1" class="hash-link" aria-label="Direct link to property-entityurn--none--str-1" title="Direct link to property-entityurn--none--str-1"></a></h4><p>Urn of the entity being written</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-headers--none--dictstr-str-1"><em>property</em> headers <em>: None | Dict<!-- -->[str, str]</em><a href="#property-headers--none--dictstr-str-1" class="hash-link" aria-label="Direct link to property-headers--none--dictstr-str-1" title="Direct link to property-headers--none--dictstr-str-1"></a></h4><p>Headers - intended to mimic http headers</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-systemmetadata--none--systemmetadataclass-2"><em>property</em> systemMetadata <em>: None | <a href="#datahub.metadata.schema_classes.SystemMetadataClass">SystemMetadataClass</a></em><a href="#property-systemmetadata--none--systemmetadataclass-2" class="hash-link" aria-label="Direct link to property-systemmetadata--none--systemmetadataclass-2" title="Direct link to property-systemmetadata--none--systemmetadataclass-2"></a></h4><p>System properties that one might want to attach to an event</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MetricsClass"><span class="visually-hidden">MetricsClass</span><a href="#datahub.metadata.schema_classes.MetricsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MetricsClass" title="Direct link to datahub.metadata.schema_classes.MetricsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MetricsClass</span>(<span class="arg-name">performanceMeasures</span> = <span class="arg-default">None</span>, <span class="arg-name">decisionThreshold</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.MetricsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Metrics to be featured for the MLModel.</p><ul><li><strong>Parameters:</strong><ul><li><strong>performanceMeasures</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>decisionThreshold</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-decisionthreshold--none--liststr"><em>property</em> decisionThreshold <em>: None | List<!-- -->[str]</em><a href="#property-decisionthreshold--none--liststr" class="hash-link" aria-label="Direct link to property-decisionthreshold--none--liststr" title="Direct link to property-decisionthreshold--none--liststr"></a></h4><p>Decision Thresholds used (if any)?</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-performancemeasures--none--liststr"><em>property</em> performanceMeasures <em>: None | List<!-- -->[str]</em><a href="#property-performancemeasures--none--liststr" class="hash-link" aria-label="Direct link to property-performancemeasures--none--liststr" title="Direct link to property-performancemeasures--none--liststr"></a></h4><p>Measures of MLModel performance</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.MySqlDDLClass"><span class="visually-hidden">MySqlDDLClass</span><a href="#datahub.metadata.schema_classes.MySqlDDLClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.MySqlDDLClass" title="Direct link to datahub.metadata.schema_classes.MySqlDDLClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">MySqlDDLClass</span>(<span class="arg-name">tableSchema</span>)<a href="#datahub.metadata.schema_classes.MySqlDDLClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Schema holder for MySql data definition language that describes an MySql table.</p><ul><li><strong>Parameters:</strong><strong>tableSchema</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-tableschema--str-1"><em>property</em> tableSchema <em>: str</em><a href="#property-tableschema--str-1" class="hash-link" aria-label="Direct link to property-tableschema--str-1" title="Direct link to property-tableschema--str-1"></a></h4><p>The native schema in the dataset’s platform. This is a human readable (json blob) table schema.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.NativeGroupMembershipClass"><span class="visually-hidden">NativeGroupMembershipClass</span><a href="#datahub.metadata.schema_classes.NativeGroupMembershipClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.NativeGroupMembershipClass" title="Direct link to datahub.metadata.schema_classes.NativeGroupMembershipClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">NativeGroupMembershipClass</span>(<span class="arg-name">nativeGroups</span>)<a href="#datahub.metadata.schema_classes.NativeGroupMembershipClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Carries information about the native CorpGroups a user is in.</p><ul><li><strong>Parameters:</strong><strong>nativeGroups</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-nativegroups--liststr"><em>property</em> nativeGroups <em>: List<!-- -->[str]</em><a href="#property-nativegroups--liststr" class="hash-link" aria-label="Direct link to property-nativegroups--liststr" title="Direct link to property-nativegroups--liststr"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.NotebookCellClass"><span class="visually-hidden">NotebookCellClass</span><a href="#datahub.metadata.schema_classes.NotebookCellClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.NotebookCellClass" title="Direct link to datahub.metadata.schema_classes.NotebookCellClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">NotebookCellClass</span>(<span class="arg-name">type</span>, <span class="arg-name">textCell</span> = <span class="arg-default">None</span>, <span class="arg-name">queryCell</span> = <span class="arg-default">None</span>, <span class="arg-name">chartCell</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.NotebookCellClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A record of all supported cells for a Notebook. Only one type of cell will be non-null.</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.NotebookCellTypeClass"><code>NotebookCellTypeClass</code></a>]) – </li><li><strong>textCell</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TextCellClass"><code>TextCellClass</code></a>]) – </li><li><strong>queryCell</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.QueryCellClass"><code>QueryCellClass</code></a>]) – </li><li><strong>chartCell</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.ChartCellClass"><code>ChartCellClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-chartcell--none--chartcellclass"><em>property</em> chartCell <em>: None | <a href="#datahub.metadata.schema_classes.ChartCellClass">ChartCellClass</a></em><a href="#property-chartcell--none--chartcellclass" class="hash-link" aria-label="Direct link to property-chartcell--none--chartcellclass" title="Direct link to property-chartcell--none--chartcellclass"></a></h4><p>The chart cell content. The will be non-null only when all other cell field is null.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-querycell--none--querycellclass"><em>property</em> queryCell <em>: None | <a href="#datahub.metadata.schema_classes.QueryCellClass">QueryCellClass</a></em><a href="#property-querycell--none--querycellclass" class="hash-link" aria-label="Direct link to property-querycell--none--querycellclass" title="Direct link to property-querycell--none--querycellclass"></a></h4><p>The query cell content. The will be non-null only when all other cell field is null.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-textcell--none--textcellclass"><em>property</em> textCell <em>: None | <a href="#datahub.metadata.schema_classes.TextCellClass">TextCellClass</a></em><a href="#property-textcell--none--textcellclass" class="hash-link" aria-label="Direct link to property-textcell--none--textcellclass" title="Direct link to property-textcell--none--textcellclass"></a></h4><p>The text cell content. The will be non-null only when all other cell field is null.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--notebookcelltypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.NotebookCellTypeClass">NotebookCellTypeClass</a></em><a href="#property-type--str--notebookcelltypeclass" class="hash-link" aria-label="Direct link to property-type--str--notebookcelltypeclass" title="Direct link to property-type--str--notebookcelltypeclass"></a></h4><p>The type of this Notebook cell</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.NotebookCellTypeClass"><span class="visually-hidden">NotebookCellTypeClass</span><a href="#datahub.metadata.schema_classes.NotebookCellTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.NotebookCellTypeClass" title="Direct link to datahub.metadata.schema_classes.NotebookCellTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">NotebookCellTypeClass</span>()<a href="#datahub.metadata.schema_classes.NotebookCellTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>Type of Notebook Cell</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="chart_cell--chart_cell">CHART_CELL <em>= 'CHART_CELL'</em><a href="#chart_cell--chart_cell" class="hash-link" aria-label="Direct link to chart_cell--chart_cell" title="Direct link to chart_cell--chart_cell"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="query_cell--query_cell">QUERY_CELL <em>= 'QUERY_CELL'</em><a href="#query_cell--query_cell" class="hash-link" aria-label="Direct link to query_cell--query_cell" title="Direct link to query_cell--query_cell"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="text_cell--text_cell">TEXT_CELL <em>= 'TEXT_CELL'</em><a href="#text_cell--text_cell" class="hash-link" aria-label="Direct link to text_cell--text_cell" title="Direct link to text_cell--text_cell"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.NotebookContentClass"><span class="visually-hidden">NotebookContentClass</span><a href="#datahub.metadata.schema_classes.NotebookContentClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.NotebookContentClass" title="Direct link to datahub.metadata.schema_classes.NotebookContentClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">NotebookContentClass</span>(<span class="arg-name">cells</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.NotebookContentClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Content in a Notebook
|
||
Note: This is IN BETA version</p><ul><li><strong>Parameters:</strong><strong>cells</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.NotebookCellClass"><code>NotebookCellClass</code></a>]]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-cells--listnotebookcellclass"><em>property</em> cells <em>: List[<a href="#datahub.metadata.schema_classes.NotebookCellClass">NotebookCellClass</a>]</em><a href="#property-cells--listnotebookcellclass" class="hash-link" aria-label="Direct link to property-cells--listnotebookcellclass" title="Direct link to property-cells--listnotebookcellclass"></a></h4><p>The content of a Notebook which is composed by a list of NotebookCell</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.NotebookInfoClass"><span class="visually-hidden">NotebookInfoClass</span><a href="#datahub.metadata.schema_classes.NotebookInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.NotebookInfoClass" title="Direct link to datahub.metadata.schema_classes.NotebookInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">NotebookInfoClass</span>(<span class="arg-name">title</span>, <span class="arg-name">changeAuditStamps</span>, <span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">externalUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.NotebookInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a Notebook
|
||
Note: This is IN BETA version</p><ul><li><strong>Parameters:</strong><ul><li><strong>title</strong> (<code>str</code>)</li><li><strong>changeAuditStamps</strong> (<a href="#datahub.metadata.schema_classes.ChangeAuditStampsClass"><code>ChangeAuditStampsClass</code></a>) – </li><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>externalUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-changeauditstamps--changeauditstampsclass-1"><em>property</em> changeAuditStamps <em>: <a href="#datahub.metadata.schema_classes.ChangeAuditStampsClass">ChangeAuditStampsClass</a></em><a href="#property-changeauditstamps--changeauditstampsclass-1" class="hash-link" aria-label="Direct link to property-changeauditstamps--changeauditstampsclass-1" title="Direct link to property-changeauditstamps--changeauditstampsclass-1"></a></h4><p>Captures information about who created/last modified/deleted this Notebook and when</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-26"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-26" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-26" title="Direct link to property-customproperties--dictstr-str-26"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-42"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-42" class="hash-link" aria-label="Direct link to property-description--none--str-42" title="Direct link to property-description--none--str-42"></a></h4><p>Detailed description about the Notebook</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-externalurl--none--str-17"><em>property</em> externalUrl <em>: None | str</em><a href="#property-externalurl--none--str-17" class="hash-link" aria-label="Direct link to property-externalurl--none--str-17" title="Direct link to property-externalurl--none--str-17"></a></h4><p>URL where the reference exist</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-title--str-3"><em>property</em> title <em>: str</em><a href="#property-title--str-3" class="hash-link" aria-label="Direct link to property-title--str-3" title="Direct link to property-title--str-3"></a></h4><p>Title of the Notebook</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.NotebookKeyClass"><span class="visually-hidden">NotebookKeyClass</span><a href="#datahub.metadata.schema_classes.NotebookKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.NotebookKeyClass" title="Direct link to datahub.metadata.schema_classes.NotebookKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">NotebookKeyClass</span>(<span class="arg-name">notebookTool</span>, <span class="arg-name">notebookId</span>)<a href="#datahub.metadata.schema_classes.NotebookKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Notebook</p><ul><li><strong>Parameters:</strong><ul><li><strong>notebookTool</strong> (<code>str</code>)</li><li><strong>notebookId</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-notebookid--str"><em>property</em> notebookId <em>: str</em><a href="#property-notebookid--str" class="hash-link" aria-label="Direct link to property-notebookid--str" title="Direct link to property-notebookid--str"></a></h4><p>Unique id for the Notebook. This id should be globally unique for a Notebook tool even when there are multiple deployments of it. As an example, Notebook URL could be used here for QueryBook such as ‘querybook.com/notebook/773’</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-notebooktool--str"><em>property</em> notebookTool <em>: str</em><a href="#property-notebooktool--str" class="hash-link" aria-label="Direct link to property-notebooktool--str" title="Direct link to property-notebooktool--str"></a></h4><p>The name of the Notebook tool such as QueryBook, etc.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.NotificationSettingsClass"><span class="visually-hidden">NotificationSettingsClass</span><a href="#datahub.metadata.schema_classes.NotificationSettingsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.NotificationSettingsClass" title="Direct link to datahub.metadata.schema_classes.NotificationSettingsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">NotificationSettingsClass</span>(<span class="arg-name">sinkTypes</span>, <span class="arg-name">slackSettings</span> = <span class="arg-default">None</span>, <span class="arg-name">emailSettings</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.NotificationSettingsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Notification settings for an actor or subscription.</p><ul><li><strong>Parameters:</strong><ul><li><strong>sinkTypes</strong> (<code>List</code>[<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.NotificationSinkTypeClass"><code>NotificationSinkTypeClass</code></a>]]) – </li><li><strong>slackSettings</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.SlackNotificationSettingsClass"><code>SlackNotificationSettingsClass</code></a>]) – </li><li><strong>emailSettings</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.EmailNotificationSettingsClass"><code>EmailNotificationSettingsClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-emailsettings--none--emailnotificationsettingsclass"><em>property</em> emailSettings <em>: None | <a href="#datahub.metadata.schema_classes.EmailNotificationSettingsClass">EmailNotificationSettingsClass</a></em><a href="#property-emailsettings--none--emailnotificationsettingsclass" class="hash-link" aria-label="Direct link to property-emailsettings--none--emailnotificationsettingsclass" title="Direct link to property-emailsettings--none--emailnotificationsettingsclass"></a></h4><p>Email Notification Settings</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-sinktypes--liststr--notificationsinktypeclass"><em>property</em> sinkTypes <em>: List[str | <a href="#datahub.metadata.schema_classes.NotificationSinkTypeClass">NotificationSinkTypeClass</a>]</em><a href="#property-sinktypes--liststr--notificationsinktypeclass" class="hash-link" aria-label="Direct link to property-sinktypes--liststr--notificationsinktypeclass" title="Direct link to property-sinktypes--liststr--notificationsinktypeclass"></a></h4><p>Sink types that notifications are sent to.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-slacksettings--none--slacknotificationsettingsclass"><em>property</em> slackSettings <em>: None | <a href="#datahub.metadata.schema_classes.SlackNotificationSettingsClass">SlackNotificationSettingsClass</a></em><a href="#property-slacksettings--none--slacknotificationsettingsclass" class="hash-link" aria-label="Direct link to property-slacksettings--none--slacknotificationsettingsclass" title="Direct link to property-slacksettings--none--slacknotificationsettingsclass"></a></h4><p>Slack Notification Settings</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.NotificationSinkTypeClass"><span class="visually-hidden">NotificationSinkTypeClass</span><a href="#datahub.metadata.schema_classes.NotificationSinkTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.NotificationSinkTypeClass" title="Direct link to datahub.metadata.schema_classes.NotificationSinkTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">NotificationSinkTypeClass</span>()<a href="#datahub.metadata.schema_classes.NotificationSinkTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>A type of sink / platform to send a notification to.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="email--email">EMAIL <em>= 'EMAIL'</em><a href="#email--email" class="hash-link" aria-label="Direct link to email--email" title="Direct link to email--email"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="slack--slack">SLACK <em>= 'SLACK'</em><a href="#slack--slack" class="hash-link" aria-label="Direct link to slack--slack" title="Direct link to slack--slack"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.NullTypeClass"><span class="visually-hidden">NullTypeClass</span><a href="#datahub.metadata.schema_classes.NullTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.NullTypeClass" title="Direct link to datahub.metadata.schema_classes.NullTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">NullTypeClass</span>()<a href="#datahub.metadata.schema_classes.NullTypeClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Null field type.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.NumberTypeClass"><span class="visually-hidden">NumberTypeClass</span><a href="#datahub.metadata.schema_classes.NumberTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.NumberTypeClass" title="Direct link to datahub.metadata.schema_classes.NumberTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">NumberTypeClass</span>()<a href="#datahub.metadata.schema_classes.NumberTypeClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Number data type: long, integer, short, etc..</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.OidcSettingsClass"><span class="visually-hidden">OidcSettingsClass</span><a href="#datahub.metadata.schema_classes.OidcSettingsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.OidcSettingsClass" title="Direct link to datahub.metadata.schema_classes.OidcSettingsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">OidcSettingsClass</span>(<span class="arg-name">enabled</span>, <span class="arg-name">clientId</span>, <span class="arg-name">clientSecret</span>, <span class="arg-name">discoveryUri</span>, <span class="arg-name">userNameClaim</span> = <span class="arg-default">None</span>, <span class="arg-name">userNameClaimRegex</span> = <span class="arg-default">None</span>, <span class="arg-name">scope</span> = <span class="arg-default">None</span>, <span class="arg-name">clientAuthenticationMethod</span> = <span class="arg-default">None</span>, <span class="arg-name">jitProvisioningEnabled</span> = <span class="arg-default">None</span>, <span class="arg-name">preProvisioningRequired</span> = <span class="arg-default">None</span>, <span class="arg-name">extractGroupsEnabled</span> = <span class="arg-default">None</span>, <span class="arg-name">groupsClaim</span> = <span class="arg-default">None</span>, <span class="arg-name">responseType</span> = <span class="arg-default">None</span>, <span class="arg-name">responseMode</span> = <span class="arg-default">None</span>, <span class="arg-name">useNonce</span> = <span class="arg-default">None</span>, <span class="arg-name">readTimeout</span> = <span class="arg-default">None</span>, <span class="arg-name">extractJwtAccessTokenClaims</span> = <span class="arg-default">None</span>, <span class="arg-name">preferredJwsAlgorithm</span> = <span class="arg-default">None</span>, <span class="arg-name">preferredJwsAlgorithm2</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.OidcSettingsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Settings for OIDC SSO integration.</p><ul><li><strong>Parameters:</strong><ul><li><strong>enabled</strong> (<code>bool</code>)</li><li><strong>clientId</strong> (<code>str</code>)</li><li><strong>clientSecret</strong> (<code>str</code>)</li><li><strong>discoveryUri</strong> (<code>str</code>)</li><li><strong>userNameClaim</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>userNameClaimRegex</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>scope</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>clientAuthenticationMethod</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>jitProvisioningEnabled</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>preProvisioningRequired</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>extractGroupsEnabled</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>groupsClaim</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>responseType</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>responseMode</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>useNonce</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>readTimeout</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>extractJwtAccessTokenClaims</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>preferredJwsAlgorithm</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>preferredJwsAlgorithm2</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-clientauthenticationmethod--none--str"><em>property</em> clientAuthenticationMethod <em>: None | str</em><a href="#property-clientauthenticationmethod--none--str" class="hash-link" aria-label="Direct link to property-clientauthenticationmethod--none--str" title="Direct link to property-clientauthenticationmethod--none--str"></a></h4><p>Defaults to “client_secret_basic”.</p><ul><li><strong>Type:</strong>
|
||
ADVANCED. Which authentication method to use to pass credentials (clientId and clientSecret) to the token endpoint</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-clientid--str-1"><em>property</em> clientId <em>: str</em><a href="#property-clientid--str-1" class="hash-link" aria-label="Direct link to property-clientid--str-1" title="Direct link to property-clientid--str-1"></a></h4><p>Unique client id issued by the identity provider.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-clientsecret--str-1"><em>property</em> clientSecret <em>: str</em><a href="#property-clientsecret--str-1" class="hash-link" aria-label="Direct link to property-clientsecret--str-1" title="Direct link to property-clientsecret--str-1"></a></h4><p>Unique client secret issued by the identity provider.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-discoveryuri--str"><em>property</em> discoveryUri <em>: str</em><a href="#property-discoveryuri--str" class="hash-link" aria-label="Direct link to property-discoveryuri--str" title="Direct link to property-discoveryuri--str"></a></h4><p>The IdP OIDC discovery url.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-enabled--bool-1"><em>property</em> enabled <em>: bool</em><a href="#property-enabled--bool-1" class="hash-link" aria-label="Direct link to property-enabled--bool-1" title="Direct link to property-enabled--bool-1"></a></h4><p>Whether OIDC SSO is enabled.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-extractgroupsenabled--none--bool"><em>property</em> extractGroupsEnabled <em>: None | bool</em><a href="#property-extractgroupsenabled--none--bool" class="hash-link" aria-label="Direct link to property-extractgroupsenabled--none--bool" title="Direct link to property-extractgroupsenabled--none--bool"></a></h4><p>ADVANCED. Whether groups should be extracted from a claim in the OIDC profile. Only applies if JIT provisioning is enabled. Groups will be created if they do not exist. Defaults to true.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-extractjwtaccesstokenclaims--none--bool"><em>property</em> extractJwtAccessTokenClaims <em>: None | bool</em><a href="#property-extractjwtaccesstokenclaims--none--bool" class="hash-link" aria-label="Direct link to property-extractjwtaccesstokenclaims--none--bool" title="Direct link to property-extractjwtaccesstokenclaims--none--bool"></a></h4><p>ADVANCED. Whether to extract claims from JWT access token. Defaults to false.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-groupsclaim--none--str"><em>property</em> groupsClaim <em>: None | str</em><a href="#property-groupsclaim--none--str" class="hash-link" aria-label="Direct link to property-groupsclaim--none--str" title="Direct link to property-groupsclaim--none--str"></a></h4><p>ADVANCED. The OIDC claim to extract groups information from. Defaults to ‘groups’.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-jitprovisioningenabled--none--bool"><em>property</em> jitProvisioningEnabled <em>: None | bool</em><a href="#property-jitprovisioningenabled--none--bool" class="hash-link" aria-label="Direct link to property-jitprovisioningenabled--none--bool" title="Direct link to property-jitprovisioningenabled--none--bool"></a></h4><p>ADVANCED. Whether DataHub users should be provisioned on login if they do not exist. Defaults to true.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-preprovisioningrequired--none--bool"><em>property</em> preProvisioningRequired <em>: None | bool</em><a href="#property-preprovisioningrequired--none--bool" class="hash-link" aria-label="Direct link to property-preprovisioningrequired--none--bool" title="Direct link to property-preprovisioningrequired--none--bool"></a></h4><p>ADVANCED. Whether the user should already exist in DataHub on login, failing login if they are not. Defaults to false.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-preferredjwsalgorithm--none--str"><em>property</em> preferredJwsAlgorithm <em>: None | str</em><a href="#property-preferredjwsalgorithm--none--str" class="hash-link" aria-label="Direct link to property-preferredjwsalgorithm--none--str" title="Direct link to property-preferredjwsalgorithm--none--str"></a></h4><p>ADVANCED. Which jws algorithm to use. Unused.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-preferredjwsalgorithm2--none--str"><em>property</em> preferredJwsAlgorithm2 <em>: None | str</em><a href="#property-preferredjwsalgorithm2--none--str" class="hash-link" aria-label="Direct link to property-preferredjwsalgorithm2--none--str" title="Direct link to property-preferredjwsalgorithm2--none--str"></a></h4><p>ADVANCED. Which jws algorithm to use.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-readtimeout--none--int"><em>property</em> readTimeout <em>: None | int</em><a href="#property-readtimeout--none--int" class="hash-link" aria-label="Direct link to property-readtimeout--none--int" title="Direct link to property-readtimeout--none--int"></a></h4><p>ADVANCED. Read timeout.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-responsemode--none--str"><em>property</em> responseMode <em>: None | str</em><a href="#property-responsemode--none--str" class="hash-link" aria-label="Direct link to property-responsemode--none--str" title="Direct link to property-responsemode--none--str"></a></h4><p>ADVANCED. Response mode.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-responsetype--none--str"><em>property</em> responseType <em>: None | str</em><a href="#property-responsetype--none--str" class="hash-link" aria-label="Direct link to property-responsetype--none--str" title="Direct link to property-responsetype--none--str"></a></h4><p>ADVANCED. Response type.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-scope--none--str"><em>property</em> scope <em>: None | str</em><a href="#property-scope--none--str" class="hash-link" aria-label="Direct link to property-scope--none--str" title="Direct link to property-scope--none--str"></a></h4><p>ADVANCED. String representing the requested scope from the IdP. Defaults to “oidc email profile”.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-usenonce--none--bool"><em>property</em> useNonce <em>: None | bool</em><a href="#property-usenonce--none--bool" class="hash-link" aria-label="Direct link to property-usenonce--none--bool" title="Direct link to property-usenonce--none--bool"></a></h4><p>ADVANCED. Use Nonce.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-usernameclaim--none--str"><em>property</em> userNameClaim <em>: None | str</em><a href="#property-usernameclaim--none--str" class="hash-link" aria-label="Direct link to property-usernameclaim--none--str" title="Direct link to property-usernameclaim--none--str"></a></h4><p>ADVANCED. The attribute / claim used to derive the DataHub username. Defaults to “preferred_username”.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-usernameclaimregex--none--str"><em>property</em> userNameClaimRegex <em>: None | str</em><a href="#property-usernameclaimregex--none--str" class="hash-link" aria-label="Direct link to property-usernameclaimregex--none--str" title="Direct link to property-usernameclaimregex--none--str"></a></h4><p>ADVANCED. TThe regex used to parse the DataHub username from the user name claim. Defaults to (.<!-- -->*<!-- -->) (all).</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.OperationClass"><span class="visually-hidden">OperationClass</span><a href="#datahub.metadata.schema_classes.OperationClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.OperationClass" title="Direct link to datahub.metadata.schema_classes.OperationClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">OperationClass</span>(<span class="arg-name">timestampMillis</span>, <span class="arg-name">operationType</span>, <span class="arg-name">lastUpdatedTimestamp</span>, <span class="arg-name">eventGranularity</span> = <span class="arg-default">None</span>, <span class="arg-name">partitionSpec</span> = <span class="arg-default">None</span>, <span class="arg-name">messageId</span> = <span class="arg-default">None</span>, <span class="arg-name">actor</span> = <span class="arg-default">None</span>, <span class="arg-name">customOperationType</span> = <span class="arg-default">None</span>, <span class="arg-name">numAffectedRows</span> = <span class="arg-default">None</span>, <span class="arg-name">affectedDatasets</span> = <span class="arg-default">None</span>, <span class="arg-name">sourceType</span> = <span class="arg-default">None</span>, <span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">queries</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.OperationClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Operational info for an entity.</p><ul><li><strong>Parameters:</strong><ul><li><strong>timestampMillis</strong> (<code>int</code>)</li><li><strong>operationType</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.OperationTypeClass"><code>OperationTypeClass</code></a>]) – </li><li><strong>lastUpdatedTimestamp</strong> (<code>int</code>)</li><li><strong>eventGranularity</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeWindowSizeClass"><code>TimeWindowSizeClass</code></a>]) – </li><li><strong>partitionSpec</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.PartitionSpecClass"><code>PartitionSpecClass</code></a>]) – </li><li><strong>messageId</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>actor</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>customOperationType</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>numAffectedRows</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>affectedDatasets</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>sourceType</strong> (<code>Union</code>[<code>None</code>, <code>str</code>, <a href="#datahub.metadata.schema_classes.OperationSourceTypeClass"><code>OperationSourceTypeClass</code></a>]) – </li><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>queries</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="aspect_type--classvarstr--timeseries-8">ASPECT_TYPE <em>: <code>ClassVar</code>[<code>str</code>]</em> <em>= 'timeseries'</em><a href="#aspect_type--classvarstr--timeseries-8" class="hash-link" aria-label="Direct link to aspect_type--classvarstr--timeseries-8" title="Direct link to aspect_type--classvarstr--timeseries-8"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-actor--none--str-2"><em>property</em> actor <em>: None | str</em><a href="#property-actor--none--str-2" class="hash-link" aria-label="Direct link to property-actor--none--str-2" title="Direct link to property-actor--none--str-2"></a></h4><p>Actor who issued this operation.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-affecteddatasets--none--liststr"><em>property</em> affectedDatasets <em>: None | List<!-- -->[str]</em><a href="#property-affecteddatasets--none--liststr" class="hash-link" aria-label="Direct link to property-affecteddatasets--none--liststr" title="Direct link to property-affecteddatasets--none--liststr"></a></h4><p>Which other datasets were affected by this operation.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customoperationtype--none--str"><em>property</em> customOperationType <em>: None | str</em><a href="#property-customoperationtype--none--str" class="hash-link" aria-label="Direct link to property-customoperationtype--none--str" title="Direct link to property-customoperationtype--none--str"></a></h4><p>A custom type of operation. Required if operationType is CUSTOM.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--none--dictstr-str"><em>property</em> customProperties <em>: None | Dict<!-- -->[str, str]</em><a href="#property-customproperties--none--dictstr-str" class="hash-link" aria-label="Direct link to property-customproperties--none--dictstr-str" title="Direct link to property-customproperties--none--dictstr-str"></a></h4><p>Custom properties</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-eventgranularity--none--timewindowsizeclass-8"><em>property</em> eventGranularity <em>: None | <a href="#datahub.metadata.schema_classes.TimeWindowSizeClass">TimeWindowSizeClass</a></em><a href="#property-eventgranularity--none--timewindowsizeclass-8" class="hash-link" aria-label="Direct link to property-eventgranularity--none--timewindowsizeclass-8" title="Direct link to property-eventgranularity--none--timewindowsizeclass-8"></a></h4><p>Granularity of the event if applicable</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastupdatedtimestamp--int"><em>property</em> lastUpdatedTimestamp <em>: int</em><a href="#property-lastupdatedtimestamp--int" class="hash-link" aria-label="Direct link to property-lastupdatedtimestamp--int" title="Direct link to property-lastupdatedtimestamp--int"></a></h4><p>The time at which the operation occurred. Would be better named ‘operationTime’</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-messageid--none--str-8"><em>property</em> messageId <em>: None | str</em><a href="#property-messageid--none--str-8" class="hash-link" aria-label="Direct link to property-messageid--none--str-8" title="Direct link to property-messageid--none--str-8"></a></h4><p>The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-numaffectedrows--none--int"><em>property</em> numAffectedRows <em>: None | int</em><a href="#property-numaffectedrows--none--int" class="hash-link" aria-label="Direct link to property-numaffectedrows--none--int" title="Direct link to property-numaffectedrows--none--int"></a></h4><p>How many rows were affected by this operation.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-operationtype--str--operationtypeclass"><em>property</em> operationType <em>: str | <a href="#datahub.metadata.schema_classes.OperationTypeClass">OperationTypeClass</a></em><a href="#property-operationtype--str--operationtypeclass" class="hash-link" aria-label="Direct link to property-operationtype--str--operationtypeclass" title="Direct link to property-operationtype--str--operationtypeclass"></a></h4><p>Operation type of change.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-partitionspec--partitionspecclass--none-8"><em>property</em> partitionSpec <em>: <a href="#datahub.metadata.schema_classes.PartitionSpecClass">PartitionSpecClass</a> | None</em><a href="#property-partitionspec--partitionspecclass--none-8" class="hash-link" aria-label="Direct link to property-partitionspec--partitionspecclass--none-8" title="Direct link to property-partitionspec--partitionspecclass--none-8"></a></h4><p>The optional partition specification.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-queries--none--liststr"><em>property</em> queries <em>: None | List<!-- -->[str]</em><a href="#property-queries--none--liststr" class="hash-link" aria-label="Direct link to property-queries--none--liststr" title="Direct link to property-queries--none--liststr"></a></h4><p>Which queries were used in this operation.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-sourcetype--none--str--operationsourcetypeclass"><em>property</em> sourceType <em>: None | str | <a href="#datahub.metadata.schema_classes.OperationSourceTypeClass">OperationSourceTypeClass</a></em><a href="#property-sourcetype--none--str--operationsourcetypeclass" class="hash-link" aria-label="Direct link to property-sourcetype--none--str--operationsourcetypeclass" title="Direct link to property-sourcetype--none--str--operationsourcetypeclass"></a></h4><p>Source Type</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-timestampmillis--int-8"><em>property</em> timestampMillis <em>: int</em><a href="#property-timestampmillis--int-8" class="hash-link" aria-label="Direct link to property-timestampmillis--int-8" title="Direct link to property-timestampmillis--int-8"></a></h4><p>The event timestamp field as epoch at UTC in milli seconds.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.OperationSourceTypeClass"><span class="visually-hidden">OperationSourceTypeClass</span><a href="#datahub.metadata.schema_classes.OperationSourceTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.OperationSourceTypeClass" title="Direct link to datahub.metadata.schema_classes.OperationSourceTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">OperationSourceTypeClass</span>()<a href="#datahub.metadata.schema_classes.OperationSourceTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>The source of an operation</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="data_platform--data_platform">DATA_PLATFORM <em>= 'DATA_PLATFORM'</em><a href="#data_platform--data_platform" class="hash-link" aria-label="Direct link to data_platform--data_platform" title="Direct link to data_platform--data_platform"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="data_process--data_process">DATA_PROCESS <em>= 'DATA_PROCESS'</em><a href="#data_process--data_process" class="hash-link" aria-label="Direct link to data_process--data_process" title="Direct link to data_process--data_process"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.OperationTypeClass"><span class="visually-hidden">OperationTypeClass</span><a href="#datahub.metadata.schema_classes.OperationTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.OperationTypeClass" title="Direct link to datahub.metadata.schema_classes.OperationTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">OperationTypeClass</span>()<a href="#datahub.metadata.schema_classes.OperationTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>Enum to define the operation type when an entity changes.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="alter--alter">ALTER <em>= 'ALTER'</em><a href="#alter--alter" class="hash-link" aria-label="Direct link to alter--alter" title="Direct link to alter--alter"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="create--create-1">CREATE <em>= 'CREATE'</em><a href="#create--create-1" class="hash-link" aria-label="Direct link to create--create-1" title="Direct link to create--create-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="custom--custom-2">CUSTOM <em>= 'CUSTOM'</em><a href="#custom--custom-2" class="hash-link" aria-label="Direct link to custom--custom-2" title="Direct link to custom--custom-2"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="delete--delete-1">DELETE <em>= 'DELETE'</em><a href="#delete--delete-1" class="hash-link" aria-label="Direct link to delete--delete-1" title="Direct link to delete--delete-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="drop--drop">DROP <em>= 'DROP'</em><a href="#drop--drop" class="hash-link" aria-label="Direct link to drop--drop" title="Direct link to drop--drop"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="insert--insert">INSERT <em>= 'INSERT'</em><a href="#insert--insert" class="hash-link" aria-label="Direct link to insert--insert" title="Direct link to insert--insert"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="unknown--unknown-5">UNKNOWN <em>= 'UNKNOWN'</em><a href="#unknown--unknown-5" class="hash-link" aria-label="Direct link to unknown--unknown-5" title="Direct link to unknown--unknown-5"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="update--update-1">UPDATE <em>= 'UPDATE'</em><a href="#update--update-1" class="hash-link" aria-label="Direct link to update--update-1" title="Direct link to update--update-1"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.OracleDDLClass"><span class="visually-hidden">OracleDDLClass</span><a href="#datahub.metadata.schema_classes.OracleDDLClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.OracleDDLClass" title="Direct link to datahub.metadata.schema_classes.OracleDDLClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">OracleDDLClass</span>(<span class="arg-name">tableSchema</span>)<a href="#datahub.metadata.schema_classes.OracleDDLClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Schema holder for oracle data definition language that describes an oracle table.</p><ul><li><strong>Parameters:</strong><strong>tableSchema</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-tableschema--str-2"><em>property</em> tableSchema <em>: str</em><a href="#property-tableschema--str-2" class="hash-link" aria-label="Direct link to property-tableschema--str-2" title="Direct link to property-tableschema--str-2"></a></h4><p>The native schema in the dataset’s platform. This is a human readable (json blob) table schema.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.OrcSchemaClass"><span class="visually-hidden">OrcSchemaClass</span><a href="#datahub.metadata.schema_classes.OrcSchemaClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.OrcSchemaClass" title="Direct link to datahub.metadata.schema_classes.OrcSchemaClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">OrcSchemaClass</span>(<span class="arg-name">schema</span>)<a href="#datahub.metadata.schema_classes.OrcSchemaClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Schema text of an ORC schema.</p><ul><li><strong>Parameters:</strong><strong>schema</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-schema--str-1"><em>property</em> schema <em>: str</em><a href="#property-schema--str-1" class="hash-link" aria-label="Direct link to property-schema--str-1" title="Direct link to property-schema--str-1"></a></h4><p>The native schema for ORC file format.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.OriginClass"><span class="visually-hidden">OriginClass</span><a href="#datahub.metadata.schema_classes.OriginClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.OriginClass" title="Direct link to datahub.metadata.schema_classes.OriginClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">OriginClass</span>(<span class="arg-name">type</span>, <span class="arg-name">externalType</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.OriginClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Carries information about where an entity originated from.</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.OriginTypeClass"><code>OriginTypeClass</code></a>]) – </li><li><strong>externalType</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-externaltype--none--str"><em>property</em> externalType <em>: None | str</em><a href="#property-externaltype--none--str" class="hash-link" aria-label="Direct link to property-externaltype--none--str" title="Direct link to property-externaltype--none--str"></a></h4><p>Only populated if type is EXTERNAL. The externalType of the entity, such as the name of the identity provider.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--origintypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.OriginTypeClass">OriginTypeClass</a></em><a href="#property-type--str--origintypeclass" class="hash-link" aria-label="Direct link to property-type--str--origintypeclass" title="Direct link to property-type--str--origintypeclass"></a></h4><p>Where an entity originated from. Either NATIVE or EXTERNAL.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.OriginTypeClass"><span class="visually-hidden">OriginTypeClass</span><a href="#datahub.metadata.schema_classes.OriginTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.OriginTypeClass" title="Direct link to datahub.metadata.schema_classes.OriginTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">OriginTypeClass</span>()<a href="#datahub.metadata.schema_classes.OriginTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>Enum to define where an entity originated from.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="external--external-1">EXTERNAL <em>= 'EXTERNAL'</em><a href="#external--external-1" class="hash-link" aria-label="Direct link to external--external-1" title="Direct link to external--external-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="native--native-2">NATIVE <em>= 'NATIVE'</em><a href="#native--native-2" class="hash-link" aria-label="Direct link to native--native-2" title="Direct link to native--native-2"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.OtherSchemaClass"><span class="visually-hidden">OtherSchemaClass</span><a href="#datahub.metadata.schema_classes.OtherSchemaClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.OtherSchemaClass" title="Direct link to datahub.metadata.schema_classes.OtherSchemaClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">OtherSchemaClass</span>(<span class="arg-name">rawSchema</span>)<a href="#datahub.metadata.schema_classes.OtherSchemaClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Schema holder for undefined schema types.</p><ul><li><strong>Parameters:</strong><strong>rawSchema</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-rawschema--str"><em>property</em> rawSchema <em>: str</em><a href="#property-rawschema--str" class="hash-link" aria-label="Direct link to property-rawschema--str" title="Direct link to property-rawschema--str"></a></h4><p>The native schema in the dataset’s platform.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.OwnerClass"><span class="visually-hidden">OwnerClass</span><a href="#datahub.metadata.schema_classes.OwnerClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.OwnerClass" title="Direct link to datahub.metadata.schema_classes.OwnerClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">OwnerClass</span>(<span class="arg-name">owner</span>, <span class="arg-name">type</span>, <span class="arg-name">typeUrn</span> = <span class="arg-default">None</span>, <span class="arg-name">source</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.OwnerClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Ownership information</p><ul><li><strong>Parameters:</strong><ul><li><strong>owner</strong> (<code>str</code>)</li><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.OwnershipTypeClass"><code>OwnershipTypeClass</code></a>]) – </li><li><strong>typeUrn</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>source</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.OwnershipSourceClass"><code>OwnershipSourceClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-owner--str"><em>property</em> owner <em>: str</em><a href="#property-owner--str" class="hash-link" aria-label="Direct link to property-owner--str" title="Direct link to property-owner--str"></a></h4><p>corpuser:ldap, urn:li:corpGroup:group_name, and urn:li:multiProduct:mp_name
|
||
(Caveat: only corpuser is currently supported in the frontend.)</p><ul><li><strong>Type:</strong>
|
||
Owner URN, e.g. urn</li><li><strong>Type:</strong>
|
||
li</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-source--none--ownershipsourceclass"><em>property</em> source <em>: None | <a href="#datahub.metadata.schema_classes.OwnershipSourceClass">OwnershipSourceClass</a></em><a href="#property-source--none--ownershipsourceclass" class="hash-link" aria-label="Direct link to property-source--none--ownershipsourceclass" title="Direct link to property-source--none--ownershipsourceclass"></a></h4><p>Source information for the ownership</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--ownershiptypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.OwnershipTypeClass">OwnershipTypeClass</a></em><a href="#property-type--str--ownershiptypeclass" class="hash-link" aria-label="Direct link to property-type--str--ownershiptypeclass" title="Direct link to property-type--str--ownershiptypeclass"></a></h4><p>The type of the ownership</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-typeurn--none--str"><em>property</em> typeUrn <em>: None | str</em><a href="#property-typeurn--none--str" class="hash-link" aria-label="Direct link to property-typeurn--none--str" title="Direct link to property-typeurn--none--str"></a></h4><p>The type of the ownership
|
||
Urn of type O</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.OwnershipClass"><span class="visually-hidden">OwnershipClass</span><a href="#datahub.metadata.schema_classes.OwnershipClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.OwnershipClass" title="Direct link to datahub.metadata.schema_classes.OwnershipClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">OwnershipClass</span>(<span class="arg-name">owners</span>, <span class="arg-name">ownerTypes</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.OwnershipClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Ownership information of an entity.</p><ul><li><strong>Parameters:</strong><ul><li><strong>owners</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.OwnerClass"><code>OwnerClass</code></a>]) – </li><li><strong>ownerTypes</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>List</code>[<code>str</code>]<!-- -->]])</li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--auditstampclass-17"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--auditstampclass-17" class="hash-link" aria-label="Direct link to property-lastmodified--auditstampclass-17" title="Direct link to property-lastmodified--auditstampclass-17"></a></h4><p>Audit stamp containing who last modified the record and when. A value of 0 in the time field indicates missing data.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-ownertypes--dictstr-liststr--none"><em>property</em> ownerTypes <em>: Dict[str, List<!-- -->[str]<!-- -->] | None</em><a href="#property-ownertypes--dictstr-liststr--none" class="hash-link" aria-label="Direct link to property-ownertypes--dictstr-liststr--none" title="Direct link to property-ownertypes--dictstr-liststr--none"></a></h4><p>Ownership type to Owners map, populated via mutation hook.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-owners--listownerclass"><em>property</em> owners <em>: List[<a href="#datahub.metadata.schema_classes.OwnerClass">OwnerClass</a>]</em><a href="#property-owners--listownerclass" class="hash-link" aria-label="Direct link to property-owners--listownerclass" title="Direct link to property-owners--listownerclass"></a></h4><p>List of owners of the entity.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.OwnershipSourceClass"><span class="visually-hidden">OwnershipSourceClass</span><a href="#datahub.metadata.schema_classes.OwnershipSourceClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.OwnershipSourceClass" title="Direct link to datahub.metadata.schema_classes.OwnershipSourceClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">OwnershipSourceClass</span>(<span class="arg-name">type</span>, <span class="arg-name">url</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.OwnershipSourceClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Source/provider of the ownership information</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.OwnershipSourceTypeClass"><code>OwnershipSourceTypeClass</code></a>]) – </li><li><strong>url</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--ownershipsourcetypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.OwnershipSourceTypeClass">OwnershipSourceTypeClass</a></em><a href="#property-type--str--ownershipsourcetypeclass" class="hash-link" aria-label="Direct link to property-type--str--ownershipsourcetypeclass" title="Direct link to property-type--str--ownershipsourcetypeclass"></a></h4><p>The type of the source</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-url--none--str"><em>property</em> url <em>: None | str</em><a href="#property-url--none--str" class="hash-link" aria-label="Direct link to property-url--none--str" title="Direct link to property-url--none--str"></a></h4><p>A reference URL for the source</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.OwnershipSourceTypeClass"><span class="visually-hidden">OwnershipSourceTypeClass</span><a href="#datahub.metadata.schema_classes.OwnershipSourceTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.OwnershipSourceTypeClass" title="Direct link to datahub.metadata.schema_classes.OwnershipSourceTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">OwnershipSourceTypeClass</span>()<a href="#datahub.metadata.schema_classes.OwnershipSourceTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="audit--audit">AUDIT <em>= 'AUDIT'</em><a href="#audit--audit" class="hash-link" aria-label="Direct link to audit--audit" title="Direct link to audit--audit"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="database--database">DATABASE <em>= 'DATABASE'</em><a href="#database--database" class="hash-link" aria-label="Direct link to database--database" title="Direct link to database--database"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="file_system--file_system">FILE_SYSTEM <em>= 'FILE_SYSTEM'</em><a href="#file_system--file_system" class="hash-link" aria-label="Direct link to file_system--file_system" title="Direct link to file_system--file_system"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="issue_tracking_system--issue_tracking_system">ISSUE_TRACKING_SYSTEM <em>= 'ISSUE_TRACKING_SYSTEM'</em><a href="#issue_tracking_system--issue_tracking_system" class="hash-link" aria-label="Direct link to issue_tracking_system--issue_tracking_system" title="Direct link to issue_tracking_system--issue_tracking_system"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="manual--manual-1">MANUAL <em>= 'MANUAL'</em><a href="#manual--manual-1" class="hash-link" aria-label="Direct link to manual--manual-1" title="Direct link to manual--manual-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="other--other">OTHER <em>= 'OTHER'</em><a href="#other--other" class="hash-link" aria-label="Direct link to other--other" title="Direct link to other--other"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="service--service">SERVICE <em>= 'SERVICE'</em><a href="#service--service" class="hash-link" aria-label="Direct link to service--service" title="Direct link to service--service"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="source_control--source_control">SOURCE_CONTROL <em>= 'SOURCE_CONTROL'</em><a href="#source_control--source_control" class="hash-link" aria-label="Direct link to source_control--source_control" title="Direct link to source_control--source_control"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.OwnershipTypeClass"><span class="visually-hidden">OwnershipTypeClass</span><a href="#datahub.metadata.schema_classes.OwnershipTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.OwnershipTypeClass" title="Direct link to datahub.metadata.schema_classes.OwnershipTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">OwnershipTypeClass</span>()<a href="#datahub.metadata.schema_classes.OwnershipTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>Asset owner types</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="business_owner--business_owner">BUSINESS_OWNER <em>= 'BUSINESS_OWNER'</em><a href="#business_owner--business_owner" class="hash-link" aria-label="Direct link to business_owner--business_owner" title="Direct link to business_owner--business_owner"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="consumer--consumer">CONSUMER <em>= 'CONSUMER'</em><a href="#consumer--consumer" class="hash-link" aria-label="Direct link to consumer--consumer" title="Direct link to consumer--consumer"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="custom--custom-3">CUSTOM <em>= 'CUSTOM'</em><a href="#custom--custom-3" class="hash-link" aria-label="Direct link to custom--custom-3" title="Direct link to custom--custom-3"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="dataowner--dataowner">DATAOWNER <em>= 'DATAOWNER'</em><a href="#dataowner--dataowner" class="hash-link" aria-label="Direct link to dataowner--dataowner" title="Direct link to dataowner--dataowner"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="data_steward--data_steward">DATA_STEWARD <em>= 'DATA_STEWARD'</em><a href="#data_steward--data_steward" class="hash-link" aria-label="Direct link to data_steward--data_steward" title="Direct link to data_steward--data_steward"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="delegate--delegate">DELEGATE <em>= 'DELEGATE'</em><a href="#delegate--delegate" class="hash-link" aria-label="Direct link to delegate--delegate" title="Direct link to delegate--delegate"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="developer--developer">DEVELOPER <em>= 'DEVELOPER'</em><a href="#developer--developer" class="hash-link" aria-label="Direct link to developer--developer" title="Direct link to developer--developer"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="none--none-1">NONE <em>= 'NONE'</em><a href="#none--none-1" class="hash-link" aria-label="Direct link to none--none-1" title="Direct link to none--none-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="producer--producer">PRODUCER <em>= 'PRODUCER'</em><a href="#producer--producer" class="hash-link" aria-label="Direct link to producer--producer" title="Direct link to producer--producer"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="stakeholder--stakeholder">STAKEHOLDER <em>= 'STAKEHOLDER'</em><a href="#stakeholder--stakeholder" class="hash-link" aria-label="Direct link to stakeholder--stakeholder" title="Direct link to stakeholder--stakeholder"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="technical_owner--technical_owner">TECHNICAL_OWNER <em>= 'TECHNICAL_OWNER'</em><a href="#technical_owner--technical_owner" class="hash-link" aria-label="Direct link to technical_owner--technical_owner" title="Direct link to technical_owner--technical_owner"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.OwnershipTypeInfoClass"><span class="visually-hidden">OwnershipTypeInfoClass</span><a href="#datahub.metadata.schema_classes.OwnershipTypeInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.OwnershipTypeInfoClass" title="Direct link to datahub.metadata.schema_classes.OwnershipTypeInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">OwnershipTypeInfoClass</span>(<span class="arg-name">name</span>, <span class="arg-name">created</span>, <span class="arg-name">lastModified</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.OwnershipTypeInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about an ownership type</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>created</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li><li><strong>lastModified</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--auditstampclass-16"><em>property</em> created <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--auditstampclass-16" class="hash-link" aria-label="Direct link to property-created--auditstampclass-16" title="Direct link to property-created--auditstampclass-16"></a></h4><p>Audit stamp capturing the time and actor who created the Ownership Type.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-43"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-43" class="hash-link" aria-label="Direct link to property-description--none--str-43" title="Direct link to property-description--none--str-43"></a></h4><p>Description of the Ownership Type</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--auditstampclass-18"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--auditstampclass-18" class="hash-link" aria-label="Direct link to property-lastmodified--auditstampclass-18" title="Direct link to property-lastmodified--auditstampclass-18"></a></h4><p>Audit stamp capturing the time and actor who last modified the Ownership Type.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-30"><em>property</em> name <em>: str</em><a href="#property-name--str-30" class="hash-link" aria-label="Direct link to property-name--str-30" title="Direct link to property-name--str-30"></a></h4><p>Display name of the Ownership Type</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.OwnershipTypeKeyClass"><span class="visually-hidden">OwnershipTypeKeyClass</span><a href="#datahub.metadata.schema_classes.OwnershipTypeKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.OwnershipTypeKeyClass" title="Direct link to datahub.metadata.schema_classes.OwnershipTypeKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">OwnershipTypeKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.OwnershipTypeKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Ownership Type</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-31"><em>property</em> id <em>: str</em><a href="#property-id--str-31" class="hash-link" aria-label="Direct link to property-id--str-31" title="Direct link to property-id--str-31"></a></h4><p>Unique ID for the data ownership type name i.e. Business Owner, Data Steward, Technical Owner, etc..
|
||
Should be separate from the name used for displaying an Ownership Type.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PageModuleScopeClass"><span class="visually-hidden">PageModuleScopeClass</span><a href="#datahub.metadata.schema_classes.PageModuleScopeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PageModuleScopeClass" title="Direct link to datahub.metadata.schema_classes.PageModuleScopeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PageModuleScopeClass</span>()<a href="#datahub.metadata.schema_classes.PageModuleScopeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="global--global-1">GLOBAL <em>= 'GLOBAL'</em><a href="#global--global-1" class="hash-link" aria-label="Direct link to global--global-1" title="Direct link to global--global-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="personal--personal-1">PERSONAL <em>= 'PERSONAL'</em><a href="#personal--personal-1" class="hash-link" aria-label="Direct link to personal--personal-1" title="Direct link to personal--personal-1"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PageTemplateScopeClass"><span class="visually-hidden">PageTemplateScopeClass</span><a href="#datahub.metadata.schema_classes.PageTemplateScopeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PageTemplateScopeClass" title="Direct link to datahub.metadata.schema_classes.PageTemplateScopeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PageTemplateScopeClass</span>()<a href="#datahub.metadata.schema_classes.PageTemplateScopeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="global--global-2">GLOBAL <em>= 'GLOBAL'</em><a href="#global--global-2" class="hash-link" aria-label="Direct link to global--global-2" title="Direct link to global--global-2"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="personal--personal-2">PERSONAL <em>= 'PERSONAL'</em><a href="#personal--personal-2" class="hash-link" aria-label="Direct link to personal--personal-2" title="Direct link to personal--personal-2"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PageTemplateSurfaceTypeClass"><span class="visually-hidden">PageTemplateSurfaceTypeClass</span><a href="#datahub.metadata.schema_classes.PageTemplateSurfaceTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PageTemplateSurfaceTypeClass" title="Direct link to datahub.metadata.schema_classes.PageTemplateSurfaceTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PageTemplateSurfaceTypeClass</span>()<a href="#datahub.metadata.schema_classes.PageTemplateSurfaceTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="home_page--home_page">HOME_PAGE <em>= 'HOME_PAGE'</em><a href="#home_page--home_page" class="hash-link" aria-label="Direct link to home_page--home_page" title="Direct link to home_page--home_page"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ParametersClass"><span class="visually-hidden">ParametersClass</span><a href="#datahub.metadata.schema_classes.ParametersClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ParametersClass" title="Direct link to datahub.metadata.schema_classes.ParametersClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ParametersClass</span>()<a href="#datahub.metadata.schema_classes.ParametersClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Arbitrary key-value parameters for an Entity Change Event. (any record).</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PartitionSpecClass"><span class="visually-hidden">PartitionSpecClass</span><a href="#datahub.metadata.schema_classes.PartitionSpecClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PartitionSpecClass" title="Direct link to datahub.metadata.schema_classes.PartitionSpecClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PartitionSpecClass</span>(<span class="arg-name">partition</span>, <span class="arg-name">timePartition</span> = <span class="arg-default">None</span>, <span class="arg-name">type</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.PartitionSpecClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A reference to a specific partition in a dataset.</p><ul><li><strong>Parameters:</strong><ul><li><strong>partition</strong> (<code>str</code>)</li><li><strong>timePartition</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeWindowClass"><code>TimeWindowClass</code></a>]) – </li><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.PartitionTypeClass"><code>PartitionTypeClass</code></a>, <code>None</code>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-partition--str"><em>property</em> partition <em>: str</em><a href="#property-partition--str" class="hash-link" aria-label="Direct link to property-partition--str" title="Direct link to property-partition--str"></a></h4><p>A unique id / value for the partition for which statistics were collected,
|
||
generated by applying the key definition to a given row.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-timepartition--none--timewindowclass"><em>property</em> timePartition <em>: None | <a href="#datahub.metadata.schema_classes.TimeWindowClass">TimeWindowClass</a></em><a href="#property-timepartition--none--timewindowclass" class="hash-link" aria-label="Direct link to property-timepartition--none--timewindowclass" title="Direct link to property-timepartition--none--timewindowclass"></a></h4><p>Time window of the partition, if we are able to extract it from the partition key.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--partitiontypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.PartitionTypeClass">PartitionTypeClass</a></em><a href="#property-type--str--partitiontypeclass" class="hash-link" aria-label="Direct link to property-type--str--partitiontypeclass" title="Direct link to property-type--str--partitiontypeclass"></a></h4><p>Unused!</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PartitionSummaryClass"><span class="visually-hidden">PartitionSummaryClass</span><a href="#datahub.metadata.schema_classes.PartitionSummaryClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PartitionSummaryClass" title="Direct link to datahub.metadata.schema_classes.PartitionSummaryClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PartitionSummaryClass</span>(<span class="arg-name">partition</span>, <span class="arg-name">createdTime</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModifiedTime</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.PartitionSummaryClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Defines how the data is partitioned</p><ul><li><strong>Parameters:</strong><ul><li><strong>partition</strong> (<code>str</code>)</li><li><strong>createdTime</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>lastModifiedTime</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-createdtime--none--int"><em>property</em> createdTime <em>: None | int</em><a href="#property-createdtime--none--int" class="hash-link" aria-label="Direct link to property-createdtime--none--int" title="Direct link to property-createdtime--none--int"></a></h4><p>The created time for a given partition.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodifiedtime--none--int"><em>property</em> lastModifiedTime <em>: None | int</em><a href="#property-lastmodifiedtime--none--int" class="hash-link" aria-label="Direct link to property-lastmodifiedtime--none--int" title="Direct link to property-lastmodifiedtime--none--int"></a></h4><p>The last modified / touched time for a given partition.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-partition--str-1"><em>property</em> partition <em>: str</em><a href="#property-partition--str-1" class="hash-link" aria-label="Direct link to property-partition--str-1" title="Direct link to property-partition--str-1"></a></h4><p>A unique id / value for the partition for which statistics were collected,
|
||
generated by applying the key definition to a given row.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PartitionTypeClass"><span class="visually-hidden">PartitionTypeClass</span><a href="#datahub.metadata.schema_classes.PartitionTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PartitionTypeClass" title="Direct link to datahub.metadata.schema_classes.PartitionTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PartitionTypeClass</span>()<a href="#datahub.metadata.schema_classes.PartitionTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="full_table--full_table">FULL_TABLE <em>= 'FULL_TABLE'</em><a href="#full_table--full_table" class="hash-link" aria-label="Direct link to full_table--full_table" title="Direct link to full_table--full_table"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="partition--partition">PARTITION <em>= 'PARTITION'</em><a href="#partition--partition" class="hash-link" aria-label="Direct link to partition--partition" title="Direct link to partition--partition"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="query--query">QUERY <em>= 'QUERY'</em><a href="#query--query" class="hash-link" aria-label="Direct link to query--query" title="Direct link to query--query"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PartitionsSummaryClass"><span class="visually-hidden">PartitionsSummaryClass</span><a href="#datahub.metadata.schema_classes.PartitionsSummaryClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PartitionsSummaryClass" title="Direct link to datahub.metadata.schema_classes.PartitionsSummaryClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PartitionsSummaryClass</span>(<span class="arg-name">minPartition</span> = <span class="arg-default">None</span>, <span class="arg-name">maxPartition</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.PartitionsSummaryClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Defines how the data is partitioned for Data Lake tables (e.g. Hive, S3, Iceberg, Delta, Hudi, etc).</p><ul><li><strong>Parameters:</strong><ul><li><strong>minPartition</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.PartitionSummaryClass"><code>PartitionSummaryClass</code></a>]) – </li><li><strong>maxPartition</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.PartitionSummaryClass"><code>PartitionSummaryClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-maxpartition--none--partitionsummaryclass"><em>property</em> maxPartition <em>: None | <a href="#datahub.metadata.schema_classes.PartitionSummaryClass">PartitionSummaryClass</a></em><a href="#property-maxpartition--none--partitionsummaryclass" class="hash-link" aria-label="Direct link to property-maxpartition--none--partitionsummaryclass" title="Direct link to property-maxpartition--none--partitionsummaryclass"></a></h4><p>The maximum partition as ordered</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-minpartition--none--partitionsummaryclass"><em>property</em> minPartition <em>: None | <a href="#datahub.metadata.schema_classes.PartitionSummaryClass">PartitionSummaryClass</a></em><a href="#property-minpartition--none--partitionsummaryclass" class="hash-link" aria-label="Direct link to property-minpartition--none--partitionsummaryclass" title="Direct link to property-minpartition--none--partitionsummaryclass"></a></h4><p>The minimum partition as ordered</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PlatformEventClass"><span class="visually-hidden">PlatformEventClass</span><a href="#datahub.metadata.schema_classes.PlatformEventClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PlatformEventClass" title="Direct link to datahub.metadata.schema_classes.PlatformEventClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PlatformEventClass</span>(<span class="arg-name">header</span>, <span class="arg-name">name</span>, <span class="arg-name">payload</span>)<a href="#datahub.metadata.schema_classes.PlatformEventClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A DataHub Platform Event.</p><ul><li><strong>Parameters:</strong><ul><li><strong>header</strong> (<a href="#datahub.metadata.schema_classes.PlatformEventHeaderClass"><code>PlatformEventHeaderClass</code></a>) – </li><li><strong>name</strong> (<code>str</code>)</li><li><strong>payload</strong> (<a href="#datahub.metadata.schema_classes.GenericPayloadClass"><code>GenericPayloadClass</code></a>) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-header--platformeventheaderclass"><em>property</em> header <em>: <a href="#datahub.metadata.schema_classes.PlatformEventHeaderClass">PlatformEventHeaderClass</a></em><a href="#property-header--platformeventheaderclass" class="hash-link" aria-label="Direct link to property-header--platformeventheaderclass" title="Direct link to property-header--platformeventheaderclass"></a></h4><p>Header information stored with the event.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-31"><em>property</em> name <em>: str</em><a href="#property-name--str-31" class="hash-link" aria-label="Direct link to property-name--str-31" title="Direct link to property-name--str-31"></a></h4><p>The name of the event, e.g. the type of event. For example, ‘notificationRequestEvent’, ‘entityChangeEvent’</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-payload--genericpayloadclass"><em>property</em> payload <em>: <a href="#datahub.metadata.schema_classes.GenericPayloadClass">GenericPayloadClass</a></em><a href="#property-payload--genericpayloadclass" class="hash-link" aria-label="Direct link to property-payload--genericpayloadclass" title="Direct link to property-payload--genericpayloadclass"></a></h4><p>The event payload.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PlatformEventHeaderClass"><span class="visually-hidden">PlatformEventHeaderClass</span><a href="#datahub.metadata.schema_classes.PlatformEventHeaderClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PlatformEventHeaderClass" title="Direct link to datahub.metadata.schema_classes.PlatformEventHeaderClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PlatformEventHeaderClass</span>(<span class="arg-name">timestampMillis</span>)<a href="#datahub.metadata.schema_classes.PlatformEventHeaderClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A header included with each DataHub platform event.</p><ul><li><strong>Parameters:</strong><strong>timestampMillis</strong> (<code>int</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-timestampmillis--int-9"><em>property</em> timestampMillis <em>: int</em><a href="#property-timestampmillis--int-9" class="hash-link" aria-label="Direct link to property-timestampmillis--int-9" title="Direct link to property-timestampmillis--int-9"></a></h4><p>The event timestamp field as epoch at UTC in milli seconds.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PlatformResourceInfoClass"><span class="visually-hidden">PlatformResourceInfoClass</span><a href="#datahub.metadata.schema_classes.PlatformResourceInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PlatformResourceInfoClass" title="Direct link to datahub.metadata.schema_classes.PlatformResourceInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PlatformResourceInfoClass</span>(<span class="arg-name">resourceType</span>, <span class="arg-name">primaryKey</span>, <span class="arg-name">secondaryKeys</span> = <span class="arg-default">None</span>, <span class="arg-name">value</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.PlatformResourceInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Platform Resource Info.
|
||
These entities are for miscelaneous data that is used in non-core parts of the system.
|
||
For instance, if we want to persist & retrieve data from auxiliary integrations such as Slack or Microsoft Teams.</p><ul><li><strong>Parameters:</strong><ul><li><strong>resourceType</strong> (<code>str</code>)</li><li><strong>primaryKey</strong> (<code>str</code>)</li><li><strong>secondaryKeys</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>value</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.SerializedValueClass"><code>SerializedValueClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-primarykey--str"><em>property</em> primaryKey <em>: str</em><a href="#property-primarykey--str" class="hash-link" aria-label="Direct link to property-primarykey--str" title="Direct link to property-primarykey--str"></a></h4><p>The primary key for this platform resource.
|
||
e.g. for a slack member this would be the memberID.
|
||
primary keys specified here don’t need to include any additional specificity for the</p><blockquote><p>dataPlatform</p></blockquote><p>The @PlatformResourceKey is supposed to represent that</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-resourcetype--str"><em>property</em> resourceType <em>: str</em><a href="#property-resourcetype--str" class="hash-link" aria-label="Direct link to property-resourcetype--str" title="Direct link to property-resourcetype--str"></a></h4><p>The type of the resource.
|
||
Intended as a loose specifier of the generic type of the resource.
|
||
Producer is not forced to conform to a specific set of symbols for
|
||
resource types.
|
||
The @PlatformResourceType enumeration offers a paved path for agreed upon
|
||
common terms, but is not required to be followed.
|
||
Example values could be: conversation, user, grant, etc.
|
||
Resource types are indexed for ease of access.
|
||
e.g. Get me all platform resources of type user for the platform looker</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-secondarykeys--none--liststr"><em>property</em> secondaryKeys <em>: None | List<!-- -->[str]</em><a href="#property-secondarykeys--none--liststr" class="hash-link" aria-label="Direct link to property-secondarykeys--none--liststr" title="Direct link to property-secondarykeys--none--liststr"></a></h4><p>The secondary keys this platform resource can be located by.
|
||
I.e., for a slack member this would be email or phone.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-value--none--serializedvalueclass"><em>property</em> value <em>: None | <a href="#datahub.metadata.schema_classes.SerializedValueClass">SerializedValueClass</a></em><a href="#property-value--none--serializedvalueclass" class="hash-link" aria-label="Direct link to property-value--none--serializedvalueclass" title="Direct link to property-value--none--serializedvalueclass"></a></h4><p>The serialized value of this platform resource item.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PlatformResourceKeyClass"><span class="visually-hidden">PlatformResourceKeyClass</span><a href="#datahub.metadata.schema_classes.PlatformResourceKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PlatformResourceKeyClass" title="Direct link to datahub.metadata.schema_classes.PlatformResourceKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PlatformResourceKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.PlatformResourceKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Platform Resource.
|
||
Platform Resources are assets that are not part of the core data model.
|
||
They are stored in DataHub primarily to help with application-specific
|
||
use-cases that are not sufficiently generalized to move into the core data model.
|
||
For instance, if we want to persist & retrieve additional user profile data
|
||
from auxiliary integrations such as Slack or Microsoft Teams for resolving details later.</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-32"><em>property</em> id <em>: str</em><a href="#property-id--str-32" class="hash-link" aria-label="Direct link to property-id--str-32" title="Direct link to property-id--str-32"></a></h4><p>A unique id for this entity.
|
||
There are no constraints on the format of this id, but most implementations
|
||
will choose to use a UUID.
|
||
This id should be globally unique for the entire DataHub instance and</p><blockquote><p>uniquely identify the resource that is being stored, so most
|
||
implementations</p></blockquote><p>will combine logical attributes like platform name, platform instance,
|
||
platform-specific-id and the resource type to create the unique id.
|
||
e.g. slack:slack-instance:slack-user-id:user-info
|
||
or guid(slack, slack-instance, slack-user-id, user-info) etc.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PlatformTypeClass"><span class="visually-hidden">PlatformTypeClass</span><a href="#datahub.metadata.schema_classes.PlatformTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PlatformTypeClass" title="Direct link to datahub.metadata.schema_classes.PlatformTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PlatformTypeClass</span>()<a href="#datahub.metadata.schema_classes.PlatformTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>Platform types available at LinkedIn</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="file_system--file_system-1">FILE_SYSTEM <em>= 'FILE_SYSTEM'</em><a href="#file_system--file_system-1" class="hash-link" aria-label="Direct link to file_system--file_system-1" title="Direct link to file_system--file_system-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="key_value_store--key_value_store">KEY_VALUE_STORE <em>= 'KEY_VALUE_STORE'</em><a href="#key_value_store--key_value_store" class="hash-link" aria-label="Direct link to key_value_store--key_value_store" title="Direct link to key_value_store--key_value_store"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="message_broker--message_broker">MESSAGE_BROKER <em>= 'MESSAGE_BROKER'</em><a href="#message_broker--message_broker" class="hash-link" aria-label="Direct link to message_broker--message_broker" title="Direct link to message_broker--message_broker"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="object_store--object_store">OBJECT_STORE <em>= 'OBJECT_STORE'</em><a href="#object_store--object_store" class="hash-link" aria-label="Direct link to object_store--object_store" title="Direct link to object_store--object_store"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="olap_datastore--olap_datastore">OLAP_DATASTORE <em>= 'OLAP_DATASTORE'</em><a href="#olap_datastore--olap_datastore" class="hash-link" aria-label="Direct link to olap_datastore--olap_datastore" title="Direct link to olap_datastore--olap_datastore"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="others--others">OTHERS <em>= 'OTHERS'</em><a href="#others--others" class="hash-link" aria-label="Direct link to others--others" title="Direct link to others--others"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="query_engine--query_engine">QUERY_ENGINE <em>= 'QUERY_ENGINE'</em><a href="#query_engine--query_engine" class="hash-link" aria-label="Direct link to query_engine--query_engine" title="Direct link to query_engine--query_engine"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="relational_db--relational_db">RELATIONAL_DB <em>= 'RELATIONAL_DB'</em><a href="#relational_db--relational_db" class="hash-link" aria-label="Direct link to relational_db--relational_db" title="Direct link to relational_db--relational_db"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="search_engine--search_engine">SEARCH_ENGINE <em>= 'SEARCH_ENGINE'</em><a href="#search_engine--search_engine" class="hash-link" aria-label="Direct link to search_engine--search_engine" title="Direct link to search_engine--search_engine"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PolicyMatchConditionClass"><span class="visually-hidden">PolicyMatchConditionClass</span><a href="#datahub.metadata.schema_classes.PolicyMatchConditionClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PolicyMatchConditionClass" title="Direct link to datahub.metadata.schema_classes.PolicyMatchConditionClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PolicyMatchConditionClass</span>()<a href="#datahub.metadata.schema_classes.PolicyMatchConditionClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>The matching condition in a filter criterion</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="equals--equals">EQUALS <em>= 'EQUALS'</em><a href="#equals--equals" class="hash-link" aria-label="Direct link to equals--equals" title="Direct link to equals--equals"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="not_equals--not_equals">NOT_EQUALS <em>= 'NOT_EQUALS'</em><a href="#not_equals--not_equals" class="hash-link" aria-label="Direct link to not_equals--not_equals" title="Direct link to not_equals--not_equals"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="starts_with--starts_with">STARTS_WITH <em>= 'STARTS_WITH'</em><a href="#starts_with--starts_with" class="hash-link" aria-label="Direct link to starts_with--starts_with" title="Direct link to starts_with--starts_with"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PolicyMatchCriterionClass"><span class="visually-hidden">PolicyMatchCriterionClass</span><a href="#datahub.metadata.schema_classes.PolicyMatchCriterionClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PolicyMatchCriterionClass" title="Direct link to datahub.metadata.schema_classes.PolicyMatchCriterionClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PolicyMatchCriterionClass</span>(<span class="arg-name">field</span>, <span class="arg-name">values</span>, <span class="arg-name">condition</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.PolicyMatchCriterionClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A criterion for matching a field with given value</p><ul><li><strong>Parameters:</strong><ul><li><strong>field</strong> (<code>str</code>)</li><li><strong>values</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li><li><strong>condition</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.PolicyMatchConditionClass"><code>PolicyMatchConditionClass</code></a>, <code>None</code>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-condition--str--policymatchconditionclass"><em>property</em> condition <em>: str | <a href="#datahub.metadata.schema_classes.PolicyMatchConditionClass">PolicyMatchConditionClass</a></em><a href="#property-condition--str--policymatchconditionclass" class="hash-link" aria-label="Direct link to property-condition--str--policymatchconditionclass" title="Direct link to property-condition--str--policymatchconditionclass"></a></h4><p>The condition for the criterion</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-field--str-1"><em>property</em> field <em>: str</em><a href="#property-field--str-1" class="hash-link" aria-label="Direct link to property-field--str-1" title="Direct link to property-field--str-1"></a></h4><p>The name of the field that the criterion refers to</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-values--liststr-1"><em>property</em> values <em>: List<!-- -->[str]</em><a href="#property-values--liststr-1" class="hash-link" aria-label="Direct link to property-values--liststr-1" title="Direct link to property-values--liststr-1"></a></h4><p>Values. Matches criterion if any one of the values matches condition (OR-relationship)</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PolicyMatchFilterClass"><span class="visually-hidden">PolicyMatchFilterClass</span><a href="#datahub.metadata.schema_classes.PolicyMatchFilterClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PolicyMatchFilterClass" title="Direct link to datahub.metadata.schema_classes.PolicyMatchFilterClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PolicyMatchFilterClass</span>(<span class="arg-name">criteria</span>)<a href="#datahub.metadata.schema_classes.PolicyMatchFilterClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>The filter for specifying the resource or actor to apply privileges to</p><ul><li><strong>Parameters:</strong><strong>criteria</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.PolicyMatchCriterionClass"><code>PolicyMatchCriterionClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-criteria--listpolicymatchcriterionclass"><em>property</em> criteria <em>: List[<a href="#datahub.metadata.schema_classes.PolicyMatchCriterionClass">PolicyMatchCriterionClass</a>]</em><a href="#property-criteria--listpolicymatchcriterionclass" class="hash-link" aria-label="Direct link to property-criteria--listpolicymatchcriterionclass" title="Direct link to property-criteria--listpolicymatchcriterionclass"></a></h4><p>A list of criteria to apply conjunctively (so all criteria must pass)</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PostContentClass"><span class="visually-hidden">PostContentClass</span><a href="#datahub.metadata.schema_classes.PostContentClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PostContentClass" title="Direct link to datahub.metadata.schema_classes.PostContentClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PostContentClass</span>(<span class="arg-name">title</span>, <span class="arg-name">type</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">link</span> = <span class="arg-default">None</span>, <span class="arg-name">media</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.PostContentClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Content stored inside a Post.</p><ul><li><strong>Parameters:</strong><ul><li><strong>title</strong> (<code>str</code>)</li><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.PostContentTypeClass"><code>PostContentTypeClass</code></a>]) – </li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>link</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>media</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.MediaClass"><code>MediaClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-44"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-44" class="hash-link" aria-label="Direct link to property-description--none--str-44" title="Direct link to property-description--none--str-44"></a></h4><p>Optional description of the post.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-link--none--str"><em>property</em> link <em>: None | str</em><a href="#property-link--none--str" class="hash-link" aria-label="Direct link to property-link--none--str" title="Direct link to property-link--none--str"></a></h4><p>Optional link that the post is associated with.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-media--none--mediaclass"><em>property</em> media <em>: None | <a href="#datahub.metadata.schema_classes.MediaClass">MediaClass</a></em><a href="#property-media--none--mediaclass" class="hash-link" aria-label="Direct link to property-media--none--mediaclass" title="Direct link to property-media--none--mediaclass"></a></h4><p>Optional media that the post is storing</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-title--str-4"><em>property</em> title <em>: str</em><a href="#property-title--str-4" class="hash-link" aria-label="Direct link to property-title--str-4" title="Direct link to property-title--str-4"></a></h4><p>Title of the post.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--postcontenttypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.PostContentTypeClass">PostContentTypeClass</a></em><a href="#property-type--str--postcontenttypeclass" class="hash-link" aria-label="Direct link to property-type--str--postcontenttypeclass" title="Direct link to property-type--str--postcontenttypeclass"></a></h4><p>Type of content held in the post.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PostContentTypeClass"><span class="visually-hidden">PostContentTypeClass</span><a href="#datahub.metadata.schema_classes.PostContentTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PostContentTypeClass" title="Direct link to datahub.metadata.schema_classes.PostContentTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PostContentTypeClass</span>()<a href="#datahub.metadata.schema_classes.PostContentTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>Enum defining the type of content held in a Post.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="link--link-1">LINK <em>= 'LINK'</em><a href="#link--link-1" class="hash-link" aria-label="Direct link to link--link-1" title="Direct link to link--link-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="text--text-2">TEXT <em>= 'TEXT'</em><a href="#text--text-2" class="hash-link" aria-label="Direct link to text--text-2" title="Direct link to text--text-2"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PostInfoClass"><span class="visually-hidden">PostInfoClass</span><a href="#datahub.metadata.schema_classes.PostInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PostInfoClass" title="Direct link to datahub.metadata.schema_classes.PostInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PostInfoClass</span>(<span class="arg-name">type</span>, <span class="arg-name">content</span>, <span class="arg-name">created</span>, <span class="arg-name">lastModified</span>, <span class="arg-name">auditStamp</span> = <span class="arg-default">None</span>, <span class="arg-name">target</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.PostInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a DataHub Post.</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.PostTypeClass"><code>PostTypeClass</code></a>]) – </li><li><strong>content</strong> (<a href="#datahub.metadata.schema_classes.PostContentClass"><code>PostContentClass</code></a>) – </li><li><strong>created</strong> (<code>int</code>)</li><li><strong>lastModified</strong> (<code>int</code>)</li><li><strong>auditStamp</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>target</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-auditstamp--none--auditstampclass"><em>property</em> auditStamp <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-auditstamp--none--auditstampclass" class="hash-link" aria-label="Direct link to property-auditstamp--none--auditstampclass" title="Direct link to property-auditstamp--none--auditstampclass"></a></h4><p>The audit stamp at which the request was last updated</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-content--postcontentclass"><em>property</em> content <em>: <a href="#datahub.metadata.schema_classes.PostContentClass">PostContentClass</a></em><a href="#property-content--postcontentclass" class="hash-link" aria-label="Direct link to property-content--postcontentclass" title="Direct link to property-content--postcontentclass"></a></h4><p>Content stored in the post.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--int"><em>property</em> created <em>: int</em><a href="#property-created--int" class="hash-link" aria-label="Direct link to property-created--int" title="Direct link to property-created--int"></a></h4><p>The time at which the post was initially created</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--int"><em>property</em> lastModified <em>: int</em><a href="#property-lastmodified--int" class="hash-link" aria-label="Direct link to property-lastmodified--int" title="Direct link to property-lastmodified--int"></a></h4><p>The time at which the post was last modified</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-target--none--str"><em>property</em> target <em>: None | str</em><a href="#property-target--none--str" class="hash-link" aria-label="Direct link to property-target--none--str" title="Direct link to property-target--none--str"></a></h4><p>Optional Entity URN that the post is associated with.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--posttypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.PostTypeClass">PostTypeClass</a></em><a href="#property-type--str--posttypeclass" class="hash-link" aria-label="Direct link to property-type--str--posttypeclass" title="Direct link to property-type--str--posttypeclass"></a></h4><p>Type of the Post.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PostKeyClass"><span class="visually-hidden">PostKeyClass</span><a href="#datahub.metadata.schema_classes.PostKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PostKeyClass" title="Direct link to datahub.metadata.schema_classes.PostKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PostKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.PostKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Post.</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-33"><em>property</em> id <em>: str</em><a href="#property-id--str-33" class="hash-link" aria-label="Direct link to property-id--str-33" title="Direct link to property-id--str-33"></a></h4><p>A unique id for the DataHub Post record. Generated on the server side at Post creation time.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PostTypeClass"><span class="visually-hidden">PostTypeClass</span><a href="#datahub.metadata.schema_classes.PostTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PostTypeClass" title="Direct link to datahub.metadata.schema_classes.PostTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PostTypeClass</span>()<a href="#datahub.metadata.schema_classes.PostTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>Enum defining types of Posts.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="entity_announcement--entity_announcement">ENTITY_ANNOUNCEMENT <em>= 'ENTITY_ANNOUNCEMENT'</em><a href="#entity_announcement--entity_announcement" class="hash-link" aria-label="Direct link to entity_announcement--entity_announcement" title="Direct link to entity_announcement--entity_announcement"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="home_page_announcement--home_page_announcement">HOME_PAGE_ANNOUNCEMENT <em>= 'HOME_PAGE_ANNOUNCEMENT'</em><a href="#home_page_announcement--home_page_announcement" class="hash-link" aria-label="Direct link to home_page_announcement--home_page_announcement" title="Direct link to home_page_announcement--home_page_announcement"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PrestoDDLClass"><span class="visually-hidden">PrestoDDLClass</span><a href="#datahub.metadata.schema_classes.PrestoDDLClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PrestoDDLClass" title="Direct link to datahub.metadata.schema_classes.PrestoDDLClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PrestoDDLClass</span>(<span class="arg-name">rawSchema</span>)<a href="#datahub.metadata.schema_classes.PrestoDDLClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Schema holder for presto data definition language that describes a presto view.</p><ul><li><strong>Parameters:</strong><strong>rawSchema</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-rawschema--str-1"><em>property</em> rawSchema <em>: str</em><a href="#property-rawschema--str-1" class="hash-link" aria-label="Direct link to property-rawschema--str-1" title="Direct link to property-rawschema--str-1"></a></h4><p>The raw schema in the dataset’s platform. This includes the DDL and the columns extracted from DDL.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PropertyCardinalityClass"><span class="visually-hidden">PropertyCardinalityClass</span><a href="#datahub.metadata.schema_classes.PropertyCardinalityClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PropertyCardinalityClass" title="Direct link to datahub.metadata.schema_classes.PropertyCardinalityClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PropertyCardinalityClass</span>()<a href="#datahub.metadata.schema_classes.PropertyCardinalityClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="multiple--multiple">MULTIPLE <em>= 'MULTIPLE'</em><a href="#multiple--multiple" class="hash-link" aria-label="Direct link to multiple--multiple" title="Direct link to multiple--multiple"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="single--single">SINGLE <em>= 'SINGLE'</em><a href="#single--single" class="hash-link" aria-label="Direct link to single--single" title="Direct link to single--single"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.PropertyValueClass"><span class="visually-hidden">PropertyValueClass</span><a href="#datahub.metadata.schema_classes.PropertyValueClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.PropertyValueClass" title="Direct link to datahub.metadata.schema_classes.PropertyValueClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">PropertyValueClass</span>(<span class="arg-name">value</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.PropertyValueClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>value</strong> (<code>Union</code>[<code>str</code>, <code>float</code>]<!-- -->)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-45"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-45" class="hash-link" aria-label="Direct link to property-description--none--str-45" title="Direct link to property-description--none--str-45"></a></h4><p>Optional description of the property value</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-value--str--float"><em>property</em> value <em>: str | float</em><a href="#property-value--str--float" class="hash-link" aria-label="Direct link to property-value--str--float" title="Direct link to property-value--str--float"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.QuantileClass"><span class="visually-hidden">QuantileClass</span><a href="#datahub.metadata.schema_classes.QuantileClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.QuantileClass" title="Direct link to datahub.metadata.schema_classes.QuantileClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">QuantileClass</span>(<span class="arg-name">quantile</span>, <span class="arg-name">value</span>)<a href="#datahub.metadata.schema_classes.QuantileClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>quantile</strong> (<code>str</code>)</li><li><strong>value</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-quantile--str"><em>property</em> quantile <em>: str</em><a href="#property-quantile--str" class="hash-link" aria-label="Direct link to property-quantile--str" title="Direct link to property-quantile--str"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-value--str-3"><em>property</em> value <em>: str</em><a href="#property-value--str-3" class="hash-link" aria-label="Direct link to property-value--str-3" title="Direct link to property-value--str-3"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.QuantitativeAnalysesClass"><span class="visually-hidden">QuantitativeAnalysesClass</span><a href="#datahub.metadata.schema_classes.QuantitativeAnalysesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.QuantitativeAnalysesClass" title="Direct link to datahub.metadata.schema_classes.QuantitativeAnalysesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">QuantitativeAnalysesClass</span>(<span class="arg-name">unitaryResults</span> = <span class="arg-default">None</span>, <span class="arg-name">intersectionalResults</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.QuantitativeAnalysesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Quantitative analyses should be disaggregated, that is, broken down by the chosen factors. Quantitative analyses should provide the results of evaluating the MLModel according to the chosen metrics, providing confidence interval values when possible.</p><ul><li><strong>Parameters:</strong><ul><li><strong>unitaryResults</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>intersectionalResults</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-intersectionalresults--none--str"><em>property</em> intersectionalResults <em>: None | str</em><a href="#property-intersectionalresults--none--str" class="hash-link" aria-label="Direct link to property-intersectionalresults--none--str" title="Direct link to property-intersectionalresults--none--str"></a></h4><p>Link to a dashboard with results showing how the MLModel performed with respect to the intersection of evaluated factors?</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-unitaryresults--none--str"><em>property</em> unitaryResults <em>: None | str</em><a href="#property-unitaryresults--none--str" class="hash-link" aria-label="Direct link to property-unitaryresults--none--str" title="Direct link to property-unitaryresults--none--str"></a></h4><p>Link to a dashboard with results showing how the MLModel performed with respect to each factor</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.QueryCellClass"><span class="visually-hidden">QueryCellClass</span><a href="#datahub.metadata.schema_classes.QueryCellClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.QueryCellClass" title="Direct link to datahub.metadata.schema_classes.QueryCellClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">QueryCellClass</span>(<span class="arg-name">cellId</span>, <span class="arg-name">changeAuditStamps</span>, <span class="arg-name">rawQuery</span>, <span class="arg-name">cellTitle</span> = <span class="arg-default">None</span>, <span class="arg-name">lastExecuted</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.QueryCellClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Query cell in a Notebook, which will present content in query format</p><ul><li><strong>Parameters:</strong><ul><li><strong>cellId</strong> (<code>str</code>)</li><li><strong>changeAuditStamps</strong> (<a href="#datahub.metadata.schema_classes.ChangeAuditStampsClass"><code>ChangeAuditStampsClass</code></a>) – </li><li><strong>rawQuery</strong> (<code>str</code>)</li><li><strong>cellTitle</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>lastExecuted</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-cellid--str-1"><em>property</em> cellId <em>: str</em><a href="#property-cellid--str-1" class="hash-link" aria-label="Direct link to property-cellid--str-1" title="Direct link to property-cellid--str-1"></a></h4><p>Unique id for the cell. This id should be globally unique for a Notebook tool even when there are multiple deployments of it. As an example, Notebook URL could be used here for QueryBook such as ‘querybook.com/notebook/773/?cellId=1234’</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-celltitle--none--str-1"><em>property</em> cellTitle <em>: None | str</em><a href="#property-celltitle--none--str-1" class="hash-link" aria-label="Direct link to property-celltitle--none--str-1" title="Direct link to property-celltitle--none--str-1"></a></h4><p>Title of the cell</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-changeauditstamps--changeauditstampsclass-2"><em>property</em> changeAuditStamps <em>: <a href="#datahub.metadata.schema_classes.ChangeAuditStampsClass">ChangeAuditStampsClass</a></em><a href="#property-changeauditstamps--changeauditstampsclass-2" class="hash-link" aria-label="Direct link to property-changeauditstamps--changeauditstampsclass-2" title="Direct link to property-changeauditstamps--changeauditstampsclass-2"></a></h4><p>Captures information about who created/last modified/deleted this Notebook cell and when</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastexecuted--none--auditstampclass"><em>property</em> lastExecuted <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastexecuted--none--auditstampclass" class="hash-link" aria-label="Direct link to property-lastexecuted--none--auditstampclass" title="Direct link to property-lastexecuted--none--auditstampclass"></a></h4><p>Captures information about who last executed this query cell and when</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-rawquery--str-1"><em>property</em> rawQuery <em>: str</em><a href="#property-rawquery--str-1" class="hash-link" aria-label="Direct link to property-rawquery--str-1" title="Direct link to property-rawquery--str-1"></a></h4><p>Raw query to explain some specific logic in a Notebook</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.QueryKeyClass"><span class="visually-hidden">QueryKeyClass</span><a href="#datahub.metadata.schema_classes.QueryKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.QueryKeyClass" title="Direct link to datahub.metadata.schema_classes.QueryKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">QueryKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.QueryKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Query</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-34"><em>property</em> id <em>: str</em><a href="#property-id--str-34" class="hash-link" aria-label="Direct link to property-id--str-34" title="Direct link to property-id--str-34"></a></h4><p>A unique id for the Query.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.QueryLanguageClass"><span class="visually-hidden">QueryLanguageClass</span><a href="#datahub.metadata.schema_classes.QueryLanguageClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.QueryLanguageClass" title="Direct link to datahub.metadata.schema_classes.QueryLanguageClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">QueryLanguageClass</span>()<a href="#datahub.metadata.schema_classes.QueryLanguageClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sql--sql-5">SQL <em>= 'SQL'</em><a href="#sql--sql-5" class="hash-link" aria-label="Direct link to sql--sql-5" title="Direct link to sql--sql-5"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="unknown--unknown-6">UNKNOWN <em>= 'UNKNOWN'</em><a href="#unknown--unknown-6" class="hash-link" aria-label="Direct link to unknown--unknown-6" title="Direct link to unknown--unknown-6"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.QueryPropertiesClass"><span class="visually-hidden">QueryPropertiesClass</span><a href="#datahub.metadata.schema_classes.QueryPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.QueryPropertiesClass" title="Direct link to datahub.metadata.schema_classes.QueryPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">QueryPropertiesClass</span>(<span class="arg-name">statement</span>, <span class="arg-name">source</span>, <span class="arg-name">created</span>, <span class="arg-name">lastModified</span>, <span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">name</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">origin</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.QueryPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a Query against one or more data assets (e.g. Tables or Views).</p><ul><li><strong>Parameters:</strong><ul><li><strong>statement</strong> (<a href="#datahub.metadata.schema_classes.QueryStatementClass"><code>QueryStatementClass</code></a>) – </li><li><strong>source</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.QuerySourceClass"><code>QuerySourceClass</code></a>]) – </li><li><strong>created</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li><li><strong>lastModified</strong> (<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>) – </li><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>origin</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--auditstampclass-17"><em>property</em> created <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--auditstampclass-17" class="hash-link" aria-label="Direct link to property-created--auditstampclass-17" title="Direct link to property-created--auditstampclass-17"></a></h4><p>Audit stamp capturing the time and actor who created the Query.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-27"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-27" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-27" title="Direct link to property-customproperties--dictstr-str-27"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-46"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-46" class="hash-link" aria-label="Direct link to property-description--none--str-46" title="Direct link to property-description--none--str-46"></a></h4><p>The Query description.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--auditstampclass-19"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--auditstampclass-19" class="hash-link" aria-label="Direct link to property-lastmodified--auditstampclass-19" title="Direct link to property-lastmodified--auditstampclass-19"></a></h4><p>Audit stamp capturing the time and actor who last modified the Query.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--none--str-11"><em>property</em> name <em>: None | str</em><a href="#property-name--none--str-11" class="hash-link" aria-label="Direct link to property-name--none--str-11" title="Direct link to property-name--none--str-11"></a></h4><p>Optional display name to identify the query.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-origin--none--str"><em>property</em> origin <em>: None | str</em><a href="#property-origin--none--str" class="hash-link" aria-label="Direct link to property-origin--none--str" title="Direct link to property-origin--none--str"></a></h4><p>The origin of the Query.
|
||
This is the source of the Query (e.g. a View, Stored Procedure, dbt Model, etc.) that the Query was created from.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-source--str--querysourceclass"><em>property</em> source <em>: str | <a href="#datahub.metadata.schema_classes.QuerySourceClass">QuerySourceClass</a></em><a href="#property-source--str--querysourceclass" class="hash-link" aria-label="Direct link to property-source--str--querysourceclass" title="Direct link to property-source--str--querysourceclass"></a></h4><p>The source of the Query</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-statement--querystatementclass"><em>property</em> statement <em>: <a href="#datahub.metadata.schema_classes.QueryStatementClass">QueryStatementClass</a></em><a href="#property-statement--querystatementclass" class="hash-link" aria-label="Direct link to property-statement--querystatementclass" title="Direct link to property-statement--querystatementclass"></a></h4><p>The Query Statement.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.QuerySourceClass"><span class="visually-hidden">QuerySourceClass</span><a href="#datahub.metadata.schema_classes.QuerySourceClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.QuerySourceClass" title="Direct link to datahub.metadata.schema_classes.QuerySourceClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">QuerySourceClass</span>()<a href="#datahub.metadata.schema_classes.QuerySourceClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="manual--manual-2">MANUAL <em>= 'MANUAL'</em><a href="#manual--manual-2" class="hash-link" aria-label="Direct link to manual--manual-2" title="Direct link to manual--manual-2"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="system--system-1">SYSTEM <em>= 'SYSTEM'</em><a href="#system--system-1" class="hash-link" aria-label="Direct link to system--system-1" title="Direct link to system--system-1"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.QueryStatementClass"><span class="visually-hidden">QueryStatementClass</span><a href="#datahub.metadata.schema_classes.QueryStatementClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.QueryStatementClass" title="Direct link to datahub.metadata.schema_classes.QueryStatementClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">QueryStatementClass</span>(<span class="arg-name">value</span>, <span class="arg-name">language</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.QueryStatementClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A query statement against one or more data assets.</p><ul><li><strong>Parameters:</strong><ul><li><strong>value</strong> (<code>str</code>)</li><li><strong>language</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.QueryLanguageClass"><code>QueryLanguageClass</code></a>, <code>None</code>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-language--str--querylanguageclass"><em>property</em> language <em>: str | <a href="#datahub.metadata.schema_classes.QueryLanguageClass">QueryLanguageClass</a></em><a href="#property-language--str--querylanguageclass" class="hash-link" aria-label="Direct link to property-language--str--querylanguageclass" title="Direct link to property-language--str--querylanguageclass"></a></h4><p>The language of the Query, e.g. SQL.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-value--str-4"><em>property</em> value <em>: str</em><a href="#property-value--str-4" class="hash-link" aria-label="Direct link to property-value--str-4" title="Direct link to property-value--str-4"></a></h4><p>The query text</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.QuerySubjectClass"><span class="visually-hidden">QuerySubjectClass</span><a href="#datahub.metadata.schema_classes.QuerySubjectClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.QuerySubjectClass" title="Direct link to datahub.metadata.schema_classes.QuerySubjectClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">QuerySubjectClass</span>(<span class="arg-name">entity</span>)<a href="#datahub.metadata.schema_classes.QuerySubjectClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A single subject of a particular query.
|
||
In the future, we may evolve this model to include richer details
|
||
about the Query Subject in relation to the query.</p><ul><li><strong>Parameters:</strong><strong>entity</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-entity--str-4"><em>property</em> entity <em>: str</em><a href="#property-entity--str-4" class="hash-link" aria-label="Direct link to property-entity--str-4" title="Direct link to property-entity--str-4"></a></h4><p>An entity which is the subject of a query.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.QuerySubjectsClass"><span class="visually-hidden">QuerySubjectsClass</span><a href="#datahub.metadata.schema_classes.QuerySubjectsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.QuerySubjectsClass" title="Direct link to datahub.metadata.schema_classes.QuerySubjectsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">QuerySubjectsClass</span>(<span class="arg-name">subjects</span>)<a href="#datahub.metadata.schema_classes.QuerySubjectsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about the subjects of a particular Query, i.e. the assets
|
||
being queried.</p><ul><li><strong>Parameters:</strong><strong>subjects</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.QuerySubjectClass"><code>QuerySubjectClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-subjects--listquerysubjectclass"><em>property</em> subjects <em>: List[<a href="#datahub.metadata.schema_classes.QuerySubjectClass">QuerySubjectClass</a>]</em><a href="#property-subjects--listquerysubjectclass" class="hash-link" aria-label="Direct link to property-subjects--listquerysubjectclass" title="Direct link to property-subjects--listquerysubjectclass"></a></h4><p>One or more subjects of the query.</p><p>In single-asset queries (e.g. table select), this will contain the Table reference
|
||
and optionally schema field references.</p><p>In multi-asset queries (e.g. table joins), this may contain multiple Table references
|
||
and optionally schema field references.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.QueryUsageStatisticsClass"><span class="visually-hidden">QueryUsageStatisticsClass</span><a href="#datahub.metadata.schema_classes.QueryUsageStatisticsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.QueryUsageStatisticsClass" title="Direct link to datahub.metadata.schema_classes.QueryUsageStatisticsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">QueryUsageStatisticsClass</span>(<span class="arg-name">timestampMillis</span>, <span class="arg-name">eventGranularity</span> = <span class="arg-default">None</span>, <span class="arg-name">partitionSpec</span> = <span class="arg-default">None</span>, <span class="arg-name">messageId</span> = <span class="arg-default">None</span>, <span class="arg-name">queryCount</span> = <span class="arg-default">None</span>, <span class="arg-name">queryCost</span> = <span class="arg-default">None</span>, <span class="arg-name">lastExecutedAt</span> = <span class="arg-default">None</span>, <span class="arg-name">uniqueUserCount</span> = <span class="arg-default">None</span>, <span class="arg-name">userCounts</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.QueryUsageStatisticsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Stats corresponding to dataset’s usage.</p><ul><li><strong>Parameters:</strong><ul><li><strong>timestampMillis</strong> (<code>int</code>)</li><li><strong>eventGranularity</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeWindowSizeClass"><code>TimeWindowSizeClass</code></a>]) – </li><li><strong>partitionSpec</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.PartitionSpecClass"><code>PartitionSpecClass</code></a>]) – </li><li><strong>messageId</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>queryCount</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>queryCost</strong> (<code>Optional</code>[<code>float</code>]<!-- -->)</li><li><strong>lastExecutedAt</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>uniqueUserCount</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>userCounts</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.DatasetUserUsageCountsClass"><code>DatasetUserUsageCountsClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="aspect_type--classvarstr--timeseries-9">ASPECT_TYPE <em>: <code>ClassVar</code>[<code>str</code>]</em> <em>= 'timeseries'</em><a href="#aspect_type--classvarstr--timeseries-9" class="hash-link" aria-label="Direct link to aspect_type--classvarstr--timeseries-9" title="Direct link to aspect_type--classvarstr--timeseries-9"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-eventgranularity--none--timewindowsizeclass-9"><em>property</em> eventGranularity <em>: None | <a href="#datahub.metadata.schema_classes.TimeWindowSizeClass">TimeWindowSizeClass</a></em><a href="#property-eventgranularity--none--timewindowsizeclass-9" class="hash-link" aria-label="Direct link to property-eventgranularity--none--timewindowsizeclass-9" title="Direct link to property-eventgranularity--none--timewindowsizeclass-9"></a></h4><p>Granularity of the event if applicable</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastexecutedat--none--int"><em>property</em> lastExecutedAt <em>: None | int</em><a href="#property-lastexecutedat--none--int" class="hash-link" aria-label="Direct link to property-lastexecutedat--none--int" title="Direct link to property-lastexecutedat--none--int"></a></h4><p>Last executed timestamp</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-messageid--none--str-9"><em>property</em> messageId <em>: None | str</em><a href="#property-messageid--none--str-9" class="hash-link" aria-label="Direct link to property-messageid--none--str-9" title="Direct link to property-messageid--none--str-9"></a></h4><p>The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-partitionspec--partitionspecclass--none-9"><em>property</em> partitionSpec <em>: <a href="#datahub.metadata.schema_classes.PartitionSpecClass">PartitionSpecClass</a> | None</em><a href="#property-partitionspec--partitionspecclass--none-9" class="hash-link" aria-label="Direct link to property-partitionspec--partitionspecclass--none-9" title="Direct link to property-partitionspec--partitionspecclass--none-9"></a></h4><p>The optional partition specification.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-querycost--none--float"><em>property</em> queryCost <em>: None | float</em><a href="#property-querycost--none--float" class="hash-link" aria-label="Direct link to property-querycost--none--float" title="Direct link to property-querycost--none--float"></a></h4><p>Query cost for this query and bucket</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-querycount--none--int"><em>property</em> queryCount <em>: None | int</em><a href="#property-querycount--none--int" class="hash-link" aria-label="Direct link to property-querycount--none--int" title="Direct link to property-querycount--none--int"></a></h4><p>Total query count in this bucket</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-timestampmillis--int-10"><em>property</em> timestampMillis <em>: int</em><a href="#property-timestampmillis--int-10" class="hash-link" aria-label="Direct link to property-timestampmillis--int-10" title="Direct link to property-timestampmillis--int-10"></a></h4><p>The event timestamp field as epoch at UTC in milli seconds.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-uniqueusercount--none--int-3"><em>property</em> uniqueUserCount <em>: None | int</em><a href="#property-uniqueusercount--none--int-3" class="hash-link" aria-label="Direct link to property-uniqueusercount--none--int-3" title="Direct link to property-uniqueusercount--none--int-3"></a></h4><p>Unique user count</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-usercounts--none--listdatasetuserusagecountsclass-1"><em>property</em> userCounts <em>: None | List[<a href="#datahub.metadata.schema_classes.DatasetUserUsageCountsClass">DatasetUserUsageCountsClass</a>]</em><a href="#property-usercounts--none--listdatasetuserusagecountsclass-1" class="hash-link" aria-label="Direct link to property-usercounts--none--listdatasetuserusagecountsclass-1" title="Direct link to property-usercounts--none--listdatasetuserusagecountsclass-1"></a></h4><p>Users within this bucket, with frequency counts</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.RecordTypeClass"><span class="visually-hidden">RecordTypeClass</span><a href="#datahub.metadata.schema_classes.RecordTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.RecordTypeClass" title="Direct link to datahub.metadata.schema_classes.RecordTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">RecordTypeClass</span>()<a href="#datahub.metadata.schema_classes.RecordTypeClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Record field type.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.RelationshipFieldMappingClass"><span class="visually-hidden">RelationshipFieldMappingClass</span><a href="#datahub.metadata.schema_classes.RelationshipFieldMappingClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.RelationshipFieldMappingClass" title="Direct link to datahub.metadata.schema_classes.RelationshipFieldMappingClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">RelationshipFieldMappingClass</span>(<span class="arg-name">sourceField</span>, <span class="arg-name">destinationField</span>)<a href="#datahub.metadata.schema_classes.RelationshipFieldMappingClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Individual Field Mapping of a relationship- one of several</p><ul><li><strong>Parameters:</strong><ul><li><strong>sourceField</strong> (<code>str</code>)</li><li><strong>destinationField</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-destinationfield--str-1"><em>property</em> destinationField <em>: str</em><a href="#property-destinationfield--str-1" class="hash-link" aria-label="Direct link to property-destinationfield--str-1" title="Direct link to property-destinationfield--str-1"></a></h4><p>1</p><ul><li><strong>Type:</strong>
|
||
All fields from dataset B that are required for the join, maps to aFields 1</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-sourcefield--str"><em>property</em> sourceField <em>: str</em><a href="#property-sourcefield--str" class="hash-link" aria-label="Direct link to property-sourcefield--str" title="Direct link to property-sourcefield--str"></a></h4><p>1</p><ul><li><strong>Type:</strong>
|
||
All fields from dataset A that are required for the join, maps to bFields 1</li></ul></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.RetentionClass"><span class="visually-hidden">RetentionClass</span><a href="#datahub.metadata.schema_classes.RetentionClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.RetentionClass" title="Direct link to datahub.metadata.schema_classes.RetentionClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">RetentionClass</span>(<span class="arg-name">version</span> = <span class="arg-default">None</span>, <span class="arg-name">time</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.RetentionClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Base class that encapsulates different retention policies.
|
||
Only one of the fields should be set</p><ul><li><strong>Parameters:</strong><ul><li><strong>version</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.VersionBasedRetentionClass"><code>VersionBasedRetentionClass</code></a>]) – </li><li><strong>time</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.TimeBasedRetentionClass"><code>TimeBasedRetentionClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-time--none--timebasedretentionclass"><em>property</em> time <em>: None | <a href="#datahub.metadata.schema_classes.TimeBasedRetentionClass">TimeBasedRetentionClass</a></em><a href="#property-time--none--timebasedretentionclass" class="hash-link" aria-label="Direct link to property-time--none--timebasedretentionclass" title="Direct link to property-time--none--timebasedretentionclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-version--none--versionbasedretentionclass"><em>property</em> version <em>: None | <a href="#datahub.metadata.schema_classes.VersionBasedRetentionClass">VersionBasedRetentionClass</a></em><a href="#property-version--none--versionbasedretentionclass" class="hash-link" aria-label="Direct link to property-version--none--versionbasedretentionclass" title="Direct link to property-version--none--versionbasedretentionclass"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.RichTextModuleParamsClass"><span class="visually-hidden">RichTextModuleParamsClass</span><a href="#datahub.metadata.schema_classes.RichTextModuleParamsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.RichTextModuleParamsClass" title="Direct link to datahub.metadata.schema_classes.RichTextModuleParamsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">RichTextModuleParamsClass</span>(<span class="arg-name">content</span>)<a href="#datahub.metadata.schema_classes.RichTextModuleParamsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><strong>content</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-content--str"><em>property</em> content <em>: str</em><a href="#property-content--str" class="hash-link" aria-label="Direct link to property-content--str" title="Direct link to property-content--str"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.RoleAssociationClass"><span class="visually-hidden">RoleAssociationClass</span><a href="#datahub.metadata.schema_classes.RoleAssociationClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.RoleAssociationClass" title="Direct link to datahub.metadata.schema_classes.RoleAssociationClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">RoleAssociationClass</span>(<span class="arg-name">urn</span>)<a href="#datahub.metadata.schema_classes.RoleAssociationClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Properties of an applied Role. For now, just an Urn</p><ul><li><strong>Parameters:</strong><strong>urn</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-22"><em>property</em> urn <em>: str</em><a href="#property-urn--str-22" class="hash-link" aria-label="Direct link to property-urn--str-22" title="Direct link to property-urn--str-22"></a></h4><p>Urn of the External Role</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.RoleKeyClass"><span class="visually-hidden">RoleKeyClass</span><a href="#datahub.metadata.schema_classes.RoleKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.RoleKeyClass" title="Direct link to datahub.metadata.schema_classes.RoleKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">RoleKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.RoleKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a External AccessManagement</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-35"><em>property</em> id <em>: str</em><a href="#property-id--str-35" class="hash-link" aria-label="Direct link to property-id--str-35" title="Direct link to property-id--str-35"></a></h4><p>A unique id for the access management IAM.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.RoleMembershipClass"><span class="visually-hidden">RoleMembershipClass</span><a href="#datahub.metadata.schema_classes.RoleMembershipClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.RoleMembershipClass" title="Direct link to datahub.metadata.schema_classes.RoleMembershipClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">RoleMembershipClass</span>(<span class="arg-name">roles</span>)<a href="#datahub.metadata.schema_classes.RoleMembershipClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Carries information about which roles a user or group is assigned to.</p><ul><li><strong>Parameters:</strong><strong>roles</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-roles--liststr"><em>property</em> roles <em>: List<!-- -->[str]</em><a href="#property-roles--liststr" class="hash-link" aria-label="Direct link to property-roles--liststr" title="Direct link to property-roles--liststr"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.RolePropertiesClass"><span class="visually-hidden">RolePropertiesClass</span><a href="#datahub.metadata.schema_classes.RolePropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.RolePropertiesClass" title="Direct link to datahub.metadata.schema_classes.RolePropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">RolePropertiesClass</span>(<span class="arg-name">name</span>, <span class="arg-name">type</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">requestUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.RolePropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a ExternalRoleProperties</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>type</strong> (<code>str</code>)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>requestUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--none--auditstampclass-8"><em>property</em> created <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--none--auditstampclass-8" class="hash-link" aria-label="Direct link to property-created--none--auditstampclass-8" title="Direct link to property-created--none--auditstampclass-8"></a></h4><p>Created Audit stamp</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-47"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-47" class="hash-link" aria-label="Direct link to property-description--none--str-47" title="Direct link to property-description--none--str-47"></a></h4><p>Description of the IAM Role</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-32"><em>property</em> name <em>: str</em><a href="#property-name--str-32" class="hash-link" aria-label="Direct link to property-name--str-32" title="Direct link to property-name--str-32"></a></h4><p>Display name of the IAM Role in the external system</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-requesturl--none--str"><em>property</em> requestUrl <em>: None | str</em><a href="#property-requesturl--none--str" class="hash-link" aria-label="Direct link to property-requesturl--none--str" title="Direct link to property-requesturl--none--str"></a></h4><p>Link to access external access management</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str-5"><em>property</em> type <em>: str</em><a href="#property-type--str-5" class="hash-link" aria-label="Direct link to property-type--str-5" title="Direct link to property-type--str-5"></a></h4><p>Can be READ, ADMIN, WRITE</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.RoleUserClass"><span class="visually-hidden">RoleUserClass</span><a href="#datahub.metadata.schema_classes.RoleUserClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.RoleUserClass" title="Direct link to datahub.metadata.schema_classes.RoleUserClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">RoleUserClass</span>(<span class="arg-name">user</span>)<a href="#datahub.metadata.schema_classes.RoleUserClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Provisioned users of a role</p><ul><li><strong>Parameters:</strong><strong>user</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-user--str-3"><em>property</em> user <em>: str</em><a href="#property-user--str-3" class="hash-link" aria-label="Direct link to property-user--str-3" title="Direct link to property-user--str-3"></a></h4><p>Link provisioned corp user for a role</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.RowCountChangeClass"><span class="visually-hidden">RowCountChangeClass</span><a href="#datahub.metadata.schema_classes.RowCountChangeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.RowCountChangeClass" title="Direct link to datahub.metadata.schema_classes.RowCountChangeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">RowCountChangeClass</span>(<span class="arg-name">type</span>, <span class="arg-name">operator</span>, <span class="arg-name">parameters</span>)<a href="#datahub.metadata.schema_classes.RowCountChangeClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Attributes defining a ROW_COUNT_CHANGE volume assertion.</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.AssertionValueChangeTypeClass"><code>AssertionValueChangeTypeClass</code></a>]) – </li><li><strong>operator</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.AssertionStdOperatorClass"><code>AssertionStdOperatorClass</code></a>]) – </li><li><strong>parameters</strong> (<a href="#datahub.metadata.schema_classes.AssertionStdParametersClass"><code>AssertionStdParametersClass</code></a>) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-operator--str--assertionstdoperatorclass-5"><em>property</em> operator <em>: str | <a href="#datahub.metadata.schema_classes.AssertionStdOperatorClass">AssertionStdOperatorClass</a></em><a href="#property-operator--str--assertionstdoperatorclass-5" class="hash-link" aria-label="Direct link to property-operator--str--assertionstdoperatorclass-5" title="Direct link to property-operator--str--assertionstdoperatorclass-5"></a></h4><p>The operator you’d like to apply.</p><p>Note that only numeric operators are valid inputs:
|
||
GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO,
|
||
BETWEEN.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-parameters--assertionstdparametersclass-2"><em>property</em> parameters <em>: <a href="#datahub.metadata.schema_classes.AssertionStdParametersClass">AssertionStdParametersClass</a></em><a href="#property-parameters--assertionstdparametersclass-2" class="hash-link" aria-label="Direct link to property-parameters--assertionstdparametersclass-2" title="Direct link to property-parameters--assertionstdparametersclass-2"></a></h4><p>The parameters you’d like to provide as input to the operator.</p><p>Note that only numeric parameter types are valid inputs: NUMBER.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--assertionvaluechangetypeclass-1"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.AssertionValueChangeTypeClass">AssertionValueChangeTypeClass</a></em><a href="#property-type--str--assertionvaluechangetypeclass-1" class="hash-link" aria-label="Direct link to property-type--str--assertionvaluechangetypeclass-1" title="Direct link to property-type--str--assertionvaluechangetypeclass-1"></a></h4><p>a fixed absolute value or a relative percentage.</p><ul><li><strong>Type:</strong>
|
||
The type of the value used to evaluate the assertion</li></ul></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.RowCountTotalClass"><span class="visually-hidden">RowCountTotalClass</span><a href="#datahub.metadata.schema_classes.RowCountTotalClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.RowCountTotalClass" title="Direct link to datahub.metadata.schema_classes.RowCountTotalClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">RowCountTotalClass</span>(<span class="arg-name">operator</span>, <span class="arg-name">parameters</span>)<a href="#datahub.metadata.schema_classes.RowCountTotalClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Attributes defining a ROW_COUNT_TOTAL volume assertion.</p><ul><li><strong>Parameters:</strong><ul><li><strong>operator</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.AssertionStdOperatorClass"><code>AssertionStdOperatorClass</code></a>]) – </li><li><strong>parameters</strong> (<a href="#datahub.metadata.schema_classes.AssertionStdParametersClass"><code>AssertionStdParametersClass</code></a>) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-operator--str--assertionstdoperatorclass-6"><em>property</em> operator <em>: str | <a href="#datahub.metadata.schema_classes.AssertionStdOperatorClass">AssertionStdOperatorClass</a></em><a href="#property-operator--str--assertionstdoperatorclass-6" class="hash-link" aria-label="Direct link to property-operator--str--assertionstdoperatorclass-6" title="Direct link to property-operator--str--assertionstdoperatorclass-6"></a></h4><p>The operator you’d like to apply.</p><p>Note that only numeric operators are valid inputs:
|
||
GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO,
|
||
BETWEEN.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-parameters--assertionstdparametersclass-3"><em>property</em> parameters <em>: <a href="#datahub.metadata.schema_classes.AssertionStdParametersClass">AssertionStdParametersClass</a></em><a href="#property-parameters--assertionstdparametersclass-3" class="hash-link" aria-label="Direct link to property-parameters--assertionstdparametersclass-3" title="Direct link to property-parameters--assertionstdparametersclass-3"></a></h4><p>The parameters you’d like to provide as input to the operator.</p><p>Note that only numeric parameter types are valid inputs: NUMBER.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.RunResultTypeClass"><span class="visually-hidden">RunResultTypeClass</span><a href="#datahub.metadata.schema_classes.RunResultTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.RunResultTypeClass" title="Direct link to datahub.metadata.schema_classes.RunResultTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">RunResultTypeClass</span>()<a href="#datahub.metadata.schema_classes.RunResultTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="failure--failure-1">FAILURE <em>= 'FAILURE'</em><a href="#failure--failure-1" class="hash-link" aria-label="Direct link to failure--failure-1" title="Direct link to failure--failure-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="skipped--skipped-1">SKIPPED <em>= 'SKIPPED'</em><a href="#skipped--skipped-1" class="hash-link" aria-label="Direct link to skipped--skipped-1" title="Direct link to skipped--skipped-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="success--success-1">SUCCESS <em>= 'SUCCESS'</em><a href="#success--success-1" class="hash-link" aria-label="Direct link to success--success-1" title="Direct link to success--success-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="up_for_retry--up_for_retry">UP_FOR_RETRY <em>= 'UP_FOR_RETRY'</em><a href="#up_for_retry--up_for_retry" class="hash-link" aria-label="Direct link to up_for_retry--up_for_retry" title="Direct link to up_for_retry--up_for_retry"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SchemaAssertionCompatibilityClass"><span class="visually-hidden">SchemaAssertionCompatibilityClass</span><a href="#datahub.metadata.schema_classes.SchemaAssertionCompatibilityClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SchemaAssertionCompatibilityClass" title="Direct link to datahub.metadata.schema_classes.SchemaAssertionCompatibilityClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SchemaAssertionCompatibilityClass</span>()<a href="#datahub.metadata.schema_classes.SchemaAssertionCompatibilityClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="exact_match--exact_match">EXACT_MATCH <em>= 'EXACT_MATCH'</em><a href="#exact_match--exact_match" class="hash-link" aria-label="Direct link to exact_match--exact_match" title="Direct link to exact_match--exact_match"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="subset--subset">SUBSET <em>= 'SUBSET'</em><a href="#subset--subset" class="hash-link" aria-label="Direct link to subset--subset" title="Direct link to subset--subset"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="superset--superset">SUPERSET <em>= 'SUPERSET'</em><a href="#superset--superset" class="hash-link" aria-label="Direct link to superset--superset" title="Direct link to superset--superset"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SchemaAssertionInfoClass"><span class="visually-hidden">SchemaAssertionInfoClass</span><a href="#datahub.metadata.schema_classes.SchemaAssertionInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SchemaAssertionInfoClass" title="Direct link to datahub.metadata.schema_classes.SchemaAssertionInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SchemaAssertionInfoClass</span>(<span class="arg-name">entity</span>, <span class="arg-name">schema</span>, <span class="arg-name">compatibility</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.SchemaAssertionInfoClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Attributes that are applicable to schema assertions</p><ul><li><strong>Parameters:</strong><ul><li><strong>entity</strong> (<code>str</code>)</li><li><strong>schema</strong> (<a href="#datahub.metadata.schema_classes.SchemaMetadataClass"><code>SchemaMetadataClass</code></a>) – </li><li><strong>compatibility</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.SchemaAssertionCompatibilityClass"><code>SchemaAssertionCompatibilityClass</code></a>, <code>None</code>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-compatibility--str--schemaassertioncompatibilityclass--none"><em>property</em> compatibility <em>: str | <a href="#datahub.metadata.schema_classes.SchemaAssertionCompatibilityClass">SchemaAssertionCompatibilityClass</a> | None</em><a href="#property-compatibility--str--schemaassertioncompatibilityclass--none" class="hash-link" aria-label="Direct link to property-compatibility--str--schemaassertioncompatibilityclass--none" title="Direct link to property-compatibility--str--schemaassertioncompatibilityclass--none"></a></h4><p>The required compatibility level for the schema assertion to pass.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-entity--str-5"><em>property</em> entity <em>: str</em><a href="#property-entity--str-5" class="hash-link" aria-label="Direct link to property-entity--str-5" title="Direct link to property-entity--str-5"></a></h4><p>The entity targeted by the assertion</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-schema--schemametadataclass"><em>property</em> schema <em>: <a href="#datahub.metadata.schema_classes.SchemaMetadataClass">SchemaMetadataClass</a></em><a href="#property-schema--schemametadataclass" class="hash-link" aria-label="Direct link to property-schema--schemametadataclass" title="Direct link to property-schema--schemametadataclass"></a></h4><p>A definition of the expected structure for the asset</p><p>Note that many of the fields of this model, especially those related to metadata (tags, terms)
|
||
will go unused in this context.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SchemaContractClass"><span class="visually-hidden">SchemaContractClass</span><a href="#datahub.metadata.schema_classes.SchemaContractClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SchemaContractClass" title="Direct link to datahub.metadata.schema_classes.SchemaContractClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SchemaContractClass</span>(<span class="arg-name">assertion</span>)<a href="#datahub.metadata.schema_classes.SchemaContractClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Expectations for a logical schema</p><ul><li><strong>Parameters:</strong><strong>assertion</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-assertion--str-2"><em>property</em> assertion <em>: str</em><a href="#property-assertion--str-2" class="hash-link" aria-label="Direct link to property-assertion--str-2" title="Direct link to property-assertion--str-2"></a></h4><p>The assertion representing the schema contract.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SchemaFieldAliasesClass"><span class="visually-hidden">SchemaFieldAliasesClass</span><a href="#datahub.metadata.schema_classes.SchemaFieldAliasesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SchemaFieldAliasesClass" title="Direct link to datahub.metadata.schema_classes.SchemaFieldAliasesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SchemaFieldAliasesClass</span>(<span class="arg-name">aliases</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.SchemaFieldAliasesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><ul><li><strong>Parameters:</strong><strong>aliases</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aliases--none--liststr"><em>property</em> aliases <em>: None | List<!-- -->[str]</em><a href="#property-aliases--none--liststr" class="hash-link" aria-label="Direct link to property-aliases--none--liststr" title="Direct link to property-aliases--none--liststr"></a></h4><p>Used to store aliases</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SchemaFieldClass"><span class="visually-hidden">SchemaFieldClass</span><a href="#datahub.metadata.schema_classes.SchemaFieldClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SchemaFieldClass" title="Direct link to datahub.metadata.schema_classes.SchemaFieldClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SchemaFieldClass</span>(<span class="arg-name">fieldPath</span>, <span class="arg-name">type</span>, <span class="arg-name">nativeDataType</span>, <span class="arg-name">jsonPath</span> = <span class="arg-default">None</span>, <span class="arg-name">nullable</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">label</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>, <span class="arg-name">recursive</span> = <span class="arg-default">None</span>, <span class="arg-name">globalTags</span> = <span class="arg-default">None</span>, <span class="arg-name">glossaryTerms</span> = <span class="arg-default">None</span>, <span class="arg-name">isPartOfKey</span> = <span class="arg-default">None</span>, <span class="arg-name">isPartitioningKey</span> = <span class="arg-default">None</span>, <span class="arg-name">jsonProps</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.SchemaFieldClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>SchemaField to describe metadata related to dataset schema.</p><ul><li><strong>Parameters:</strong><ul><li><strong>fieldPath</strong> (<code>str</code>)</li><li><strong>type</strong> (<a href="#datahub.metadata.schema_classes.SchemaFieldDataTypeClass"><code>SchemaFieldDataTypeClass</code></a>) – </li><li><strong>nativeDataType</strong> (<code>str</code>)</li><li><strong>jsonPath</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>nullable</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>label</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>recursive</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>globalTags</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.GlobalTagsClass"><code>GlobalTagsClass</code></a>]) – </li><li><strong>glossaryTerms</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.GlossaryTermsClass"><code>GlossaryTermsClass</code></a>]) – </li><li><strong>isPartOfKey</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>isPartitioningKey</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>jsonProps</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--none--auditstampclass-9"><em>property</em> created <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--none--auditstampclass-9" class="hash-link" aria-label="Direct link to property-created--none--auditstampclass-9" title="Direct link to property-created--none--auditstampclass-9"></a></h4><p>An AuditStamp corresponding to the creation of this schema field.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-48"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-48" class="hash-link" aria-label="Direct link to property-description--none--str-48" title="Direct link to property-description--none--str-48"></a></h4><p>Description</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fieldpath--str-5"><em>property</em> fieldPath <em>: str</em><a href="#property-fieldpath--str-5" class="hash-link" aria-label="Direct link to property-fieldpath--str-5" title="Direct link to property-fieldpath--str-5"></a></h4><p>Flattened name of the field. Field is computed from jsonPath field.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-globaltags--none--globaltagsclass-2"><em>property</em> globalTags <em>: None | <a href="#datahub.metadata.schema_classes.GlobalTagsClass">GlobalTagsClass</a></em><a href="#property-globaltags--none--globaltagsclass-2" class="hash-link" aria-label="Direct link to property-globaltags--none--globaltagsclass-2" title="Direct link to property-globaltags--none--globaltagsclass-2"></a></h4><p>Tags associated with the field</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-glossaryterms--none--glossarytermsclass-2"><em>property</em> glossaryTerms <em>: None | <a href="#datahub.metadata.schema_classes.GlossaryTermsClass">GlossaryTermsClass</a></em><a href="#property-glossaryterms--none--glossarytermsclass-2" class="hash-link" aria-label="Direct link to property-glossaryterms--none--glossarytermsclass-2" title="Direct link to property-glossaryterms--none--glossarytermsclass-2"></a></h4><p>Glossary terms associated with the field</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-ispartofkey--bool"><em>property</em> isPartOfKey <em>: bool</em><a href="#property-ispartofkey--bool" class="hash-link" aria-label="Direct link to property-ispartofkey--bool" title="Direct link to property-ispartofkey--bool"></a></h4><p>For schema fields that are part of complex keys, set this field to true
|
||
We do this to easily distinguish between value and key fields</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-ispartitioningkey--none--bool"><em>property</em> isPartitioningKey <em>: None | bool</em><a href="#property-ispartitioningkey--none--bool" class="hash-link" aria-label="Direct link to property-ispartitioningkey--none--bool" title="Direct link to property-ispartitioningkey--none--bool"></a></h4><p>For Datasets which are partitioned, this determines the partitioning key.
|
||
Note that multiple columns can be part of a partitioning key, but currently we do not support
|
||
rendering the ordered partitioning key.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-jsonpath--none--str"><em>property</em> jsonPath <em>: None | str</em><a href="#property-jsonpath--none--str" class="hash-link" aria-label="Direct link to property-jsonpath--none--str" title="Direct link to property-jsonpath--none--str"></a></h4><p>Flattened name of a field in JSON Path notation.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-jsonprops--none--str"><em>property</em> jsonProps <em>: None | str</em><a href="#property-jsonprops--none--str" class="hash-link" aria-label="Direct link to property-jsonprops--none--str" title="Direct link to property-jsonprops--none--str"></a></h4><p>For schema fields that have other properties that are not modeled explicitly,
|
||
use this field to serialize those properties into a JSON string</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-label--none--str"><em>property</em> label <em>: None | str</em><a href="#property-label--none--str" class="hash-link" aria-label="Direct link to property-label--none--str" title="Direct link to property-label--none--str"></a></h4><p>Label of the field. Provides a more human-readable name for the field than field path. Some sources will
|
||
provide this metadata but not all sources have the concept of a label. If just one string is associated with
|
||
a field in a source, that is most likely a description.</p><p>Note that this field is deprecated and is not surfaced in the UI.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--none--auditstampclass-4"><em>property</em> lastModified <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--none--auditstampclass-4" class="hash-link" aria-label="Direct link to property-lastmodified--none--auditstampclass-4" title="Direct link to property-lastmodified--none--auditstampclass-4"></a></h4><p>An AuditStamp corresponding to the last modification of this schema field.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-nativedatatype--str"><em>property</em> nativeDataType <em>: str</em><a href="#property-nativedatatype--str" class="hash-link" aria-label="Direct link to property-nativedatatype--str" title="Direct link to property-nativedatatype--str"></a></h4><p>The native type of the field in the dataset’s platform as declared by platform schema.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-nullable--bool"><em>property</em> nullable <em>: bool</em><a href="#property-nullable--bool" class="hash-link" aria-label="Direct link to property-nullable--bool" title="Direct link to property-nullable--bool"></a></h4><p>Indicates if this field is optional or nullable</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-recursive--bool"><em>property</em> recursive <em>: bool</em><a href="#property-recursive--bool" class="hash-link" aria-label="Direct link to property-recursive--bool" title="Direct link to property-recursive--bool"></a></h4><p>There are use cases when a field in type B references type A. A field in A references field of type B. In such cases, we will mark the first field as recursive.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--schemafielddatatypeclass"><em>property</em> type <em>: <a href="#datahub.metadata.schema_classes.SchemaFieldDataTypeClass">SchemaFieldDataTypeClass</a></em><a href="#property-type--schemafielddatatypeclass" class="hash-link" aria-label="Direct link to property-type--schemafielddatatypeclass" title="Direct link to property-type--schemafielddatatypeclass"></a></h4><p>Platform independent field type of the field.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SchemaFieldDataTypeClass"><span class="visually-hidden">SchemaFieldDataTypeClass</span><a href="#datahub.metadata.schema_classes.SchemaFieldDataTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SchemaFieldDataTypeClass" title="Direct link to datahub.metadata.schema_classes.SchemaFieldDataTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SchemaFieldDataTypeClass</span>(<span class="arg-name">type</span>)<a href="#datahub.metadata.schema_classes.SchemaFieldDataTypeClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Schema field data types</p><ul><li><strong>Parameters:</strong><strong>type</strong> (<code>Union</code>[<a href="#datahub.metadata.schema_classes.BooleanTypeClass"><code>BooleanTypeClass</code></a>, <a href="#datahub.metadata.schema_classes.FixedTypeClass"><code>FixedTypeClass</code></a>, <a href="#datahub.metadata.schema_classes.StringTypeClass"><code>StringTypeClass</code></a>, <a href="#datahub.metadata.schema_classes.BytesTypeClass"><code>BytesTypeClass</code></a>, <a href="#datahub.metadata.schema_classes.NumberTypeClass"><code>NumberTypeClass</code></a>, <a href="#datahub.metadata.schema_classes.DateTypeClass"><code>DateTypeClass</code></a>, <a href="#datahub.metadata.schema_classes.TimeTypeClass"><code>TimeTypeClass</code></a>, <a href="#datahub.metadata.schema_classes.EnumTypeClass"><code>EnumTypeClass</code></a>, <a href="#datahub.metadata.schema_classes.NullTypeClass"><code>NullTypeClass</code></a>, <a href="#datahub.metadata.schema_classes.MapTypeClass"><code>MapTypeClass</code></a>, <a href="#datahub.metadata.schema_classes.ArrayTypeClass"><code>ArrayTypeClass</code></a>, <a href="#datahub.metadata.schema_classes.UnionTypeClass"><code>UnionTypeClass</code></a>, <a href="#datahub.metadata.schema_classes.RecordTypeClass"><code>RecordTypeClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--booleantypeclass--fixedtypeclass--stringtypeclass--bytestypeclass--numbertypeclass--datetypeclass--timetypeclass--enumtypeclass--nulltypeclass--maptypeclass--arraytypeclass--uniontypeclass--recordtypeclass"><em>property</em> type <em>: <a href="#datahub.metadata.schema_classes.BooleanTypeClass">BooleanTypeClass</a> | <a href="#datahub.metadata.schema_classes.FixedTypeClass">FixedTypeClass</a> | <a href="#datahub.metadata.schema_classes.StringTypeClass">StringTypeClass</a> | <a href="#datahub.metadata.schema_classes.BytesTypeClass">BytesTypeClass</a> | <a href="#datahub.metadata.schema_classes.NumberTypeClass">NumberTypeClass</a> | <a href="#datahub.metadata.schema_classes.DateTypeClass">DateTypeClass</a> | <a href="#datahub.metadata.schema_classes.TimeTypeClass">TimeTypeClass</a> | <a href="#datahub.metadata.schema_classes.EnumTypeClass">EnumTypeClass</a> | <a href="#datahub.metadata.schema_classes.NullTypeClass">NullTypeClass</a> | <a href="#datahub.metadata.schema_classes.MapTypeClass">MapTypeClass</a> | <a href="#datahub.metadata.schema_classes.ArrayTypeClass">ArrayTypeClass</a> | <a href="#datahub.metadata.schema_classes.UnionTypeClass">UnionTypeClass</a> | <a href="#datahub.metadata.schema_classes.RecordTypeClass">RecordTypeClass</a></em><a href="#property-type--booleantypeclass--fixedtypeclass--stringtypeclass--bytestypeclass--numbertypeclass--datetypeclass--timetypeclass--enumtypeclass--nulltypeclass--maptypeclass--arraytypeclass--uniontypeclass--recordtypeclass" class="hash-link" aria-label="Direct link to property-type--booleantypeclass--fixedtypeclass--stringtypeclass--bytestypeclass--numbertypeclass--datetypeclass--timetypeclass--enumtypeclass--nulltypeclass--maptypeclass--arraytypeclass--uniontypeclass--recordtypeclass" title="Direct link to property-type--booleantypeclass--fixedtypeclass--stringtypeclass--bytestypeclass--numbertypeclass--datetypeclass--timetypeclass--enumtypeclass--nulltypeclass--maptypeclass--arraytypeclass--uniontypeclass--recordtypeclass"></a></h4><p>Data platform specific types</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SchemaFieldInfoClass"><span class="visually-hidden">SchemaFieldInfoClass</span><a href="#datahub.metadata.schema_classes.SchemaFieldInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SchemaFieldInfoClass" title="Direct link to datahub.metadata.schema_classes.SchemaFieldInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SchemaFieldInfoClass</span>(<span class="arg-name">name</span> = <span class="arg-default">None</span>, <span class="arg-name">schemaFieldAliases</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.SchemaFieldInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>schemaFieldAliases</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--none--str-12"><em>property</em> name <em>: None | str</em><a href="#property-name--none--str-12" class="hash-link" aria-label="Direct link to property-name--none--str-12" title="Direct link to property-name--none--str-12"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-schemafieldaliases--none--liststr"><em>property</em> schemaFieldAliases <em>: None | List<!-- -->[str]</em><a href="#property-schemafieldaliases--none--liststr" class="hash-link" aria-label="Direct link to property-schemafieldaliases--none--liststr" title="Direct link to property-schemafieldaliases--none--liststr"></a></h4><p>Used to store field path variations for the schemaField urn.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SchemaFieldKeyClass"><span class="visually-hidden">SchemaFieldKeyClass</span><a href="#datahub.metadata.schema_classes.SchemaFieldKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SchemaFieldKeyClass" title="Direct link to datahub.metadata.schema_classes.SchemaFieldKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SchemaFieldKeyClass</span>(<span class="arg-name">parent</span>, <span class="arg-name">fieldPath</span>)<a href="#datahub.metadata.schema_classes.SchemaFieldKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a SchemaField</p><ul><li><strong>Parameters:</strong><ul><li><strong>parent</strong> (<code>str</code>)</li><li><strong>fieldPath</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fieldpath--str-6"><em>property</em> fieldPath <em>: str</em><a href="#property-fieldpath--str-6" class="hash-link" aria-label="Direct link to property-fieldpath--str-6" title="Direct link to property-fieldpath--str-6"></a></h4><p>fieldPath identifying the schema field</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-parent--str"><em>property</em> parent <em>: str</em><a href="#property-parent--str" class="hash-link" aria-label="Direct link to property-parent--str" title="Direct link to property-parent--str"></a></h4><p>Parent associated with the schema field</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SchemaFieldSnapshotClass"><span class="visually-hidden">SchemaFieldSnapshotClass</span><a href="#datahub.metadata.schema_classes.SchemaFieldSnapshotClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SchemaFieldSnapshotClass" title="Direct link to datahub.metadata.schema_classes.SchemaFieldSnapshotClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SchemaFieldSnapshotClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">aspects</span>)<a href="#datahub.metadata.schema_classes.SchemaFieldSnapshotClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A metadata snapshot for a specific schema field entity.</p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>aspects</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.SchemaFieldKeyClass"><code>SchemaFieldKeyClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspects--listschemafieldkeyclass"><em>property</em> aspects <em>: List[<a href="#datahub.metadata.schema_classes.SchemaFieldKeyClass">SchemaFieldKeyClass</a>]</em><a href="#property-aspects--listschemafieldkeyclass" class="hash-link" aria-label="Direct link to property-aspects--listschemafieldkeyclass" title="Direct link to property-aspects--listschemafieldkeyclass"></a></h4><p>The list of metadata aspects associated with the dataset. Depending on the use case, this can either be all, or a selection, of supported aspects.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-23"><em>property</em> urn <em>: str</em><a href="#property-urn--str-23" class="hash-link" aria-label="Direct link to property-urn--str-23" title="Direct link to property-urn--str-23"></a></h4><p>URN for the entity the metadata snapshot is associated with.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SchemaFieldSpecClass"><span class="visually-hidden">SchemaFieldSpecClass</span><a href="#datahub.metadata.schema_classes.SchemaFieldSpecClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SchemaFieldSpecClass" title="Direct link to datahub.metadata.schema_classes.SchemaFieldSpecClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SchemaFieldSpecClass</span>(<span class="arg-name">path</span>, <span class="arg-name">type</span>, <span class="arg-name">nativeType</span>)<a href="#datahub.metadata.schema_classes.SchemaFieldSpecClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Lightweight spec used for referencing a particular schema field.</p><ul><li><strong>Parameters:</strong><ul><li><strong>path</strong> (<code>str</code>)</li><li><strong>type</strong> (<code>str</code>)</li><li><strong>nativeType</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-nativetype--str"><em>property</em> nativeType <em>: str</em><a href="#property-nativetype--str" class="hash-link" aria-label="Direct link to property-nativetype--str" title="Direct link to property-nativetype--str"></a></h4><p>The native field type</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-path--str"><em>property</em> path <em>: str</em><a href="#property-path--str" class="hash-link" aria-label="Direct link to property-path--str" title="Direct link to property-path--str"></a></h4><p>The field path</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str-6"><em>property</em> type <em>: str</em><a href="#property-type--str-6" class="hash-link" aria-label="Direct link to property-type--str-6" title="Direct link to property-type--str-6"></a></h4><p>The DataHub standard schema field type.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SchemaMetadataClass"><span class="visually-hidden">SchemaMetadataClass</span><a href="#datahub.metadata.schema_classes.SchemaMetadataClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SchemaMetadataClass" title="Direct link to datahub.metadata.schema_classes.SchemaMetadataClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SchemaMetadataClass</span>(<span class="arg-name">schemaName</span>, <span class="arg-name">platform</span>, <span class="arg-name">version</span>, <span class="arg-name">hash</span>, <span class="arg-name">platformSchema</span>, <span class="arg-name">fields</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>, <span class="arg-name">deleted</span> = <span class="arg-default">None</span>, <span class="arg-name">dataset</span> = <span class="arg-default">None</span>, <span class="arg-name">cluster</span> = <span class="arg-default">None</span>, <span class="arg-name">primaryKeys</span> = <span class="arg-default">None</span>, <span class="arg-name">foreignKeysSpecs</span> = <span class="arg-default">None</span>, <span class="arg-name">foreignKeys</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.SchemaMetadataClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>SchemaMetadata to describe metadata related to store schema</p><ul><li><strong>Parameters:</strong><ul><li><strong>schemaName</strong> (<code>str</code>)</li><li><strong>platform</strong> (<code>str</code>)</li><li><strong>version</strong> (<code>int</code>)</li><li><strong>hash</strong> (<code>str</code>)</li><li><strong>platformSchema</strong> (<code>Union</code>[<a href="#datahub.metadata.schema_classes.EspressoSchemaClass"><code>EspressoSchemaClass</code></a>, <a href="#datahub.metadata.schema_classes.OracleDDLClass"><code>OracleDDLClass</code></a>, <a href="#datahub.metadata.schema_classes.MySqlDDLClass"><code>MySqlDDLClass</code></a>, <a href="#datahub.metadata.schema_classes.PrestoDDLClass"><code>PrestoDDLClass</code></a>, <a href="#datahub.metadata.schema_classes.KafkaSchemaClass"><code>KafkaSchemaClass</code></a>, <a href="#datahub.metadata.schema_classes.BinaryJsonSchemaClass"><code>BinaryJsonSchemaClass</code></a>, <a href="#datahub.metadata.schema_classes.OrcSchemaClass"><code>OrcSchemaClass</code></a>, <a href="#datahub.metadata.schema_classes.SchemalessClass"><code>SchemalessClass</code></a>, <a href="#datahub.metadata.schema_classes.KeyValueSchemaClass"><code>KeyValueSchemaClass</code></a>, <a href="#datahub.metadata.schema_classes.OtherSchemaClass"><code>OtherSchemaClass</code></a>]) – </li><li><strong>fields</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.SchemaFieldClass"><code>SchemaFieldClass</code></a>]) – </li><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>deleted</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>dataset</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>cluster</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>primaryKeys</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>foreignKeysSpecs</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.ForeignKeySpecClass"><code>ForeignKeySpecClass</code></a>]]) – </li><li><strong>foreignKeys</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.ForeignKeyConstraintClass"><code>ForeignKeyConstraintClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-cluster--none--str"><em>property</em> cluster <em>: None | str</em><a href="#property-cluster--none--str" class="hash-link" aria-label="Direct link to property-cluster--none--str" title="Direct link to property-cluster--none--str"></a></h4><p>The cluster this schema metadata resides from</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--auditstampclass-18"><em>property</em> created <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--auditstampclass-18" class="hash-link" aria-label="Direct link to property-created--auditstampclass-18" title="Direct link to property-created--auditstampclass-18"></a></h4><p>An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-dataset--none--str"><em>property</em> dataset <em>: None | str</em><a href="#property-dataset--none--str" class="hash-link" aria-label="Direct link to property-dataset--none--str" title="Direct link to property-dataset--none--str"></a></h4><p>Dataset this schema metadata is associated with.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-deleted--none--auditstampclass-10"><em>property</em> deleted <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-deleted--none--auditstampclass-10" class="hash-link" aria-label="Direct link to property-deleted--none--auditstampclass-10" title="Direct link to property-deleted--none--auditstampclass-10"></a></h4><p>An AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fields--listschemafieldclass"><em>property</em> fields <em>: List[<a href="#datahub.metadata.schema_classes.SchemaFieldClass">SchemaFieldClass</a>]</em><a href="#property-fields--listschemafieldclass" class="hash-link" aria-label="Direct link to property-fields--listschemafieldclass" title="Direct link to property-fields--listschemafieldclass"></a></h4><p>Client provided a list of fields from document schema.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-foreignkeys--none--listforeignkeyconstraintclass"><em>property</em> foreignKeys <em>: None | List[<a href="#datahub.metadata.schema_classes.ForeignKeyConstraintClass">ForeignKeyConstraintClass</a>]</em><a href="#property-foreignkeys--none--listforeignkeyconstraintclass" class="hash-link" aria-label="Direct link to property-foreignkeys--none--listforeignkeyconstraintclass" title="Direct link to property-foreignkeys--none--listforeignkeyconstraintclass"></a></h4><p>List of foreign key constraints for the schema</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-foreignkeysspecs--none--dictstr-foreignkeyspecclass"><em>property</em> foreignKeysSpecs <em>: None | Dict[str, <a href="#datahub.metadata.schema_classes.ForeignKeySpecClass">ForeignKeySpecClass</a>]</em><a href="#property-foreignkeysspecs--none--dictstr-foreignkeyspecclass" class="hash-link" aria-label="Direct link to property-foreignkeysspecs--none--dictstr-foreignkeyspecclass" title="Direct link to property-foreignkeysspecs--none--dictstr-foreignkeyspecclass"></a></h4><p>Map captures all the references schema makes to external datasets. Map key is ForeignKeySpecName typeref.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-hash--str"><em>property</em> hash <em>: str</em><a href="#property-hash--str" class="hash-link" aria-label="Direct link to property-hash--str" title="Direct link to property-hash--str"></a></h4><p>the SHA1 hash of the schema content</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--auditstampclass-20"><em>property</em> lastModified <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--auditstampclass-20" class="hash-link" aria-label="Direct link to property-lastmodified--auditstampclass-20" title="Direct link to property-lastmodified--auditstampclass-20"></a></h4><p>An AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-platform--str-7"><em>property</em> platform <em>: str</em><a href="#property-platform--str-7" class="hash-link" aria-label="Direct link to property-platform--str-7" title="Direct link to property-platform--str-7"></a></h4><p>platform:{platform_name})</p><ul><li><strong>Type:</strong>
|
||
Standardized platform urn where schema is defined. The data platform Urn (urn</li><li><strong>Type:</strong>
|
||
li</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-platformschema--espressoschemaclass--oracleddlclass--mysqlddlclass--prestoddlclass--kafkaschemaclass--binaryjsonschemaclass--orcschemaclass--schemalessclass--keyvalueschemaclass--otherschemaclass"><em>property</em> platformSchema <em>: <a href="#datahub.metadata.schema_classes.EspressoSchemaClass">EspressoSchemaClass</a> | <a href="#datahub.metadata.schema_classes.OracleDDLClass">OracleDDLClass</a> | <a href="#datahub.metadata.schema_classes.MySqlDDLClass">MySqlDDLClass</a> | <a href="#datahub.metadata.schema_classes.PrestoDDLClass">PrestoDDLClass</a> | <a href="#datahub.metadata.schema_classes.KafkaSchemaClass">KafkaSchemaClass</a> | <a href="#datahub.metadata.schema_classes.BinaryJsonSchemaClass">BinaryJsonSchemaClass</a> | <a href="#datahub.metadata.schema_classes.OrcSchemaClass">OrcSchemaClass</a> | <a href="#datahub.metadata.schema_classes.SchemalessClass">SchemalessClass</a> | <a href="#datahub.metadata.schema_classes.KeyValueSchemaClass">KeyValueSchemaClass</a> | <a href="#datahub.metadata.schema_classes.OtherSchemaClass">OtherSchemaClass</a></em><a href="#property-platformschema--espressoschemaclass--oracleddlclass--mysqlddlclass--prestoddlclass--kafkaschemaclass--binaryjsonschemaclass--orcschemaclass--schemalessclass--keyvalueschemaclass--otherschemaclass" class="hash-link" aria-label="Direct link to property-platformschema--espressoschemaclass--oracleddlclass--mysqlddlclass--prestoddlclass--kafkaschemaclass--binaryjsonschemaclass--orcschemaclass--schemalessclass--keyvalueschemaclass--otherschemaclass" title="Direct link to property-platformschema--espressoschemaclass--oracleddlclass--mysqlddlclass--prestoddlclass--kafkaschemaclass--binaryjsonschemaclass--orcschemaclass--schemalessclass--keyvalueschemaclass--otherschemaclass"></a></h4><p>The native schema in the dataset’s platform.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-primarykeys--none--liststr"><em>property</em> primaryKeys <em>: None | List<!-- -->[str]</em><a href="#property-primarykeys--none--liststr" class="hash-link" aria-label="Direct link to property-primarykeys--none--liststr" title="Direct link to property-primarykeys--none--liststr"></a></h4><p>Client provided list of fields that define primary keys to access record. Field order defines hierarchical espresso keys. Empty lists indicates absence of primary key access patter. Value is a <a href="mailto:SchemaField@fieldPath" target="_blank" rel="noopener noreferrer">SchemaField@fieldPath</a>.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-schemaname--str"><em>property</em> schemaName <em>: str</em><a href="#property-schemaname--str" class="hash-link" aria-label="Direct link to property-schemaname--str" title="Direct link to property-schemaname--str"></a></h4><p>Schema name e.g. PageViewEvent, identity.Profile, ams.account_management_tracking</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-version--int-1"><em>property</em> version <em>: int</em><a href="#property-version--int-1" class="hash-link" aria-label="Direct link to property-version--int-1" title="Direct link to property-version--int-1"></a></h4><p>Every change to SchemaMetadata in the resource results in a new version. Version is server assigned. This version is differ from platform native schema version.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SchemalessClass"><span class="visually-hidden">SchemalessClass</span><a href="#datahub.metadata.schema_classes.SchemalessClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SchemalessClass" title="Direct link to datahub.metadata.schema_classes.SchemalessClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SchemalessClass</span>()<a href="#datahub.metadata.schema_classes.SchemalessClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>The dataset has no specific schema associated with it</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SearchFieldTypeClass"><span class="visually-hidden">SearchFieldTypeClass</span><a href="#datahub.metadata.schema_classes.SearchFieldTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SearchFieldTypeClass" title="Direct link to datahub.metadata.schema_classes.SearchFieldTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SearchFieldTypeClass</span>()<a href="#datahub.metadata.schema_classes.SearchFieldTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="boolean--boolean">BOOLEAN <em>= 'BOOLEAN'</em><a href="#boolean--boolean" class="hash-link" aria-label="Direct link to boolean--boolean" title="Direct link to boolean--boolean"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="browse_path--browse_path">BROWSE_PATH <em>= 'BROWSE_PATH'</em><a href="#browse_path--browse_path" class="hash-link" aria-label="Direct link to browse_path--browse_path" title="Direct link to browse_path--browse_path"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="browse_path_v2--browse_path_v2">BROWSE_PATH_V2 <em>= 'BROWSE_PATH_V2'</em><a href="#browse_path_v2--browse_path_v2" class="hash-link" aria-label="Direct link to browse_path_v2--browse_path_v2" title="Direct link to browse_path_v2--browse_path_v2"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="count--count-2">COUNT <em>= 'COUNT'</em><a href="#count--count-2" class="hash-link" aria-label="Direct link to count--count-2" title="Direct link to count--count-2"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datetime--datetime">DATETIME <em>= 'DATETIME'</em><a href="#datetime--datetime" class="hash-link" aria-label="Direct link to datetime--datetime" title="Direct link to datetime--datetime"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="keyword--keyword">KEYWORD <em>= 'KEYWORD'</em><a href="#keyword--keyword" class="hash-link" aria-label="Direct link to keyword--keyword" title="Direct link to keyword--keyword"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="object--object">OBJECT <em>= 'OBJECT'</em><a href="#object--object" class="hash-link" aria-label="Direct link to object--object" title="Direct link to object--object"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="text--text-3">TEXT <em>= 'TEXT'</em><a href="#text--text-3" class="hash-link" aria-label="Direct link to text--text-3" title="Direct link to text--text-3"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="text_partial--text_partial">TEXT_PARTIAL <em>= 'TEXT_PARTIAL'</em><a href="#text_partial--text_partial" class="hash-link" aria-label="Direct link to text_partial--text_partial" title="Direct link to text_partial--text_partial"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="urn--urn">URN <em>= 'URN'</em><a href="#urn--urn" class="hash-link" aria-label="Direct link to urn--urn" title="Direct link to urn--urn"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="urn_partial--urn_partial">URN_PARTIAL <em>= 'URN_PARTIAL'</em><a href="#urn_partial--urn_partial" class="hash-link" aria-label="Direct link to urn_partial--urn_partial" title="Direct link to urn_partial--urn_partial"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="word_gram--word_gram">WORD_GRAM <em>= 'WORD_GRAM'</em><a href="#word_gram--word_gram" class="hash-link" aria-label="Direct link to word_gram--word_gram" title="Direct link to word_gram--word_gram"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SerializedValueClass"><span class="visually-hidden">SerializedValueClass</span><a href="#datahub.metadata.schema_classes.SerializedValueClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SerializedValueClass" title="Direct link to datahub.metadata.schema_classes.SerializedValueClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SerializedValueClass</span>(<span class="arg-name">blob</span>, <span class="arg-name">contentType</span> = <span class="arg-default">None</span>, <span class="arg-name">schemaType</span> = <span class="arg-default">None</span>, <span class="arg-name">schemaRef</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.SerializedValueClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Captures the serialized value of a (usually) schema-d blob.</p><ul><li><strong>Parameters:</strong><ul><li><strong>blob</strong> (<code>bytes</code>)</li><li><strong>contentType</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.SerializedValueContentTypeClass"><code>SerializedValueContentTypeClass</code></a>, <code>None</code>]) – </li><li><strong>schemaType</strong> (<code>Union</code>[<code>None</code>, <code>str</code>, <a href="#datahub.metadata.schema_classes.SerializedValueSchemaTypeClass"><code>SerializedValueSchemaTypeClass</code></a>]) – </li><li><strong>schemaRef</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-blob--bytes"><em>property</em> blob <em>: bytes</em><a href="#property-blob--bytes" class="hash-link" aria-label="Direct link to property-blob--bytes" title="Direct link to property-blob--bytes"></a></h4><p>The serialized blob value.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-contenttype--str--serializedvaluecontenttypeclass"><em>property</em> contentType <em>: str | <a href="#datahub.metadata.schema_classes.SerializedValueContentTypeClass">SerializedValueContentTypeClass</a></em><a href="#property-contenttype--str--serializedvaluecontenttypeclass" class="hash-link" aria-label="Direct link to property-contenttype--str--serializedvaluecontenttypeclass" title="Direct link to property-contenttype--str--serializedvaluecontenttypeclass"></a></h4><p>The content-type of the serialized blob value.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-schemaref--none--str"><em>property</em> schemaRef <em>: None | str</em><a href="#property-schemaref--none--str" class="hash-link" aria-label="Direct link to property-schemaref--none--str" title="Direct link to property-schemaref--none--str"></a></h4><p>An optional reference to the schema that models the object.
|
||
e.g., ‘com.linkedin.pegasus2avro.platformresource.slack.SlackConversation’</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-schematype--none--str--serializedvalueschematypeclass"><em>property</em> schemaType <em>: None | str | <a href="#datahub.metadata.schema_classes.SerializedValueSchemaTypeClass">SerializedValueSchemaTypeClass</a></em><a href="#property-schematype--none--str--serializedvalueschematypeclass" class="hash-link" aria-label="Direct link to property-schematype--none--str--serializedvalueschematypeclass" title="Direct link to property-schematype--none--str--serializedvalueschematypeclass"></a></h4><p>The schema type for the schema that models the object that was serialized
|
||
: into the blob.</p><p>Absence of this field indicates that the schema is not known.
|
||
If the schema is known, the value should be set to the appropriate schema
|
||
type.
|
||
Use the NONE value if the existing schema categories do not apply.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SerializedValueContentTypeClass"><span class="visually-hidden">SerializedValueContentTypeClass</span><a href="#datahub.metadata.schema_classes.SerializedValueContentTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SerializedValueContentTypeClass" title="Direct link to datahub.metadata.schema_classes.SerializedValueContentTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SerializedValueContentTypeClass</span>()<a href="#datahub.metadata.schema_classes.SerializedValueContentTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="binary--binary-1">BINARY <em>= 'BINARY'</em><a href="#binary--binary-1" class="hash-link" aria-label="Direct link to binary--binary-1" title="Direct link to binary--binary-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="json--json-1">JSON <em>= 'JSON'</em><a href="#json--json-1" class="hash-link" aria-label="Direct link to json--json-1" title="Direct link to json--json-1"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SerializedValueSchemaTypeClass"><span class="visually-hidden">SerializedValueSchemaTypeClass</span><a href="#datahub.metadata.schema_classes.SerializedValueSchemaTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SerializedValueSchemaTypeClass" title="Direct link to datahub.metadata.schema_classes.SerializedValueSchemaTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SerializedValueSchemaTypeClass</span>()<a href="#datahub.metadata.schema_classes.SerializedValueSchemaTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="avro--avro">AVRO <em>= 'AVRO'</em><a href="#avro--avro" class="hash-link" aria-label="Direct link to avro--avro" title="Direct link to avro--avro"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="json--json-2">JSON <em>= 'JSON'</em><a href="#json--json-2" class="hash-link" aria-label="Direct link to json--json-2" title="Direct link to json--json-2"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="none--none-2">NONE <em>= 'NONE'</em><a href="#none--none-2" class="hash-link" aria-label="Direct link to none--none-2" title="Direct link to none--none-2"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="pegasus--pegasus">PEGASUS <em>= 'PEGASUS'</em><a href="#pegasus--pegasus" class="hash-link" aria-label="Direct link to pegasus--pegasus" title="Direct link to pegasus--pegasus"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="protobuf--protobuf">PROTOBUF <em>= 'PROTOBUF'</em><a href="#protobuf--protobuf" class="hash-link" aria-label="Direct link to protobuf--protobuf" title="Direct link to protobuf--protobuf"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="thrift--thrift">THRIFT <em>= 'THRIFT'</em><a href="#thrift--thrift" class="hash-link" aria-label="Direct link to thrift--thrift" title="Direct link to thrift--thrift"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SiblingsClass"><span class="visually-hidden">SiblingsClass</span><a href="#datahub.metadata.schema_classes.SiblingsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SiblingsClass" title="Direct link to datahub.metadata.schema_classes.SiblingsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SiblingsClass</span>(<span class="arg-name">siblings</span>, <span class="arg-name">primary</span>)<a href="#datahub.metadata.schema_classes.SiblingsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Siblings information of an entity.</p><ul><li><strong>Parameters:</strong><ul><li><strong>siblings</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li><li><strong>primary</strong> (<code>bool</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-primary--bool"><em>property</em> primary <em>: bool</em><a href="#property-primary--bool" class="hash-link" aria-label="Direct link to property-primary--bool" title="Direct link to property-primary--bool"></a></h4><p>If this is the leader entity of the set of siblings</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-siblings--liststr"><em>property</em> siblings <em>: List<!-- -->[str]</em><a href="#property-siblings--liststr" class="hash-link" aria-label="Direct link to property-siblings--liststr" title="Direct link to property-siblings--liststr"></a></h4><p>List of sibling entities</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SlackNotificationSettingsClass"><span class="visually-hidden">SlackNotificationSettingsClass</span><a href="#datahub.metadata.schema_classes.SlackNotificationSettingsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SlackNotificationSettingsClass" title="Direct link to datahub.metadata.schema_classes.SlackNotificationSettingsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SlackNotificationSettingsClass</span>(<span class="arg-name">userHandle</span> = <span class="arg-default">None</span>, <span class="arg-name">channels</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.SlackNotificationSettingsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Slack Notification settings for an actor.</p><ul><li><strong>Parameters:</strong><ul><li><strong>userHandle</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>channels</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-channels--none--liststr"><em>property</em> channels <em>: None | List<!-- -->[str]</em><a href="#property-channels--none--liststr" class="hash-link" aria-label="Direct link to property-channels--none--liststr" title="Direct link to property-channels--none--liststr"></a></h4><p>Optional list of channels to send notifications to</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-userhandle--none--str"><em>property</em> userHandle <em>: None | str</em><a href="#property-userhandle--none--str" class="hash-link" aria-label="Direct link to property-userhandle--none--str" title="Direct link to property-userhandle--none--str"></a></h4><p>Optional user handle</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SlackUserInfoClass"><span class="visually-hidden">SlackUserInfoClass</span><a href="#datahub.metadata.schema_classes.SlackUserInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SlackUserInfoClass" title="Direct link to datahub.metadata.schema_classes.SlackUserInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SlackUserInfoClass</span>(<span class="arg-name">slackInstance</span>, <span class="arg-name">id</span>, <span class="arg-name">name</span>, <span class="arg-name">realName</span>, <span class="arg-name">displayName</span>, <span class="arg-name">teamId</span>, <span class="arg-name">isDeleted</span>, <span class="arg-name">isAdmin</span>, <span class="arg-name">isOwner</span>, <span class="arg-name">isPrimaryOwner</span>, <span class="arg-name">isBot</span>, <span class="arg-name">email</span> = <span class="arg-default">None</span>, <span class="arg-name">timezone</span> = <span class="arg-default">None</span>, <span class="arg-name">timezoneOffset</span> = <span class="arg-default">None</span>, <span class="arg-name">title</span> = <span class="arg-default">None</span>, <span class="arg-name">phone</span> = <span class="arg-default">None</span>, <span class="arg-name">profilePictureUrl</span> = <span class="arg-default">None</span>, <span class="arg-name">statusText</span> = <span class="arg-default">None</span>, <span class="arg-name">statusEmoji</span> = <span class="arg-default">None</span>, <span class="arg-name">lastUpdatedSeconds</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.SlackUserInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a Slack user.</p><ul><li><strong>Parameters:</strong><ul><li><strong>slackInstance</strong> (<code>str</code>)</li><li><strong>id</strong> (<code>str</code>)</li><li><strong>name</strong> (<code>str</code>)</li><li><strong>realName</strong> (<code>str</code>)</li><li><strong>displayName</strong> (<code>str</code>)</li><li><strong>teamId</strong> (<code>str</code>)</li><li><strong>isDeleted</strong> (<code>bool</code>)</li><li><strong>isAdmin</strong> (<code>bool</code>)</li><li><strong>isOwner</strong> (<code>bool</code>)</li><li><strong>isPrimaryOwner</strong> (<code>bool</code>)</li><li><strong>isBot</strong> (<code>bool</code>)</li><li><strong>email</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>timezone</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>timezoneOffset</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>title</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>phone</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>profilePictureUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>statusText</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>statusEmoji</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>lastUpdatedSeconds</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-displayname--str-1"><em>property</em> displayName <em>: str</em><a href="#property-displayname--str-1" class="hash-link" aria-label="Direct link to property-displayname--str-1" title="Direct link to property-displayname--str-1"></a></h4><p>The display name of the Slack member.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-email--none--str-4"><em>property</em> email <em>: None | str</em><a href="#property-email--none--str-4" class="hash-link" aria-label="Direct link to property-email--none--str-4" title="Direct link to property-email--none--str-4"></a></h4><p>The email associated with the Slack member.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-36"><em>property</em> id <em>: str</em><a href="#property-id--str-36" class="hash-link" aria-label="Direct link to property-id--str-36" title="Direct link to property-id--str-36"></a></h4><p>The unique identifier for the Slack member.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-isadmin--bool"><em>property</em> isAdmin <em>: bool</em><a href="#property-isadmin--bool" class="hash-link" aria-label="Direct link to property-isadmin--bool" title="Direct link to property-isadmin--bool"></a></h4><p>Whether the member is an admin.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-isbot--bool"><em>property</em> isBot <em>: bool</em><a href="#property-isbot--bool" class="hash-link" aria-label="Direct link to property-isbot--bool" title="Direct link to property-isbot--bool"></a></h4><p>Whether the member is a bot.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-isdeleted--bool"><em>property</em> isDeleted <em>: bool</em><a href="#property-isdeleted--bool" class="hash-link" aria-label="Direct link to property-isdeleted--bool" title="Direct link to property-isdeleted--bool"></a></h4><p>Whether the member is deleted or not.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-isowner--bool"><em>property</em> isOwner <em>: bool</em><a href="#property-isowner--bool" class="hash-link" aria-label="Direct link to property-isowner--bool" title="Direct link to property-isowner--bool"></a></h4><p>Whether the member is an owner.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-isprimaryowner--bool"><em>property</em> isPrimaryOwner <em>: bool</em><a href="#property-isprimaryowner--bool" class="hash-link" aria-label="Direct link to property-isprimaryowner--bool" title="Direct link to property-isprimaryowner--bool"></a></h4><p>Whether the member is a primary owner.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastupdatedseconds--none--int"><em>property</em> lastUpdatedSeconds <em>: None | int</em><a href="#property-lastupdatedseconds--none--int" class="hash-link" aria-label="Direct link to property-lastupdatedseconds--none--int" title="Direct link to property-lastupdatedseconds--none--int"></a></h4><p>The timestamp of when the member was last updated. (in seconds)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-33"><em>property</em> name <em>: str</em><a href="#property-name--str-33" class="hash-link" aria-label="Direct link to property-name--str-33" title="Direct link to property-name--str-33"></a></h4><p>The username of the Slack member.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-phone--none--str-1"><em>property</em> phone <em>: None | str</em><a href="#property-phone--none--str-1" class="hash-link" aria-label="Direct link to property-phone--none--str-1" title="Direct link to property-phone--none--str-1"></a></h4><p>The phone number of the Slack member.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-profilepictureurl--none--str"><em>property</em> profilePictureUrl <em>: None | str</em><a href="#property-profilepictureurl--none--str" class="hash-link" aria-label="Direct link to property-profilepictureurl--none--str" title="Direct link to property-profilepictureurl--none--str"></a></h4><p>The URL of the member’s profile picture.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-realname--str"><em>property</em> realName <em>: str</em><a href="#property-realname--str" class="hash-link" aria-label="Direct link to property-realname--str" title="Direct link to property-realname--str"></a></h4><p>The real name of the Slack member.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-slackinstance--str"><em>property</em> slackInstance <em>: str</em><a href="#property-slackinstance--str" class="hash-link" aria-label="Direct link to property-slackinstance--str" title="Direct link to property-slackinstance--str"></a></h4><p>The dataplatform instance that this Slack member belongs to.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-statusemoji--none--str"><em>property</em> statusEmoji <em>: None | str</em><a href="#property-statusemoji--none--str" class="hash-link" aria-label="Direct link to property-statusemoji--none--str" title="Direct link to property-statusemoji--none--str"></a></h4><p>The status emoji of the Slack member.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-statustext--none--str"><em>property</em> statusText <em>: None | str</em><a href="#property-statustext--none--str" class="hash-link" aria-label="Direct link to property-statustext--none--str" title="Direct link to property-statustext--none--str"></a></h4><p>The status text of the Slack member.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-teamid--str"><em>property</em> teamId <em>: str</em><a href="#property-teamid--str" class="hash-link" aria-label="Direct link to property-teamid--str" title="Direct link to property-teamid--str"></a></h4><p>The ID associated with the Slack team.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-timezone--none--str"><em>property</em> timezone <em>: None | str</em><a href="#property-timezone--none--str" class="hash-link" aria-label="Direct link to property-timezone--none--str" title="Direct link to property-timezone--none--str"></a></h4><p>The timezone of the Slack member.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-timezoneoffset--none--int"><em>property</em> timezoneOffset <em>: None | int</em><a href="#property-timezoneoffset--none--int" class="hash-link" aria-label="Direct link to property-timezoneoffset--none--int" title="Direct link to property-timezoneoffset--none--int"></a></h4><p>The timezone offset of the Slack member.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-title--none--str-3"><em>property</em> title <em>: None | str</em><a href="#property-title--none--str-3" class="hash-link" aria-label="Direct link to property-title--none--str-3" title="Direct link to property-title--none--str-3"></a></h4><p>The title of the Slack member.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SourceCodeClass"><span class="visually-hidden">SourceCodeClass</span><a href="#datahub.metadata.schema_classes.SourceCodeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SourceCodeClass" title="Direct link to datahub.metadata.schema_classes.SourceCodeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SourceCodeClass</span>(<span class="arg-name">sourceCode</span>)<a href="#datahub.metadata.schema_classes.SourceCodeClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Source Code</p><ul><li><strong>Parameters:</strong><strong>sourceCode</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.SourceCodeUrlClass"><code>SourceCodeUrlClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-sourcecode--listsourcecodeurlclass"><em>property</em> sourceCode <em>: List[<a href="#datahub.metadata.schema_classes.SourceCodeUrlClass">SourceCodeUrlClass</a>]</em><a href="#property-sourcecode--listsourcecodeurlclass" class="hash-link" aria-label="Direct link to property-sourcecode--listsourcecodeurlclass" title="Direct link to property-sourcecode--listsourcecodeurlclass"></a></h4><p>Source Code along with types</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SourceCodeUrlClass"><span class="visually-hidden">SourceCodeUrlClass</span><a href="#datahub.metadata.schema_classes.SourceCodeUrlClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SourceCodeUrlClass" title="Direct link to datahub.metadata.schema_classes.SourceCodeUrlClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SourceCodeUrlClass</span>(<span class="arg-name">type</span>, <span class="arg-name">sourceCodeUrl</span>)<a href="#datahub.metadata.schema_classes.SourceCodeUrlClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Source Code Url Entity</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.SourceCodeUrlTypeClass"><code>SourceCodeUrlTypeClass</code></a>]) – </li><li><strong>sourceCodeUrl</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-sourcecodeurl--str"><em>property</em> sourceCodeUrl <em>: str</em><a href="#property-sourcecodeurl--str" class="hash-link" aria-label="Direct link to property-sourcecodeurl--str" title="Direct link to property-sourcecodeurl--str"></a></h4><p>Source Code Url</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--sourcecodeurltypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.SourceCodeUrlTypeClass">SourceCodeUrlTypeClass</a></em><a href="#property-type--str--sourcecodeurltypeclass" class="hash-link" aria-label="Direct link to property-type--str--sourcecodeurltypeclass" title="Direct link to property-type--str--sourcecodeurltypeclass"></a></h4><p>Source Code Url Types</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SourceCodeUrlTypeClass"><span class="visually-hidden">SourceCodeUrlTypeClass</span><a href="#datahub.metadata.schema_classes.SourceCodeUrlTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SourceCodeUrlTypeClass" title="Direct link to datahub.metadata.schema_classes.SourceCodeUrlTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SourceCodeUrlTypeClass</span>()<a href="#datahub.metadata.schema_classes.SourceCodeUrlTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="evaluation_pipeline_source_code--evaluation_pipeline_source_code">EVALUATION_PIPELINE_SOURCE_CODE <em>= 'EVALUATION_PIPELINE_SOURCE_CODE'</em><a href="#evaluation_pipeline_source_code--evaluation_pipeline_source_code" class="hash-link" aria-label="Direct link to evaluation_pipeline_source_code--evaluation_pipeline_source_code" title="Direct link to evaluation_pipeline_source_code--evaluation_pipeline_source_code"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="ml_model_source_code--ml_model_source_code">ML_MODEL_SOURCE_CODE <em>= 'ML_MODEL_SOURCE_CODE'</em><a href="#ml_model_source_code--ml_model_source_code" class="hash-link" aria-label="Direct link to ml_model_source_code--ml_model_source_code" title="Direct link to ml_model_source_code--ml_model_source_code"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="training_pipeline_source_code--training_pipeline_source_code">TRAINING_PIPELINE_SOURCE_CODE <em>= 'TRAINING_PIPELINE_SOURCE_CODE'</em><a href="#training_pipeline_source_code--training_pipeline_source_code" class="hash-link" aria-label="Direct link to training_pipeline_source_code--training_pipeline_source_code" title="Direct link to training_pipeline_source_code--training_pipeline_source_code"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SqlAssertionInfoClass"><span class="visually-hidden">SqlAssertionInfoClass</span><a href="#datahub.metadata.schema_classes.SqlAssertionInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SqlAssertionInfoClass" title="Direct link to datahub.metadata.schema_classes.SqlAssertionInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SqlAssertionInfoClass</span>(<span class="arg-name">type</span>, <span class="arg-name">entity</span>, <span class="arg-name">statement</span>, <span class="arg-name">operator</span>, <span class="arg-name">parameters</span>, <span class="arg-name">changeType</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.SqlAssertionInfoClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Attributes defining a SQL Assertion</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.SqlAssertionTypeClass"><code>SqlAssertionTypeClass</code></a>]) – </li><li><strong>entity</strong> (<code>str</code>)</li><li><strong>statement</strong> (<code>str</code>)</li><li><strong>operator</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.AssertionStdOperatorClass"><code>AssertionStdOperatorClass</code></a>]) – </li><li><strong>parameters</strong> (<a href="#datahub.metadata.schema_classes.AssertionStdParametersClass"><code>AssertionStdParametersClass</code></a>) – </li><li><strong>changeType</strong> (<code>Union</code>[<code>None</code>, <code>str</code>, <a href="#datahub.metadata.schema_classes.AssertionValueChangeTypeClass"><code>AssertionValueChangeTypeClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-changetype--none--str--assertionvaluechangetypeclass"><em>property</em> changeType <em>: None | str | <a href="#datahub.metadata.schema_classes.AssertionValueChangeTypeClass">AssertionValueChangeTypeClass</a></em><a href="#property-changetype--none--str--assertionvaluechangetypeclass" class="hash-link" aria-label="Direct link to property-changetype--none--str--assertionvaluechangetypeclass" title="Direct link to property-changetype--none--str--assertionvaluechangetypeclass"></a></h4><p>a fixed absolute value or a relative percentage.
|
||
This value is required if the type is METRIC_CHANGE.</p><ul><li><strong>Type:</strong>
|
||
The type of the value used to evaluate the assertion</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-entity--str-6"><em>property</em> entity <em>: str</em><a href="#property-entity--str-6" class="hash-link" aria-label="Direct link to property-entity--str-6" title="Direct link to property-entity--str-6"></a></h4><p>The entity targeted by this SQL check.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-operator--str--assertionstdoperatorclass-7"><em>property</em> operator <em>: str | <a href="#datahub.metadata.schema_classes.AssertionStdOperatorClass">AssertionStdOperatorClass</a></em><a href="#property-operator--str--assertionstdoperatorclass-7" class="hash-link" aria-label="Direct link to property-operator--str--assertionstdoperatorclass-7" title="Direct link to property-operator--str--assertionstdoperatorclass-7"></a></h4><p>The operator you’d like to apply to the result of the SQL query.</p><p>Note that at this time, only numeric operators are valid inputs:
|
||
GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO,
|
||
BETWEEN.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-parameters--assertionstdparametersclass-4"><em>property</em> parameters <em>: <a href="#datahub.metadata.schema_classes.AssertionStdParametersClass">AssertionStdParametersClass</a></em><a href="#property-parameters--assertionstdparametersclass-4" class="hash-link" aria-label="Direct link to property-parameters--assertionstdparametersclass-4" title="Direct link to property-parameters--assertionstdparametersclass-4"></a></h4><p>The parameters you’d like to provide as input to the operator.</p><p>Note that only numeric parameter types are valid inputs: NUMBER.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-statement--str"><em>property</em> statement <em>: str</em><a href="#property-statement--str" class="hash-link" aria-label="Direct link to property-statement--str" title="Direct link to property-statement--str"></a></h4><p>The SQL statement to be executed when evaluating the assertion (or computing the metric).
|
||
This should be a valid and complete statement, executable by itself.</p><p>Usually this should be a SELECT query statement.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--sqlassertiontypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.SqlAssertionTypeClass">SqlAssertionTypeClass</a></em><a href="#property-type--str--sqlassertiontypeclass" class="hash-link" aria-label="Direct link to property-type--str--sqlassertiontypeclass" title="Direct link to property-type--str--sqlassertiontypeclass"></a></h4><p>The type of the SQL assertion being monitored.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SqlAssertionTypeClass"><span class="visually-hidden">SqlAssertionTypeClass</span><a href="#datahub.metadata.schema_classes.SqlAssertionTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SqlAssertionTypeClass" title="Direct link to datahub.metadata.schema_classes.SqlAssertionTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SqlAssertionTypeClass</span>()<a href="#datahub.metadata.schema_classes.SqlAssertionTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="metric--metric">METRIC <em>= 'METRIC'</em><a href="#metric--metric" class="hash-link" aria-label="Direct link to metric--metric" title="Direct link to metric--metric"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="metric_change--metric_change">METRIC_CHANGE <em>= 'METRIC_CHANGE'</em><a href="#metric_change--metric_change" class="hash-link" aria-label="Direct link to metric_change--metric_change" title="Direct link to metric_change--metric_change"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SsoSettingsClass"><span class="visually-hidden">SsoSettingsClass</span><a href="#datahub.metadata.schema_classes.SsoSettingsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SsoSettingsClass" title="Direct link to datahub.metadata.schema_classes.SsoSettingsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SsoSettingsClass</span>(<span class="arg-name">baseUrl</span>, <span class="arg-name">oidcSettings</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.SsoSettingsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>SSO Integrations, supported on the UI.</p><ul><li><strong>Parameters:</strong><ul><li><strong>baseUrl</strong> (<code>str</code>)</li><li><strong>oidcSettings</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.OidcSettingsClass"><code>OidcSettingsClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-baseurl--str"><em>property</em> baseUrl <em>: str</em><a href="#property-baseurl--str" class="hash-link" aria-label="Direct link to property-baseurl--str" title="Direct link to property-baseurl--str"></a></h4><p>Auth base URL.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-oidcsettings--none--oidcsettingsclass"><em>property</em> oidcSettings <em>: None | <a href="#datahub.metadata.schema_classes.OidcSettingsClass">OidcSettingsClass</a></em><a href="#property-oidcsettings--none--oidcsettingsclass" class="hash-link" aria-label="Direct link to property-oidcsettings--none--oidcsettingsclass" title="Direct link to property-oidcsettings--none--oidcsettingsclass"></a></h4><p>Optional OIDC SSO settings.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.StatusClass"><span class="visually-hidden">StatusClass</span><a href="#datahub.metadata.schema_classes.StatusClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.StatusClass" title="Direct link to datahub.metadata.schema_classes.StatusClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">StatusClass</span>(<span class="arg-name">removed</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.StatusClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>The lifecycle status metadata of an entity, e.g. dataset, metric, feature, etc.
|
||
This aspect is used to represent soft deletes conventionally.</p><ul><li><strong>Parameters:</strong><strong>removed</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-removed--bool"><em>property</em> removed <em>: bool</em><a href="#property-removed--bool" class="hash-link" aria-label="Direct link to property-removed--bool" title="Direct link to property-removed--bool"></a></h4><p>Whether the entity has been removed (soft-deleted).</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.StringTypeClass"><span class="visually-hidden">StringTypeClass</span><a href="#datahub.metadata.schema_classes.StringTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.StringTypeClass" title="Direct link to datahub.metadata.schema_classes.StringTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">StringTypeClass</span>()<a href="#datahub.metadata.schema_classes.StringTypeClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>String field type.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.StructuredExecutionReportClass"><span class="visually-hidden">StructuredExecutionReportClass</span><a href="#datahub.metadata.schema_classes.StructuredExecutionReportClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.StructuredExecutionReportClass" title="Direct link to datahub.metadata.schema_classes.StructuredExecutionReportClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">StructuredExecutionReportClass</span>(<span class="arg-name">type</span>, <span class="arg-name">serializedValue</span>, <span class="arg-name">contentType</span>)<a href="#datahub.metadata.schema_classes.StructuredExecutionReportClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A flexible carrier for structured results of an execution request.
|
||
The goal is to allow for free flow of structured responses from execution tasks to the orchestrator or observer.
|
||
The full spectrum of different execution report types is not intended to be modeled by this object.</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>str</code>)</li><li><strong>serializedValue</strong> (<code>str</code>)</li><li><strong>contentType</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-contenttype--str-2"><em>property</em> contentType <em>: str</em><a href="#property-contenttype--str-2" class="hash-link" aria-label="Direct link to property-contenttype--str-2" title="Direct link to property-contenttype--str-2"></a></h4><p>The content-type of the serialized value (e.g. application/json, application/json;gzip etc.)</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-serializedvalue--str"><em>property</em> serializedValue <em>: str</em><a href="#property-serializedvalue--str" class="hash-link" aria-label="Direct link to property-serializedvalue--str" title="Direct link to property-serializedvalue--str"></a></h4><p>The serialized value of the structured report</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str-7"><em>property</em> type <em>: str</em><a href="#property-type--str-7" class="hash-link" aria-label="Direct link to property-type--str-7" title="Direct link to property-type--str-7"></a></h4><p>The type of the structured report. (e.g. INGESTION_REPORT, TEST_CONNECTION_REPORT, etc.)</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.StructuredPropertiesClass"><span class="visually-hidden">StructuredPropertiesClass</span><a href="#datahub.metadata.schema_classes.StructuredPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.StructuredPropertiesClass" title="Direct link to datahub.metadata.schema_classes.StructuredPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">StructuredPropertiesClass</span>(<span class="arg-name">properties</span>)<a href="#datahub.metadata.schema_classes.StructuredPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties about an entity governed by StructuredPropertyDefinition</p><ul><li><strong>Parameters:</strong><strong>properties</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.StructuredPropertyValueAssignmentClass"><code>StructuredPropertyValueAssignmentClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-properties--liststructuredpropertyvalueassignmentclass"><em>property</em> properties <em>: List[<a href="#datahub.metadata.schema_classes.StructuredPropertyValueAssignmentClass">StructuredPropertyValueAssignmentClass</a>]</em><a href="#property-properties--liststructuredpropertyvalueassignmentclass" class="hash-link" aria-label="Direct link to property-properties--liststructuredpropertyvalueassignmentclass" title="Direct link to property-properties--liststructuredpropertyvalueassignmentclass"></a></h4><p>Custom property bag.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.StructuredPropertyDefinitionClass"><span class="visually-hidden">StructuredPropertyDefinitionClass</span><a href="#datahub.metadata.schema_classes.StructuredPropertyDefinitionClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.StructuredPropertyDefinitionClass" title="Direct link to datahub.metadata.schema_classes.StructuredPropertyDefinitionClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">StructuredPropertyDefinitionClass</span>(<span class="arg-name">qualifiedName</span>, <span class="arg-name">valueType</span>, <span class="arg-name">entityTypes</span>, <span class="arg-name">displayName</span> = <span class="arg-default">None</span>, <span class="arg-name">typeQualifier</span> = <span class="arg-default">None</span>, <span class="arg-name">allowedValues</span> = <span class="arg-default">None</span>, <span class="arg-name">cardinality</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">searchConfiguration</span> = <span class="arg-default">None</span>, <span class="arg-name">immutable</span> = <span class="arg-default">None</span>, <span class="arg-name">version</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.StructuredPropertyDefinitionClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>qualifiedName</strong> (<code>str</code>)</li><li><strong>valueType</strong> (<code>str</code>)</li><li><strong>entityTypes</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li><li><strong>displayName</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>typeQualifier</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>List</code>[<code>str</code>]<!-- -->]])</li><li><strong>allowedValues</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.PropertyValueClass"><code>PropertyValueClass</code></a>]]) – </li><li><strong>cardinality</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.PropertyCardinalityClass"><code>PropertyCardinalityClass</code></a>, <code>None</code>]) – </li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>searchConfiguration</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.DataHubSearchConfigClass"><code>DataHubSearchConfigClass</code></a>]) – </li><li><strong>immutable</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>version</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-allowedvalues--none--listpropertyvalueclass"><em>property</em> allowedValues <em>: None | List[<a href="#datahub.metadata.schema_classes.PropertyValueClass">PropertyValueClass</a>]</em><a href="#property-allowedvalues--none--listpropertyvalueclass" class="hash-link" aria-label="Direct link to property-allowedvalues--none--listpropertyvalueclass" title="Direct link to property-allowedvalues--none--listpropertyvalueclass"></a></h4><p>A list of allowed values that the property is allowed to take.
|
||
If this is not specified, then the property can take any value of given type.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-cardinality--str--propertycardinalityclass--none"><em>property</em> cardinality <em>: str | <a href="#datahub.metadata.schema_classes.PropertyCardinalityClass">PropertyCardinalityClass</a> | None</em><a href="#property-cardinality--str--propertycardinalityclass--none" class="hash-link" aria-label="Direct link to property-cardinality--str--propertycardinalityclass--none" title="Direct link to property-cardinality--str--propertycardinalityclass--none"></a></h4><p>The cardinality of the property. If not specified, then the property is assumed to be single valued..</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--none--auditstampclass-10"><em>property</em> created <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--none--auditstampclass-10" class="hash-link" aria-label="Direct link to property-created--none--auditstampclass-10" title="Direct link to property-created--none--auditstampclass-10"></a></h4><p>Created Audit stamp</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-49"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-49" class="hash-link" aria-label="Direct link to property-description--none--str-49" title="Direct link to property-description--none--str-49"></a></h4><p>The description of the property. This is the description that will be shown in the UI.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-displayname--none--str-6"><em>property</em> displayName <em>: None | str</em><a href="#property-displayname--none--str-6" class="hash-link" aria-label="Direct link to property-displayname--none--str-6" title="Direct link to property-displayname--none--str-6"></a></h4><p>The display name of the property. This is the name that will be shown in the UI and can be used to look up the property id.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-entitytypes--liststr-1"><em>property</em> entityTypes <em>: List<!-- -->[str]</em><a href="#property-entitytypes--liststr-1" class="hash-link" aria-label="Direct link to property-entitytypes--liststr-1" title="Direct link to property-entitytypes--liststr-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-immutable--bool"><em>property</em> immutable <em>: bool</em><a href="#property-immutable--bool" class="hash-link" aria-label="Direct link to property-immutable--bool" title="Direct link to property-immutable--bool"></a></h4><p>Whether the structured property value is immutable once applied to an entity.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--none--auditstampclass-5"><em>property</em> lastModified <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--none--auditstampclass-5" class="hash-link" aria-label="Direct link to property-lastmodified--none--auditstampclass-5" title="Direct link to property-lastmodified--none--auditstampclass-5"></a></h4><p>Last Modified Audit stamp</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-qualifiedname--str-2"><em>property</em> qualifiedName <em>: str</em><a href="#property-qualifiedname--str-2" class="hash-link" aria-label="Direct link to property-qualifiedname--str-2" title="Direct link to property-qualifiedname--str-2"></a></h4><p>The fully qualified name of the property. e.g. io.acryl.datahub.myProperty</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-searchconfiguration--none--datahubsearchconfigclass"><em>property</em> searchConfiguration <em>: None | <a href="#datahub.metadata.schema_classes.DataHubSearchConfigClass">DataHubSearchConfigClass</a></em><a href="#property-searchconfiguration--none--datahubsearchconfigclass" class="hash-link" aria-label="Direct link to property-searchconfiguration--none--datahubsearchconfigclass" title="Direct link to property-searchconfiguration--none--datahubsearchconfigclass"></a></h4><p>Search configuration for this property. If not specified, then the property is indexed using the default mapping.
|
||
from the logical type.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-typequalifier--none--dictstr-liststr"><em>property</em> typeQualifier <em>: None | Dict[str, List<!-- -->[str]<!-- -->]</em><a href="#property-typequalifier--none--dictstr-liststr" class="hash-link" aria-label="Direct link to property-typequalifier--none--dictstr-liststr" title="Direct link to property-typequalifier--none--dictstr-liststr"></a></h4><p>A map that allows for type specialization of the valueType.
|
||
e.g. a valueType of <a href="urn:li:dataType:datahub.urn" target="_blank" rel="noopener noreferrer">urn:li:dataType:datahub.urn</a>
|
||
can be specialized to be a USER or GROUP URN by adding a typeQualifier like
|
||
{ “allowedTypes”: [”<a href="urn:li:entityType:datahub.corpuser" target="_blank" rel="noopener noreferrer">urn:li:entityType:datahub.corpuser</a>”, “<a href="urn:li:entityType:datahub.corpGroup" target="_blank" rel="noopener noreferrer">urn:li:entityType:datahub.corpGroup</a>”] }</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-valuetype--str"><em>property</em> valueType <em>: str</em><a href="#property-valuetype--str" class="hash-link" aria-label="Direct link to property-valuetype--str" title="Direct link to property-valuetype--str"></a></h4><p>The value type of the property. Must be a dataType.
|
||
e.g. To indicate that the property is of type DATE, use <a href="urn:li:dataType:datahub.date" target="_blank" rel="noopener noreferrer">urn:li:dataType:datahub.date</a></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-version--none--str-1"><em>property</em> version <em>: None | str</em><a href="#property-version--none--str-1" class="hash-link" aria-label="Direct link to property-version--none--str-1" title="Direct link to property-version--none--str-1"></a></h4><p>Definition version - Allows breaking schema changes. String is compared case-insensitive and new
|
||
versions must be monotonically increasing. Cannot use periods/dots.
|
||
Suggestions: v1, v2</p><blockquote><p>20240610, 20240611</p></blockquote></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.StructuredPropertyKeyClass"><span class="visually-hidden">StructuredPropertyKeyClass</span><a href="#datahub.metadata.schema_classes.StructuredPropertyKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.StructuredPropertyKeyClass" title="Direct link to datahub.metadata.schema_classes.StructuredPropertyKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">StructuredPropertyKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.StructuredPropertyKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-37"><em>property</em> id <em>: str</em><a href="#property-id--str-37" class="hash-link" aria-label="Direct link to property-id--str-37" title="Direct link to property-id--str-37"></a></h4><p>The id for a structured proeprty.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.StructuredPropertyParamsClass"><span class="visually-hidden">StructuredPropertyParamsClass</span><a href="#datahub.metadata.schema_classes.StructuredPropertyParamsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.StructuredPropertyParamsClass" title="Direct link to datahub.metadata.schema_classes.StructuredPropertyParamsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">StructuredPropertyParamsClass</span>(<span class="arg-name">urn</span>)<a href="#datahub.metadata.schema_classes.StructuredPropertyParamsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><strong>urn</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-24"><em>property</em> urn <em>: str</em><a href="#property-urn--str-24" class="hash-link" aria-label="Direct link to property-urn--str-24" title="Direct link to property-urn--str-24"></a></h4><p>The structured property that is required on this entity</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.StructuredPropertySettingsClass"><span class="visually-hidden">StructuredPropertySettingsClass</span><a href="#datahub.metadata.schema_classes.StructuredPropertySettingsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.StructuredPropertySettingsClass" title="Direct link to datahub.metadata.schema_classes.StructuredPropertySettingsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">StructuredPropertySettingsClass</span>(<span class="arg-name">isHidden</span> = <span class="arg-default">None</span>, <span class="arg-name">showInSearchFilters</span> = <span class="arg-default">None</span>, <span class="arg-name">showInAssetSummary</span> = <span class="arg-default">None</span>, <span class="arg-name">showAsAssetBadge</span> = <span class="arg-default">None</span>, <span class="arg-name">showInColumnsTable</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.StructuredPropertySettingsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Settings specific to a structured property entity</p><ul><li><strong>Parameters:</strong><ul><li><strong>isHidden</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>showInSearchFilters</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>showInAssetSummary</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>showAsAssetBadge</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>showInColumnsTable</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-ishidden--bool"><em>property</em> isHidden <em>: bool</em><a href="#property-ishidden--bool" class="hash-link" aria-label="Direct link to property-ishidden--bool" title="Direct link to property-ishidden--bool"></a></h4><p>Whether or not this asset should be hidden in the main application</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--none--auditstampclass-6"><em>property</em> lastModified <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--none--auditstampclass-6" class="hash-link" aria-label="Direct link to property-lastmodified--none--auditstampclass-6" title="Direct link to property-lastmodified--none--auditstampclass-6"></a></h4><p>Last Modified Audit stamp</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-showasassetbadge--bool"><em>property</em> showAsAssetBadge <em>: bool</em><a href="#property-showasassetbadge--bool" class="hash-link" aria-label="Direct link to property-showasassetbadge--bool" title="Direct link to property-showasassetbadge--bool"></a></h4><p>Whether or not this asset should be displayed as an asset badge on other
|
||
asset’s headers</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-showinassetsummary--bool"><em>property</em> showInAssetSummary <em>: bool</em><a href="#property-showinassetsummary--bool" class="hash-link" aria-label="Direct link to property-showinassetsummary--bool" title="Direct link to property-showinassetsummary--bool"></a></h4><p>Whether or not this asset should be displayed in the asset sidebar</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-showincolumnstable--bool"><em>property</em> showInColumnsTable <em>: bool</em><a href="#property-showincolumnstable--bool" class="hash-link" aria-label="Direct link to property-showincolumnstable--bool" title="Direct link to property-showincolumnstable--bool"></a></h4><p>Whether or not this asset should be displayed as a column in the schema field table
|
||
in a Dataset’s “Columns” tab.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-showinsearchfilters--bool"><em>property</em> showInSearchFilters <em>: bool</em><a href="#property-showinsearchfilters--bool" class="hash-link" aria-label="Direct link to property-showinsearchfilters--bool" title="Direct link to property-showinsearchfilters--bool"></a></h4><p>Whether or not this asset should be displayed as a search filter</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.StructuredPropertyValueAssignmentClass"><span class="visually-hidden">StructuredPropertyValueAssignmentClass</span><a href="#datahub.metadata.schema_classes.StructuredPropertyValueAssignmentClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.StructuredPropertyValueAssignmentClass" title="Direct link to datahub.metadata.schema_classes.StructuredPropertyValueAssignmentClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">StructuredPropertyValueAssignmentClass</span>(<span class="arg-name">propertyUrn</span>, <span class="arg-name">values</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">lastModified</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.StructuredPropertyValueAssignmentClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>propertyUrn</strong> (<code>str</code>)</li><li><strong>values</strong> (<code>List</code>[<code>Union</code>[<code>str</code>, <code>float</code>]<!-- -->])</li><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>lastModified</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--none--auditstampclass-11"><em>property</em> created <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--none--auditstampclass-11" class="hash-link" aria-label="Direct link to property-created--none--auditstampclass-11" title="Direct link to property-created--none--auditstampclass-11"></a></h4><p>Audit stamp containing who created this relationship edge and when</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastmodified--none--auditstampclass-7"><em>property</em> lastModified <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastmodified--none--auditstampclass-7" class="hash-link" aria-label="Direct link to property-lastmodified--none--auditstampclass-7" title="Direct link to property-lastmodified--none--auditstampclass-7"></a></h4><p>Audit stamp containing who last modified this relationship edge and when</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-propertyurn--str"><em>property</em> propertyUrn <em>: str</em><a href="#property-propertyurn--str" class="hash-link" aria-label="Direct link to property-propertyurn--str" title="Direct link to property-propertyurn--str"></a></h4><p>The property that is being assigned a value.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-values--liststr--float"><em>property</em> values <em>: List<!-- -->[str | float]</em><a href="#property-values--liststr--float" class="hash-link" aria-label="Direct link to property-values--liststr--float" title="Direct link to property-values--liststr--float"></a></h4><p>The value assigned to the property.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SubTypesClass"><span class="visually-hidden">SubTypesClass</span><a href="#datahub.metadata.schema_classes.SubTypesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SubTypesClass" title="Direct link to datahub.metadata.schema_classes.SubTypesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SubTypesClass</span>(<span class="arg-name">typeNames</span>)<a href="#datahub.metadata.schema_classes.SubTypesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Sub Types. Use this aspect to specialize a generic Entity
|
||
e.g. Making a Dataset also be a View or also be a LookerExplore</p><ul><li><strong>Parameters:</strong><strong>typeNames</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-typenames--liststr"><em>property</em> typeNames <em>: List<!-- -->[str]</em><a href="#property-typenames--liststr" class="hash-link" aria-label="Direct link to property-typenames--liststr" title="Direct link to property-typenames--liststr"></a></h4><p>The names of the specific types.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.SystemMetadataClass"><span class="visually-hidden">SystemMetadataClass</span><a href="#datahub.metadata.schema_classes.SystemMetadataClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.SystemMetadataClass" title="Direct link to datahub.metadata.schema_classes.SystemMetadataClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">SystemMetadataClass</span>(<span class="arg-name">lastObserved</span> = <span class="arg-default">None</span>, <span class="arg-name">runId</span> = <span class="arg-default">None</span>, <span class="arg-name">lastRunId</span> = <span class="arg-default">None</span>, <span class="arg-name">pipelineName</span> = <span class="arg-default">None</span>, <span class="arg-name">registryName</span> = <span class="arg-default">None</span>, <span class="arg-name">registryVersion</span> = <span class="arg-default">None</span>, <span class="arg-name">properties</span> = <span class="arg-default">None</span>, <span class="arg-name">version</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.SystemMetadataClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Metadata associated with each metadata change that is processed by the system</p><ul><li><strong>Parameters:</strong><ul><li><strong>lastObserved</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>runId</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>lastRunId</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>pipelineName</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>registryName</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>registryVersion</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>properties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>version</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastobserved--int--none"><em>property</em> lastObserved <em>: int | None</em><a href="#property-lastobserved--int--none" class="hash-link" aria-label="Direct link to property-lastobserved--int--none" title="Direct link to property-lastobserved--int--none"></a></h4><p>The timestamp the metadata was observed at</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastrunid--str--none"><em>property</em> lastRunId <em>: str | None</em><a href="#property-lastrunid--str--none" class="hash-link" aria-label="Direct link to property-lastrunid--str--none" title="Direct link to property-lastrunid--str--none"></a></h4><p>The last run id that produced the metadata. Populated in case of batch-ingestion.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-pipelinename--none--str"><em>property</em> pipelineName <em>: None | str</em><a href="#property-pipelinename--none--str" class="hash-link" aria-label="Direct link to property-pipelinename--none--str" title="Direct link to property-pipelinename--none--str"></a></h4><p>The ingestion pipeline id that produced the metadata. Populated in case of batch ingestion.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-properties--none--dictstr-str-3"><em>property</em> properties <em>: None | Dict<!-- -->[str, str]</em><a href="#property-properties--none--dictstr-str-3" class="hash-link" aria-label="Direct link to property-properties--none--dictstr-str-3" title="Direct link to property-properties--none--dictstr-str-3"></a></h4><p>Additional properties</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-registryname--none--str"><em>property</em> registryName <em>: None | str</em><a href="#property-registryname--none--str" class="hash-link" aria-label="Direct link to property-registryname--none--str" title="Direct link to property-registryname--none--str"></a></h4><p>The model registry name that was used to process this event</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-registryversion--none--str"><em>property</em> registryVersion <em>: None | str</em><a href="#property-registryversion--none--str" class="hash-link" aria-label="Direct link to property-registryversion--none--str" title="Direct link to property-registryversion--none--str"></a></h4><p>The model registry version that was used to process this event</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-runid--str--none"><em>property</em> runId <em>: str | None</em><a href="#property-runid--str--none" class="hash-link" aria-label="Direct link to property-runid--str--none" title="Direct link to property-runid--str--none"></a></h4><p>The original run id that produced the metadata. Populated in case of batch-ingestion.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-version--none--str-2"><em>property</em> version <em>: None | str</em><a href="#property-version--none--str-2" class="hash-link" aria-label="Direct link to property-version--none--str-2" title="Direct link to property-version--none--str-2"></a></h4><p>Aspect version
|
||
Initial implementation will use the aspect version’s number, however stored as
|
||
a string in the case where a different aspect versioning scheme is later adopted.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.TagAssociationClass"><span class="visually-hidden">TagAssociationClass</span><a href="#datahub.metadata.schema_classes.TagAssociationClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.TagAssociationClass" title="Direct link to datahub.metadata.schema_classes.TagAssociationClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">TagAssociationClass</span>(<span class="arg-name">tag</span>, <span class="arg-name">context</span> = <span class="arg-default">None</span>, <span class="arg-name">attribution</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.TagAssociationClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Properties of an applied tag. For now, just an Urn. In the future we can extend this with other properties, e.g.
|
||
propagation parameters.</p><ul><li><strong>Parameters:</strong><ul><li><strong>tag</strong> (<code>str</code>)</li><li><strong>context</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>attribution</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.MetadataAttributionClass"><code>MetadataAttributionClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-attribution--none--metadataattributionclass-2"><em>property</em> attribution <em>: None | <a href="#datahub.metadata.schema_classes.MetadataAttributionClass">MetadataAttributionClass</a></em><a href="#property-attribution--none--metadataattributionclass-2" class="hash-link" aria-label="Direct link to property-attribution--none--metadataattributionclass-2" title="Direct link to property-attribution--none--metadataattributionclass-2"></a></h4><p>Information about who, why, and how this metadata was applied</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-context--none--str-1"><em>property</em> context <em>: None | str</em><a href="#property-context--none--str-1" class="hash-link" aria-label="Direct link to property-context--none--str-1" title="Direct link to property-context--none--str-1"></a></h4><p>Additional context about the association</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-tag--str"><em>property</em> tag <em>: str</em><a href="#property-tag--str" class="hash-link" aria-label="Direct link to property-tag--str" title="Direct link to property-tag--str"></a></h4><p>Urn of the applied tag</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.TagKeyClass"><span class="visually-hidden">TagKeyClass</span><a href="#datahub.metadata.schema_classes.TagKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.TagKeyClass" title="Direct link to datahub.metadata.schema_classes.TagKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">TagKeyClass</span>(<span class="arg-name">name</span>)<a href="#datahub.metadata.schema_classes.TagKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Tag</p><ul><li><strong>Parameters:</strong><strong>name</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-34"><em>property</em> name <em>: str</em><a href="#property-name--str-34" class="hash-link" aria-label="Direct link to property-name--str-34" title="Direct link to property-name--str-34"></a></h4><p>The tag name, which serves as a unique id</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.TagPropertiesClass"><span class="visually-hidden">TagPropertiesClass</span><a href="#datahub.metadata.schema_classes.TagPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.TagPropertiesClass" title="Direct link to datahub.metadata.schema_classes.TagPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">TagPropertiesClass</span>(<span class="arg-name">name</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">colorHex</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.TagPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties associated with a Tag</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>colorHex</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-colorhex--none--str-1"><em>property</em> colorHex <em>: None | str</em><a href="#property-colorhex--none--str-1" class="hash-link" aria-label="Direct link to property-colorhex--none--str-1" title="Direct link to property-colorhex--none--str-1"></a></h4><p>The color associated with the Tag in Hex. For example #FFFFFF.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-50"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-50" class="hash-link" aria-label="Direct link to property-description--none--str-50" title="Direct link to property-description--none--str-50"></a></h4><p>Documentation of the tag</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-35"><em>property</em> name <em>: str</em><a href="#property-name--str-35" class="hash-link" aria-label="Direct link to property-name--str-35" title="Direct link to property-name--str-35"></a></h4><p>Display name of the tag</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.TagSnapshotClass"><span class="visually-hidden">TagSnapshotClass</span><a href="#datahub.metadata.schema_classes.TagSnapshotClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.TagSnapshotClass" title="Direct link to datahub.metadata.schema_classes.TagSnapshotClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">TagSnapshotClass</span>(<span class="arg-name">urn</span>, <span class="arg-name">aspects</span>)<a href="#datahub.metadata.schema_classes.TagSnapshotClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A metadata snapshot for a specific dataset entity.</p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>aspects</strong> (<code>List</code>[<code>Union</code>[<a href="#datahub.metadata.schema_classes.TagKeyClass"><code>TagKeyClass</code></a>, <a href="#datahub.metadata.schema_classes.OwnershipClass"><code>OwnershipClass</code></a>, <a href="#datahub.metadata.schema_classes.TagPropertiesClass"><code>TagPropertiesClass</code></a>, <a href="#datahub.metadata.schema_classes.StatusClass"><code>StatusClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aspects--listtagkeyclass--ownershipclass--tagpropertiesclass--statusclass"><em>property</em> aspects <em>: List[<a href="#datahub.metadata.schema_classes.TagKeyClass">TagKeyClass</a> | <a href="#datahub.metadata.schema_classes.OwnershipClass">OwnershipClass</a> | <a href="#datahub.metadata.schema_classes.TagPropertiesClass">TagPropertiesClass</a> | <a href="#datahub.metadata.schema_classes.StatusClass">StatusClass</a>]</em><a href="#property-aspects--listtagkeyclass--ownershipclass--tagpropertiesclass--statusclass" class="hash-link" aria-label="Direct link to property-aspects--listtagkeyclass--ownershipclass--tagpropertiesclass--statusclass" title="Direct link to property-aspects--listtagkeyclass--ownershipclass--tagpropertiesclass--statusclass"></a></h4><p>The list of metadata aspects associated with the dataset. Depending on the use case, this can either be all, or a selection, of supported aspects.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--str-25"><em>property</em> urn <em>: str</em><a href="#property-urn--str-25" class="hash-link" aria-label="Direct link to property-urn--str-25" title="Direct link to property-urn--str-25"></a></h4><p>URN for the entity the metadata snapshot is associated with.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.TelemetryClientIdClass"><span class="visually-hidden">TelemetryClientIdClass</span><a href="#datahub.metadata.schema_classes.TelemetryClientIdClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.TelemetryClientIdClass" title="Direct link to datahub.metadata.schema_classes.TelemetryClientIdClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">TelemetryClientIdClass</span>(<span class="arg-name">clientId</span>)<a href="#datahub.metadata.schema_classes.TelemetryClientIdClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>A simple wrapper around a String to persist the client ID for telemetry in DataHub’s backend DB</p><ul><li><strong>Parameters:</strong><strong>clientId</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-clientid--str-2"><em>property</em> clientId <em>: str</em><a href="#property-clientid--str-2" class="hash-link" aria-label="Direct link to property-clientid--str-2" title="Direct link to property-clientid--str-2"></a></h4><p>A string representing the telemetry client ID</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.TelemetryKeyClass"><span class="visually-hidden">TelemetryKeyClass</span><a href="#datahub.metadata.schema_classes.TelemetryKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.TelemetryKeyClass" title="Direct link to datahub.metadata.schema_classes.TelemetryKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">TelemetryKeyClass</span>(<span class="arg-name">name</span>)<a href="#datahub.metadata.schema_classes.TelemetryKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for the telemetry client ID, only one should ever exist</p><ul><li><strong>Parameters:</strong><strong>name</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-36"><em>property</em> name <em>: str</em><a href="#property-name--str-36" class="hash-link" aria-label="Direct link to property-name--str-36" title="Direct link to property-name--str-36"></a></h4><p>The telemetry entity name, which serves as a unique id</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.TestDefinitionClass"><span class="visually-hidden">TestDefinitionClass</span><a href="#datahub.metadata.schema_classes.TestDefinitionClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.TestDefinitionClass" title="Direct link to datahub.metadata.schema_classes.TestDefinitionClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">TestDefinitionClass</span>(<span class="arg-name">type</span>, <span class="arg-name">json</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.TestDefinitionClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.TestDefinitionTypeClass"><code>TestDefinitionTypeClass</code></a>]) – </li><li><strong>json</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-json--none--str"><em>property</em> json <em>: None | str</em><a href="#property-json--none--str" class="hash-link" aria-label="Direct link to property-json--none--str" title="Direct link to property-json--none--str"></a></h4><p>JSON format configuration for the test</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--testdefinitiontypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.TestDefinitionTypeClass">TestDefinitionTypeClass</a></em><a href="#property-type--str--testdefinitiontypeclass" class="hash-link" aria-label="Direct link to property-type--str--testdefinitiontypeclass" title="Direct link to property-type--str--testdefinitiontypeclass"></a></h4><p>The Test Definition Type</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.TestDefinitionTypeClass"><span class="visually-hidden">TestDefinitionTypeClass</span><a href="#datahub.metadata.schema_classes.TestDefinitionTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.TestDefinitionTypeClass" title="Direct link to datahub.metadata.schema_classes.TestDefinitionTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">TestDefinitionTypeClass</span>()<a href="#datahub.metadata.schema_classes.TestDefinitionTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="json--json-3">JSON <em>= 'JSON'</em><a href="#json--json-3" class="hash-link" aria-label="Direct link to json--json-3" title="Direct link to json--json-3"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.TestInfoClass"><span class="visually-hidden">TestInfoClass</span><a href="#datahub.metadata.schema_classes.TestInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.TestInfoClass" title="Direct link to datahub.metadata.schema_classes.TestInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">TestInfoClass</span>(<span class="arg-name">name</span>, <span class="arg-name">category</span>, <span class="arg-name">definition</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.TestInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a DataHub Test</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>category</strong> (<code>str</code>)</li><li><strong>definition</strong> (<a href="#datahub.metadata.schema_classes.TestDefinitionClass"><code>TestDefinitionClass</code></a>) – </li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-category--str-1"><em>property</em> category <em>: str</em><a href="#property-category--str-1" class="hash-link" aria-label="Direct link to property-category--str-1" title="Direct link to property-category--str-1"></a></h4><p>Category of the test</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-definition--testdefinitionclass"><em>property</em> definition <em>: <a href="#datahub.metadata.schema_classes.TestDefinitionClass">TestDefinitionClass</a></em><a href="#property-definition--testdefinitionclass" class="hash-link" aria-label="Direct link to property-definition--testdefinitionclass" title="Direct link to property-definition--testdefinitionclass"></a></h4><p>Configuration for the Test</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--none--str-51"><em>property</em> description <em>: None | str</em><a href="#property-description--none--str-51" class="hash-link" aria-label="Direct link to property-description--none--str-51" title="Direct link to property-description--none--str-51"></a></h4><p>Description of the test</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-37"><em>property</em> name <em>: str</em><a href="#property-name--str-37" class="hash-link" aria-label="Direct link to property-name--str-37" title="Direct link to property-name--str-37"></a></h4><p>The name of the test</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.TestKeyClass"><span class="visually-hidden">TestKeyClass</span><a href="#datahub.metadata.schema_classes.TestKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.TestKeyClass" title="Direct link to datahub.metadata.schema_classes.TestKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">TestKeyClass</span>(<span class="arg-name">id</span>)<a href="#datahub.metadata.schema_classes.TestKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Test</p><ul><li><strong>Parameters:</strong><strong>id</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-38"><em>property</em> id <em>: str</em><a href="#property-id--str-38" class="hash-link" aria-label="Direct link to property-id--str-38" title="Direct link to property-id--str-38"></a></h4><p>Unique id for the test</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.TestResultClass"><span class="visually-hidden">TestResultClass</span><a href="#datahub.metadata.schema_classes.TestResultClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.TestResultClass" title="Direct link to datahub.metadata.schema_classes.TestResultClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">TestResultClass</span>(<span class="arg-name">test</span>, <span class="arg-name">type</span>, <span class="arg-name">testDefinitionMd5</span> = <span class="arg-default">None</span>, <span class="arg-name">lastComputed</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.TestResultClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Information about a Test Result</p><ul><li><strong>Parameters:</strong><ul><li><strong>test</strong> (<code>str</code>)</li><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.TestResultTypeClass"><code>TestResultTypeClass</code></a>]) – </li><li><strong>testDefinitionMd5</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>lastComputed</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-lastcomputed--none--auditstampclass"><em>property</em> lastComputed <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-lastcomputed--none--auditstampclass" class="hash-link" aria-label="Direct link to property-lastcomputed--none--auditstampclass" title="Direct link to property-lastcomputed--none--auditstampclass"></a></h4><p>The audit stamp of when the result was computed, including the actor who computed it.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-test--str"><em>property</em> test <em>: str</em><a href="#property-test--str" class="hash-link" aria-label="Direct link to property-test--str" title="Direct link to property-test--str"></a></h4><p>The urn of the test</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-testdefinitionmd5--none--str"><em>property</em> testDefinitionMd5 <em>: None | str</em><a href="#property-testdefinitionmd5--none--str" class="hash-link" aria-label="Direct link to property-testdefinitionmd5--none--str" title="Direct link to property-testdefinitionmd5--none--str"></a></h4><p>The md5 of the test definition that was used to compute this result.
|
||
See TestInfo.testDefinition.md5 for more information.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--testresulttypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.TestResultTypeClass">TestResultTypeClass</a></em><a href="#property-type--str--testresulttypeclass" class="hash-link" aria-label="Direct link to property-type--str--testresulttypeclass" title="Direct link to property-type--str--testresulttypeclass"></a></h4><p>The type of the result</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.TestResultTypeClass"><span class="visually-hidden">TestResultTypeClass</span><a href="#datahub.metadata.schema_classes.TestResultTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.TestResultTypeClass" title="Direct link to datahub.metadata.schema_classes.TestResultTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">TestResultTypeClass</span>()<a href="#datahub.metadata.schema_classes.TestResultTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="failure--failure-2">FAILURE <em>= 'FAILURE'</em><a href="#failure--failure-2" class="hash-link" aria-label="Direct link to failure--failure-2" title="Direct link to failure--failure-2"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="success--success-2">SUCCESS <em>= 'SUCCESS'</em><a href="#success--success-2" class="hash-link" aria-label="Direct link to success--success-2" title="Direct link to success--success-2"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.TestResultsClass"><span class="visually-hidden">TestResultsClass</span><a href="#datahub.metadata.schema_classes.TestResultsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.TestResultsClass" title="Direct link to datahub.metadata.schema_classes.TestResultsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">TestResultsClass</span>(<span class="arg-name">failing</span>, <span class="arg-name">passing</span>)<a href="#datahub.metadata.schema_classes.TestResultsClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a Test Result</p><ul><li><strong>Parameters:</strong><ul><li><strong>failing</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.TestResultClass"><code>TestResultClass</code></a>]) – </li><li><strong>passing</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.TestResultClass"><code>TestResultClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-failing--listtestresultclass"><em>property</em> failing <em>: List[<a href="#datahub.metadata.schema_classes.TestResultClass">TestResultClass</a>]</em><a href="#property-failing--listtestresultclass" class="hash-link" aria-label="Direct link to property-failing--listtestresultclass" title="Direct link to property-failing--listtestresultclass"></a></h4><p>Results that are failing</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-passing--listtestresultclass"><em>property</em> passing <em>: List[<a href="#datahub.metadata.schema_classes.TestResultClass">TestResultClass</a>]</em><a href="#property-passing--listtestresultclass" class="hash-link" aria-label="Direct link to property-passing--listtestresultclass" title="Direct link to property-passing--listtestresultclass"></a></h4><p>Results that are passing</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.TextCellClass"><span class="visually-hidden">TextCellClass</span><a href="#datahub.metadata.schema_classes.TextCellClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.TextCellClass" title="Direct link to datahub.metadata.schema_classes.TextCellClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">TextCellClass</span>(<span class="arg-name">cellId</span>, <span class="arg-name">changeAuditStamps</span>, <span class="arg-name">text</span>, <span class="arg-name">cellTitle</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.TextCellClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Text cell in a Notebook, which will present content in text format</p><ul><li><strong>Parameters:</strong><ul><li><strong>cellId</strong> (<code>str</code>)</li><li><strong>changeAuditStamps</strong> (<a href="#datahub.metadata.schema_classes.ChangeAuditStampsClass"><code>ChangeAuditStampsClass</code></a>) – </li><li><strong>text</strong> (<code>str</code>)</li><li><strong>cellTitle</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-cellid--str-2"><em>property</em> cellId <em>: str</em><a href="#property-cellid--str-2" class="hash-link" aria-label="Direct link to property-cellid--str-2" title="Direct link to property-cellid--str-2"></a></h4><p>Unique id for the cell. This id should be globally unique for a Notebook tool even when there are multiple deployments of it. As an example, Notebook URL could be used here for QueryBook such as ‘querybook.com/notebook/773/?cellId=1234’</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-celltitle--none--str-2"><em>property</em> cellTitle <em>: None | str</em><a href="#property-celltitle--none--str-2" class="hash-link" aria-label="Direct link to property-celltitle--none--str-2" title="Direct link to property-celltitle--none--str-2"></a></h4><p>Title of the cell</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-changeauditstamps--changeauditstampsclass-3"><em>property</em> changeAuditStamps <em>: <a href="#datahub.metadata.schema_classes.ChangeAuditStampsClass">ChangeAuditStampsClass</a></em><a href="#property-changeauditstamps--changeauditstampsclass-3" class="hash-link" aria-label="Direct link to property-changeauditstamps--changeauditstampsclass-3" title="Direct link to property-changeauditstamps--changeauditstampsclass-3"></a></h4><p>Captures information about who created/last modified/deleted this Notebook cell and when</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-text--str"><em>property</em> text <em>: str</em><a href="#property-text--str" class="hash-link" aria-label="Direct link to property-text--str" title="Direct link to property-text--str"></a></h4><p>The actual text in a TextCell in a Notebook</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.TimeBasedRetentionClass"><span class="visually-hidden">TimeBasedRetentionClass</span><a href="#datahub.metadata.schema_classes.TimeBasedRetentionClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.TimeBasedRetentionClass" title="Direct link to datahub.metadata.schema_classes.TimeBasedRetentionClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">TimeBasedRetentionClass</span>(<span class="arg-name">maxAgeInSeconds</span>)<a href="#datahub.metadata.schema_classes.TimeBasedRetentionClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Keep records that are less than X seconds old</p><ul><li><strong>Parameters:</strong><strong>maxAgeInSeconds</strong> (<code>int</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-maxageinseconds--int"><em>property</em> maxAgeInSeconds <em>: int</em><a href="#property-maxageinseconds--int" class="hash-link" aria-label="Direct link to property-maxageinseconds--int" title="Direct link to property-maxageinseconds--int"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.TimeStampClass"><span class="visually-hidden">TimeStampClass</span><a href="#datahub.metadata.schema_classes.TimeStampClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.TimeStampClass" title="Direct link to datahub.metadata.schema_classes.TimeStampClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">TimeStampClass</span>(<span class="arg-name">time</span>, <span class="arg-name">actor</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.TimeStampClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A standard event timestamp</p><ul><li><strong>Parameters:</strong><ul><li><strong>time</strong> (<code>int</code>)</li><li><strong>actor</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-actor--none--str-3"><em>property</em> actor <em>: None | str</em><a href="#property-actor--none--str-3" class="hash-link" aria-label="Direct link to property-actor--none--str-3" title="Direct link to property-actor--none--str-3"></a></h4><p>The actor urn involved in the event.</p><ul><li><strong>Type:</strong>
|
||
Optional</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-time--int-3"><em>property</em> time <em>: int</em><a href="#property-time--int-3" class="hash-link" aria-label="Direct link to property-time--int-3" title="Direct link to property-time--int-3"></a></h4><p>When did the event occur</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.TimeTypeClass"><span class="visually-hidden">TimeTypeClass</span><a href="#datahub.metadata.schema_classes.TimeTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.TimeTypeClass" title="Direct link to datahub.metadata.schema_classes.TimeTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">TimeTypeClass</span>()<a href="#datahub.metadata.schema_classes.TimeTypeClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Time field type. This should also be used for datetimes.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.TimeWindowClass"><span class="visually-hidden">TimeWindowClass</span><a href="#datahub.metadata.schema_classes.TimeWindowClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.TimeWindowClass" title="Direct link to datahub.metadata.schema_classes.TimeWindowClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">TimeWindowClass</span>(<span class="arg-name">startTimeMillis</span>, <span class="arg-name">length</span>)<a href="#datahub.metadata.schema_classes.TimeWindowClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>startTimeMillis</strong> (<code>int</code>)</li><li><strong>length</strong> (<a href="#datahub.metadata.schema_classes.TimeWindowSizeClass"><code>TimeWindowSizeClass</code></a>) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-length--timewindowsizeclass"><em>property</em> length <em>: <a href="#datahub.metadata.schema_classes.TimeWindowSizeClass">TimeWindowSizeClass</a></em><a href="#property-length--timewindowsizeclass" class="hash-link" aria-label="Direct link to property-length--timewindowsizeclass" title="Direct link to property-length--timewindowsizeclass"></a></h4><p>The length of the window.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-starttimemillis--int"><em>property</em> startTimeMillis <em>: int</em><a href="#property-starttimemillis--int" class="hash-link" aria-label="Direct link to property-starttimemillis--int" title="Direct link to property-starttimemillis--int"></a></h4><p>Start time as epoch at UTC.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.TimeWindowSizeClass"><span class="visually-hidden">TimeWindowSizeClass</span><a href="#datahub.metadata.schema_classes.TimeWindowSizeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.TimeWindowSizeClass" title="Direct link to datahub.metadata.schema_classes.TimeWindowSizeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">TimeWindowSizeClass</span>(<span class="arg-name">unit</span>, <span class="arg-name">multiple</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.TimeWindowSizeClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Defines the size of a time window.</p><ul><li><strong>Parameters:</strong><ul><li><strong>unit</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.CalendarIntervalClass"><code>CalendarIntervalClass</code></a>]) – </li><li><strong>multiple</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-multiple--int-1"><em>property</em> multiple <em>: int</em><a href="#property-multiple--int-1" class="hash-link" aria-label="Direct link to property-multiple--int-1" title="Direct link to property-multiple--int-1"></a></h4><p>How many units. Defaults to 1.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-unit--str--calendarintervalclass-1"><em>property</em> unit <em>: str | <a href="#datahub.metadata.schema_classes.CalendarIntervalClass">CalendarIntervalClass</a></em><a href="#property-unit--str--calendarintervalclass-1" class="hash-link" aria-label="Direct link to property-unit--str--calendarintervalclass-1" title="Direct link to property-unit--str--calendarintervalclass-1"></a></h4><p>Interval unit such as minute/hour/day etc.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.TrainingDataClass"><span class="visually-hidden">TrainingDataClass</span><a href="#datahub.metadata.schema_classes.TrainingDataClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.TrainingDataClass" title="Direct link to datahub.metadata.schema_classes.TrainingDataClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">TrainingDataClass</span>(<span class="arg-name">trainingData</span>)<a href="#datahub.metadata.schema_classes.TrainingDataClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Ideally, the MLModel card would contain as much information about the training data as the evaluation data. However, there might be cases where it is not feasible to provide this level of detailed information about the training data. For example, the data may be proprietary, or require a non-disclosure agreement. In these cases, we advocate for basic details about the distributions over groups in the data, as well as any other details that could inform stakeholders on the kinds of biases the model may have encoded.</p><ul><li><strong>Parameters:</strong><strong>trainingData</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.BaseDataClass"><code>BaseDataClass</code></a>]) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-trainingdata--listbasedataclass"><em>property</em> trainingData <em>: List[<a href="#datahub.metadata.schema_classes.BaseDataClass">BaseDataClass</a>]</em><a href="#property-trainingdata--listbasedataclass" class="hash-link" aria-label="Direct link to property-trainingdata--listbasedataclass" title="Direct link to property-trainingdata--listbasedataclass"></a></h4><p>Details on the dataset(s) used for training the MLModel</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.TransformationTypeClass"><span class="visually-hidden">TransformationTypeClass</span><a href="#datahub.metadata.schema_classes.TransformationTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.TransformationTypeClass" title="Direct link to datahub.metadata.schema_classes.TransformationTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">TransformationTypeClass</span>()<a href="#datahub.metadata.schema_classes.TransformationTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>Type of the transformation involved in generating destination fields from source fields.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="blackbox--blackbox">BLACKBOX <em>= 'BLACKBOX'</em><a href="#blackbox--blackbox" class="hash-link" aria-label="Direct link to blackbox--blackbox" title="Direct link to blackbox--blackbox"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="identity--identity-1">IDENTITY <em>= 'IDENTITY'</em><a href="#identity--identity-1" class="hash-link" aria-label="Direct link to identity--identity-1" title="Direct link to identity--identity-1"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.UDFTransformerClass"><span class="visually-hidden">UDFTransformerClass</span><a href="#datahub.metadata.schema_classes.UDFTransformerClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.UDFTransformerClass" title="Direct link to datahub.metadata.schema_classes.UDFTransformerClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">UDFTransformerClass</span>(<span class="arg-name">udf</span>)<a href="#datahub.metadata.schema_classes.UDFTransformerClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Field transformation expressed in UDF</p><ul><li><strong>Parameters:</strong><strong>udf</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-udf--str"><em>property</em> udf <em>: str</em><a href="#property-udf--str" class="hash-link" aria-label="Direct link to property-udf--str" title="Direct link to property-udf--str"></a></h4><p>A UDF mentioning how the source fields got transformed to destination field. This is the FQCN(Fully Qualified Class Name) of the udf.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.UnionTypeClass"><span class="visually-hidden">UnionTypeClass</span><a href="#datahub.metadata.schema_classes.UnionTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.UnionTypeClass" title="Direct link to datahub.metadata.schema_classes.UnionTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">UnionTypeClass</span>(<span class="arg-name">nestedTypes</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.UnionTypeClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Union field type.</p><ul><li><strong>Parameters:</strong><strong>nestedTypes</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-nestedtypes--none--liststr"><em>property</em> nestedTypes <em>: None | List<!-- -->[str]</em><a href="#property-nestedtypes--none--liststr" class="hash-link" aria-label="Direct link to property-nestedtypes--none--liststr" title="Direct link to property-nestedtypes--none--liststr"></a></h4><p>List of types in union type.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.UpstreamClass"><span class="visually-hidden">UpstreamClass</span><a href="#datahub.metadata.schema_classes.UpstreamClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.UpstreamClass" title="Direct link to datahub.metadata.schema_classes.UpstreamClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">UpstreamClass</span>(<span class="arg-name">dataset</span>, <span class="arg-name">type</span>, <span class="arg-name">auditStamp</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">properties</span> = <span class="arg-default">None</span>, <span class="arg-name">query</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.UpstreamClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Upstream lineage information about a dataset including the source reporting the lineage</p><ul><li><strong>Parameters:</strong><ul><li><strong>dataset</strong> (<code>str</code>)</li><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.DatasetLineageTypeClass"><code>DatasetLineageTypeClass</code></a>]) – </li><li><strong>auditStamp</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>created</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>properties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>query</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-auditstamp--auditstampclass-2"><em>property</em> auditStamp <em>: <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-auditstamp--auditstampclass-2" class="hash-link" aria-label="Direct link to property-auditstamp--auditstampclass-2" title="Direct link to property-auditstamp--auditstampclass-2"></a></h4><p>Audit stamp containing who reported the lineage and when.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--none--auditstampclass-12"><em>property</em> created <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-created--none--auditstampclass-12" class="hash-link" aria-label="Direct link to property-created--none--auditstampclass-12" title="Direct link to property-created--none--auditstampclass-12"></a></h4><p>Audit stamp containing who created the lineage and when.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-dataset--str-2"><em>property</em> dataset <em>: str</em><a href="#property-dataset--str-2" class="hash-link" aria-label="Direct link to property-dataset--str-2" title="Direct link to property-dataset--str-2"></a></h4><p>The upstream dataset the lineage points to</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-properties--none--dictstr-str-4"><em>property</em> properties <em>: None | Dict<!-- -->[str, str]</em><a href="#property-properties--none--dictstr-str-4" class="hash-link" aria-label="Direct link to property-properties--none--dictstr-str-4" title="Direct link to property-properties--none--dictstr-str-4"></a></h4><p>A generic properties bag that allows us to store specific information on this graph edge.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-query--none--str-2"><em>property</em> query <em>: None | str</em><a href="#property-query--none--str-2" class="hash-link" aria-label="Direct link to property-query--none--str-2" title="Direct link to property-query--none--str-2"></a></h4><p>If the lineage is generated by a query, a reference to the query</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--datasetlineagetypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.DatasetLineageTypeClass">DatasetLineageTypeClass</a></em><a href="#property-type--str--datasetlineagetypeclass" class="hash-link" aria-label="Direct link to property-type--str--datasetlineagetypeclass" title="Direct link to property-type--str--datasetlineagetypeclass"></a></h4><p>The type of the lineage</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.UpstreamLineageClass"><span class="visually-hidden">UpstreamLineageClass</span><a href="#datahub.metadata.schema_classes.UpstreamLineageClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.UpstreamLineageClass" title="Direct link to datahub.metadata.schema_classes.UpstreamLineageClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">UpstreamLineageClass</span>(<span class="arg-name">upstreams</span>, <span class="arg-name">fineGrainedLineages</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.UpstreamLineageClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Upstream lineage of a dataset</p><ul><li><strong>Parameters:</strong><ul><li><strong>upstreams</strong> (<code>List</code>[<a href="#datahub.metadata.schema_classes.UpstreamClass"><code>UpstreamClass</code></a>]) – </li><li><strong>fineGrainedLineages</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.FineGrainedLineageClass"><code>FineGrainedLineageClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-finegrainedlineages--none--listfinegrainedlineageclass-1"><em>property</em> fineGrainedLineages <em>: None | List[<a href="#datahub.metadata.schema_classes.FineGrainedLineageClass">FineGrainedLineageClass</a>]</em><a href="#property-finegrainedlineages--none--listfinegrainedlineageclass-1" class="hash-link" aria-label="Direct link to property-finegrainedlineages--none--listfinegrainedlineageclass-1" title="Direct link to property-finegrainedlineages--none--listfinegrainedlineageclass-1"></a></h4><p>List of fine-grained lineage information, including field-level lineage</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-upstreams--listupstreamclass"><em>property</em> upstreams <em>: List[<a href="#datahub.metadata.schema_classes.UpstreamClass">UpstreamClass</a>]</em><a href="#property-upstreams--listupstreamclass" class="hash-link" aria-label="Direct link to property-upstreams--listupstreamclass" title="Direct link to property-upstreams--listupstreamclass"></a></h4><p>List of upstream dataset lineage information</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.UrnForeignKeyClass"><span class="visually-hidden">UrnForeignKeyClass</span><a href="#datahub.metadata.schema_classes.UrnForeignKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.UrnForeignKeyClass" title="Direct link to datahub.metadata.schema_classes.UrnForeignKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">UrnForeignKeyClass</span>(<span class="arg-name">currentFieldPath</span>)<a href="#datahub.metadata.schema_classes.UrnForeignKeyClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>If SchemaMetadata fields make any external references and references are of type com.linkedin.pegasus2avro.common.Urn or any children, this models can be used to mark it.</p><ul><li><strong>Parameters:</strong><strong>currentFieldPath</strong> (<code>str</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-currentfieldpath--str"><em>property</em> currentFieldPath <em>: str</em><a href="#property-currentfieldpath--str" class="hash-link" aria-label="Direct link to property-currentfieldpath--str" title="Direct link to property-currentfieldpath--str"></a></h4><p>Field in hosting(current) SchemaMetadata.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.UsageAggregationClass"><span class="visually-hidden">UsageAggregationClass</span><a href="#datahub.metadata.schema_classes.UsageAggregationClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.UsageAggregationClass" title="Direct link to datahub.metadata.schema_classes.UsageAggregationClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">UsageAggregationClass</span>(<span class="arg-name">bucket</span>, <span class="arg-name">duration</span>, <span class="arg-name">resource</span>, <span class="arg-name">metrics</span>)<a href="#datahub.metadata.schema_classes.UsageAggregationClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Usage data for a given resource, rolled up into a bucket.</p><ul><li><strong>Parameters:</strong><ul><li><strong>bucket</strong> (<code>int</code>)</li><li><strong>duration</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.WindowDurationClass"><code>WindowDurationClass</code></a>]) – </li><li><strong>resource</strong> (<code>str</code>)</li><li><strong>metrics</strong> (<a href="#datahub.metadata.schema_classes.UsageAggregationMetricsClass"><code>UsageAggregationMetricsClass</code></a>) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-bucket--int"><em>property</em> bucket <em>: int</em><a href="#property-bucket--int" class="hash-link" aria-label="Direct link to property-bucket--int" title="Direct link to property-bucket--int"></a></h4><p>Bucket start time in milliseconds</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-duration--str--windowdurationclass"><em>property</em> duration <em>: str | <a href="#datahub.metadata.schema_classes.WindowDurationClass">WindowDurationClass</a></em><a href="#property-duration--str--windowdurationclass" class="hash-link" aria-label="Direct link to property-duration--str--windowdurationclass" title="Direct link to property-duration--str--windowdurationclass"></a></h4><p>Bucket duration</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-metrics--usageaggregationmetricsclass"><em>property</em> metrics <em>: <a href="#datahub.metadata.schema_classes.UsageAggregationMetricsClass">UsageAggregationMetricsClass</a></em><a href="#property-metrics--usageaggregationmetricsclass" class="hash-link" aria-label="Direct link to property-metrics--usageaggregationmetricsclass" title="Direct link to property-metrics--usageaggregationmetricsclass"></a></h4><p>Metrics associated with this bucket</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-resource--str"><em>property</em> resource <em>: str</em><a href="#property-resource--str" class="hash-link" aria-label="Direct link to property-resource--str" title="Direct link to property-resource--str"></a></h4><p>Resource associated with these usage stats</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.UsageAggregationMetricsClass"><span class="visually-hidden">UsageAggregationMetricsClass</span><a href="#datahub.metadata.schema_classes.UsageAggregationMetricsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.UsageAggregationMetricsClass" title="Direct link to datahub.metadata.schema_classes.UsageAggregationMetricsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">UsageAggregationMetricsClass</span>(<span class="arg-name">uniqueUserCount</span> = <span class="arg-default">None</span>, <span class="arg-name">users</span> = <span class="arg-default">None</span>, <span class="arg-name">totalSqlQueries</span> = <span class="arg-default">None</span>, <span class="arg-name">topSqlQueries</span> = <span class="arg-default">None</span>, <span class="arg-name">fields</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.UsageAggregationMetricsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Metrics for usage data for a given resource and bucket. Not all fields
|
||
make sense for all buckets, so every field is optional.</p><ul><li><strong>Parameters:</strong><ul><li><strong>uniqueUserCount</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>users</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.UserUsageCountsClass"><code>UserUsageCountsClass</code></a>]]) – </li><li><strong>totalSqlQueries</strong> (<code>Optional</code>[<code>int</code>]<!-- -->)</li><li><strong>topSqlQueries</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>fields</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.FieldUsageCountsClass"><code>FieldUsageCountsClass</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-fields--none--listfieldusagecountsclass"><em>property</em> fields <em>: None | List[<a href="#datahub.metadata.schema_classes.FieldUsageCountsClass">FieldUsageCountsClass</a>]</em><a href="#property-fields--none--listfieldusagecountsclass" class="hash-link" aria-label="Direct link to property-fields--none--listfieldusagecountsclass" title="Direct link to property-fields--none--listfieldusagecountsclass"></a></h4><p>Field-level usage stats</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-topsqlqueries--none--liststr-1"><em>property</em> topSqlQueries <em>: None | List<!-- -->[str]</em><a href="#property-topsqlqueries--none--liststr-1" class="hash-link" aria-label="Direct link to property-topsqlqueries--none--liststr-1" title="Direct link to property-topsqlqueries--none--liststr-1"></a></h4><p>Frequent SQL queries; mostly makes sense for datasets in SQL databases</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-totalsqlqueries--none--int-1"><em>property</em> totalSqlQueries <em>: None | int</em><a href="#property-totalsqlqueries--none--int-1" class="hash-link" aria-label="Direct link to property-totalsqlqueries--none--int-1" title="Direct link to property-totalsqlqueries--none--int-1"></a></h4><p>Total SQL query count</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-uniqueusercount--none--int-4"><em>property</em> uniqueUserCount <em>: None | int</em><a href="#property-uniqueusercount--none--int-4" class="hash-link" aria-label="Direct link to property-uniqueusercount--none--int-4" title="Direct link to property-uniqueusercount--none--int-4"></a></h4><p>Unique user count</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-users--none--listuserusagecountsclass"><em>property</em> users <em>: None | List[<a href="#datahub.metadata.schema_classes.UserUsageCountsClass">UserUsageCountsClass</a>]</em><a href="#property-users--none--listuserusagecountsclass" class="hash-link" aria-label="Direct link to property-users--none--listuserusagecountsclass" title="Direct link to property-users--none--listuserusagecountsclass"></a></h4><p>Users within this bucket, with frequency counts</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.UserUsageCountsClass"><span class="visually-hidden">UserUsageCountsClass</span><a href="#datahub.metadata.schema_classes.UserUsageCountsClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.UserUsageCountsClass" title="Direct link to datahub.metadata.schema_classes.UserUsageCountsClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">UserUsageCountsClass</span>(<span class="arg-name">count</span>, <span class="arg-name">user</span> = <span class="arg-default">None</span>, <span class="arg-name">userEmail</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.UserUsageCountsClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Records a single user’s usage counts for a given resource</p><ul><li><strong>Parameters:</strong><ul><li><strong>count</strong> (<code>int</code>)</li><li><strong>user</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>userEmail</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-count--int-3"><em>property</em> count <em>: int</em><a href="#property-count--int-3" class="hash-link" aria-label="Direct link to property-count--int-3" title="Direct link to property-count--int-3"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-user--none--str"><em>property</em> user <em>: None | str</em><a href="#property-user--none--str" class="hash-link" aria-label="Direct link to property-user--none--str" title="Direct link to property-user--none--str"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-useremail--none--str-2"><em>property</em> userEmail <em>: None | str</em><a href="#property-useremail--none--str-2" class="hash-link" aria-label="Direct link to property-useremail--none--str-2" title="Direct link to property-useremail--none--str-2"></a></h4><p>If user_email is set, we attempt to resolve the user’s urn upon ingest</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ValueFrequencyClass"><span class="visually-hidden">ValueFrequencyClass</span><a href="#datahub.metadata.schema_classes.ValueFrequencyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ValueFrequencyClass" title="Direct link to datahub.metadata.schema_classes.ValueFrequencyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ValueFrequencyClass</span>(<span class="arg-name">value</span>, <span class="arg-name">frequency</span>)<a href="#datahub.metadata.schema_classes.ValueFrequencyClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>value</strong> (<code>str</code>)</li><li><strong>frequency</strong> (<code>int</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-frequency--int"><em>property</em> frequency <em>: int</em><a href="#property-frequency--int" class="hash-link" aria-label="Direct link to property-frequency--int" title="Direct link to property-frequency--int"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-value--str-5"><em>property</em> value <em>: str</em><a href="#property-value--str-5" class="hash-link" aria-label="Direct link to property-value--str-5" title="Direct link to property-value--str-5"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.VersionBasedRetentionClass"><span class="visually-hidden">VersionBasedRetentionClass</span><a href="#datahub.metadata.schema_classes.VersionBasedRetentionClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.VersionBasedRetentionClass" title="Direct link to datahub.metadata.schema_classes.VersionBasedRetentionClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">VersionBasedRetentionClass</span>(<span class="arg-name">maxVersions</span>)<a href="#datahub.metadata.schema_classes.VersionBasedRetentionClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Keep max N latest records</p><ul><li><strong>Parameters:</strong><strong>maxVersions</strong> (<code>int</code>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-maxversions--int"><em>property</em> maxVersions <em>: int</em><a href="#property-maxversions--int" class="hash-link" aria-label="Direct link to property-maxversions--int" title="Direct link to property-maxversions--int"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.VersionInfoClass"><span class="visually-hidden">VersionInfoClass</span><a href="#datahub.metadata.schema_classes.VersionInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.VersionInfoClass" title="Direct link to datahub.metadata.schema_classes.VersionInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">VersionInfoClass</span>(<span class="arg-name">version</span>, <span class="arg-name">versionType</span>, <span class="arg-name">customProperties</span> = <span class="arg-default">None</span>, <span class="arg-name">externalUrl</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.VersionInfoClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Information about a Data processing job</p><ul><li><strong>Parameters:</strong><ul><li><strong>version</strong> (<code>str</code>)</li><li><strong>versionType</strong> (<code>str</code>)</li><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>externalUrl</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-28"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-28" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-28" title="Direct link to property-customproperties--dictstr-str-28"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-externalurl--none--str-18"><em>property</em> externalUrl <em>: None | str</em><a href="#property-externalurl--none--str-18" class="hash-link" aria-label="Direct link to property-externalurl--none--str-18" title="Direct link to property-externalurl--none--str-18"></a></h4><p>URL where the reference exist</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-version--str-1"><em>property</em> version <em>: str</em><a href="#property-version--str-1" class="hash-link" aria-label="Direct link to property-version--str-1" title="Direct link to property-version--str-1"></a></h4><p>The version which can indentify a job version like a commit hash or md5 hash</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-versiontype--str"><em>property</em> versionType <em>: str</em><a href="#property-versiontype--str" class="hash-link" aria-label="Direct link to property-versiontype--str" title="Direct link to property-versiontype--str"></a></h4><p>The type of the version like git hash or md5 hash</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.VersionPropertiesClass"><span class="visually-hidden">VersionPropertiesClass</span><a href="#datahub.metadata.schema_classes.VersionPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.VersionPropertiesClass" title="Direct link to datahub.metadata.schema_classes.VersionPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">VersionPropertiesClass</span>(<span class="arg-name">versionSet</span>, <span class="arg-name">version</span>, <span class="arg-name">sortId</span>, <span class="arg-name">aliases</span> = <span class="arg-default">None</span>, <span class="arg-name">comment</span> = <span class="arg-default">None</span>, <span class="arg-name">versioningScheme</span> = <span class="arg-default">None</span>, <span class="arg-name">sourceCreatedTimestamp</span> = <span class="arg-default">None</span>, <span class="arg-name">metadataCreatedTimestamp</span> = <span class="arg-default">None</span>, <span class="arg-name">isLatest</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.VersionPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Properties about a versioned asset i.e. dataset, ML Model, etc.</p><ul><li><strong>Parameters:</strong><ul><li><strong>versionSet</strong> (<code>str</code>)</li><li><strong>version</strong> (<a href="#datahub.metadata.schema_classes.VersionTagClass"><code>VersionTagClass</code></a>) – </li><li><strong>sortId</strong> (<code>str</code>)</li><li><strong>aliases</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.metadata.schema_classes.VersionTagClass"><code>VersionTagClass</code></a>]]) – </li><li><strong>comment</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>versioningScheme</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.VersioningSchemeClass"><code>VersioningSchemeClass</code></a>, <code>None</code>]) – </li><li><strong>sourceCreatedTimestamp</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>metadataCreatedTimestamp</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.AuditStampClass"><code>AuditStampClass</code></a>]) – </li><li><strong>isLatest</strong> (<code>Optional</code>[<code>bool</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-aliases--listversiontagclass"><em>property</em> aliases <em>: List[<a href="#datahub.metadata.schema_classes.VersionTagClass">VersionTagClass</a>]</em><a href="#property-aliases--listversiontagclass" class="hash-link" aria-label="Direct link to property-aliases--listversiontagclass" title="Direct link to property-aliases--listversiontagclass"></a></h4><p>Associated aliases for this versioned asset</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-comment--none--str"><em>property</em> comment <em>: None | str</em><a href="#property-comment--none--str" class="hash-link" aria-label="Direct link to property-comment--none--str" title="Direct link to property-comment--none--str"></a></h4><p>Comment documenting what this version was created for, changes, or represents</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-islatest--none--bool"><em>property</em> isLatest <em>: None | bool</em><a href="#property-islatest--none--bool" class="hash-link" aria-label="Direct link to property-islatest--none--bool" title="Direct link to property-islatest--none--bool"></a></h4><p>Marks whether this version is currently the latest. Set by a side effect and should not be modified by API.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-metadatacreatedtimestamp--none--auditstampclass"><em>property</em> metadataCreatedTimestamp <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-metadatacreatedtimestamp--none--auditstampclass" class="hash-link" aria-label="Direct link to property-metadatacreatedtimestamp--none--auditstampclass" title="Direct link to property-metadatacreatedtimestamp--none--auditstampclass"></a></h4><p>Timestamp reflecting when the metadata for this version was created in DataHub</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-sortid--str"><em>property</em> sortId <em>: str</em><a href="#property-sortid--str" class="hash-link" aria-label="Direct link to property-sortid--str" title="Direct link to property-sortid--str"></a></h4><p>Sort identifier that determines where a version lives in the order of the Version Set.
|
||
What this looks like depends on the Version Scheme. For sort ids generated by DataHub we use an 8 character string representation.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-sourcecreatedtimestamp--none--auditstampclass"><em>property</em> sourceCreatedTimestamp <em>: None | <a href="#datahub.metadata.schema_classes.AuditStampClass">AuditStampClass</a></em><a href="#property-sourcecreatedtimestamp--none--auditstampclass" class="hash-link" aria-label="Direct link to property-sourcecreatedtimestamp--none--auditstampclass" title="Direct link to property-sourcecreatedtimestamp--none--auditstampclass"></a></h4><p>Timestamp reflecting when this asset version was created in the source system.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-version--versiontagclass"><em>property</em> version <em>: <a href="#datahub.metadata.schema_classes.VersionTagClass">VersionTagClass</a></em><a href="#property-version--versiontagclass" class="hash-link" aria-label="Direct link to property-version--versiontagclass" title="Direct link to property-version--versiontagclass"></a></h4><p>Label for this versioned asset, is unique within a version set</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-versionset--str"><em>property</em> versionSet <em>: str</em><a href="#property-versionset--str" class="hash-link" aria-label="Direct link to property-versionset--str" title="Direct link to property-versionset--str"></a></h4><p>The linked Version Set entity that ties multiple versioned assets together</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-versioningscheme--str--versioningschemeclass"><em>property</em> versioningScheme <em>: str | <a href="#datahub.metadata.schema_classes.VersioningSchemeClass">VersioningSchemeClass</a></em><a href="#property-versioningscheme--str--versioningschemeclass" class="hash-link" aria-label="Direct link to property-versioningscheme--str--versioningschemeclass" title="Direct link to property-versioningscheme--str--versioningschemeclass"></a></h4><p>What versioning scheme sortId belongs to.
|
||
Defaults to a plain string that is lexicographically sorted.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.VersionSetKeyClass"><span class="visually-hidden">VersionSetKeyClass</span><a href="#datahub.metadata.schema_classes.VersionSetKeyClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.VersionSetKeyClass" title="Direct link to datahub.metadata.schema_classes.VersionSetKeyClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">VersionSetKeyClass</span>(<span class="arg-name">id</span>, <span class="arg-name">entityType</span>)<a href="#datahub.metadata.schema_classes.VersionSetKeyClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Key for a Version Set entity</p><ul><li><strong>Parameters:</strong><ul><li><strong>id</strong> (<code>str</code>)</li><li><strong>entityType</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-entitytype--str-3"><em>property</em> entityType <em>: str</em><a href="#property-entitytype--str-3" class="hash-link" aria-label="Direct link to property-entitytype--str-3" title="Direct link to property-entitytype--str-3"></a></h4><p>Type of entities included in version set, limits to a single entity type between linked versioned entities</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-id--str-39"><em>property</em> id <em>: str</em><a href="#property-id--str-39" class="hash-link" aria-label="Direct link to property-id--str-39" title="Direct link to property-id--str-39"></a></h4><p>ID of the Version Set, generated from platform + asset id / name</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.VersionSetPropertiesClass"><span class="visually-hidden">VersionSetPropertiesClass</span><a href="#datahub.metadata.schema_classes.VersionSetPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.VersionSetPropertiesClass" title="Direct link to datahub.metadata.schema_classes.VersionSetPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">VersionSetPropertiesClass</span>(<span class="arg-name">latest</span>, <span class="arg-name">versioningScheme</span>, <span class="arg-name">customProperties</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.VersionSetPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>latest</strong> (<code>str</code>)</li><li><strong>versioningScheme</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.VersioningSchemeClass"><code>VersioningSchemeClass</code></a>]) – </li><li><strong>customProperties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-customproperties--dictstr-str-29"><em>property</em> customProperties <em>: Dict<!-- -->[str, str]</em><a href="#property-customproperties--dictstr-str-29" class="hash-link" aria-label="Direct link to property-customproperties--dictstr-str-29" title="Direct link to property-customproperties--dictstr-str-29"></a></h4><p>Custom property bag.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-latest--str"><em>property</em> latest <em>: str</em><a href="#property-latest--str" class="hash-link" aria-label="Direct link to property-latest--str" title="Direct link to property-latest--str"></a></h4><p>The latest versioned entity linked to in this version set</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-versioningscheme--str--versioningschemeclass-1"><em>property</em> versioningScheme <em>: str | <a href="#datahub.metadata.schema_classes.VersioningSchemeClass">VersioningSchemeClass</a></em><a href="#property-versioningscheme--str--versioningschemeclass-1" class="hash-link" aria-label="Direct link to property-versioningscheme--str--versioningschemeclass-1" title="Direct link to property-versioningscheme--str--versioningschemeclass-1"></a></h4><p>What versioning scheme is being utilized for the versioned entities sort criterion. Static once set</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.VersionTagClass"><span class="visually-hidden">VersionTagClass</span><a href="#datahub.metadata.schema_classes.VersionTagClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.VersionTagClass" title="Direct link to datahub.metadata.schema_classes.VersionTagClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">VersionTagClass</span>(<span class="arg-name">versionTag</span> = <span class="arg-default">None</span>, <span class="arg-name">metadataAttribution</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.VersionTagClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>A resource-defined string representing the resource state for the purpose of concurrency control</p><ul><li><strong>Parameters:</strong><ul><li><strong>versionTag</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>metadataAttribution</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.MetadataAttributionClass"><code>MetadataAttributionClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-metadataattribution--none--metadataattributionclass"><em>property</em> metadataAttribution <em>: None | <a href="#datahub.metadata.schema_classes.MetadataAttributionClass">MetadataAttributionClass</a></em><a href="#property-metadataattribution--none--metadataattributionclass" class="hash-link" aria-label="Direct link to property-metadataattribution--none--metadataattributionclass" title="Direct link to property-metadataattribution--none--metadataattributionclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-versiontag--none--str"><em>property</em> versionTag <em>: None | str</em><a href="#property-versiontag--none--str" class="hash-link" aria-label="Direct link to property-versiontag--none--str" title="Direct link to property-versiontag--none--str"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.VersioningSchemeClass"><span class="visually-hidden">VersioningSchemeClass</span><a href="#datahub.metadata.schema_classes.VersioningSchemeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.VersioningSchemeClass" title="Direct link to datahub.metadata.schema_classes.VersioningSchemeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">VersioningSchemeClass</span>()<a href="#datahub.metadata.schema_classes.VersioningSchemeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="alphanumeric_generated_by_datahub--alphanumeric_generated_by_datahub">ALPHANUMERIC_GENERATED_BY_DATAHUB <em>= 'ALPHANUMERIC_GENERATED_BY_DATAHUB'</em><a href="#alphanumeric_generated_by_datahub--alphanumeric_generated_by_datahub" class="hash-link" aria-label="Direct link to alphanumeric_generated_by_datahub--alphanumeric_generated_by_datahub" title="Direct link to alphanumeric_generated_by_datahub--alphanumeric_generated_by_datahub"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="lexicographic_string--lexicographic_string">LEXICOGRAPHIC_STRING <em>= 'LEXICOGRAPHIC_STRING'</em><a href="#lexicographic_string--lexicographic_string" class="hash-link" aria-label="Direct link to lexicographic_string--lexicographic_string" title="Direct link to lexicographic_string--lexicographic_string"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.ViewPropertiesClass"><span class="visually-hidden">ViewPropertiesClass</span><a href="#datahub.metadata.schema_classes.ViewPropertiesClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.ViewPropertiesClass" title="Direct link to datahub.metadata.schema_classes.ViewPropertiesClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">ViewPropertiesClass</span>(<span class="arg-name">materialized</span>, <span class="arg-name">viewLogic</span>, <span class="arg-name">viewLanguage</span>, <span class="arg-name">formattedViewLogic</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.ViewPropertiesClass" class="hash-link"></a></div><p>Bases: <code>_Aspect</code></p><p>Details about a View.
|
||
e.g. Gets activated when subTypes is view</p><ul><li><strong>Parameters:</strong><ul><li><strong>materialized</strong> (<code>bool</code>)</li><li><strong>viewLogic</strong> (<code>str</code>)</li><li><strong>viewLanguage</strong> (<code>str</code>)</li><li><strong>formattedViewLogic</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-formattedviewlogic--none--str"><em>property</em> formattedViewLogic <em>: None | str</em><a href="#property-formattedviewlogic--none--str" class="hash-link" aria-label="Direct link to property-formattedviewlogic--none--str" title="Direct link to property-formattedviewlogic--none--str"></a></h4><p>The formatted view logic. This is particularly used for SQL sources, where the SQL
|
||
logic is formatted for better readability, and with dbt, where this contains the
|
||
compiled SQL logic.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-materialized--bool"><em>property</em> materialized <em>: bool</em><a href="#property-materialized--bool" class="hash-link" aria-label="Direct link to property-materialized--bool" title="Direct link to property-materialized--bool"></a></h4><p>Whether the view is materialized</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-viewlanguage--str"><em>property</em> viewLanguage <em>: str</em><a href="#property-viewlanguage--str" class="hash-link" aria-label="Direct link to property-viewlanguage--str" title="Direct link to property-viewlanguage--str"></a></h4><p>The view logic language / dialect</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-viewlogic--str"><em>property</em> viewLogic <em>: str</em><a href="#property-viewlogic--str" class="hash-link" aria-label="Direct link to property-viewlogic--str" title="Direct link to property-viewlogic--str"></a></h4><p>The view logic</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.VolumeAssertionInfoClass"><span class="visually-hidden">VolumeAssertionInfoClass</span><a href="#datahub.metadata.schema_classes.VolumeAssertionInfoClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.VolumeAssertionInfoClass" title="Direct link to datahub.metadata.schema_classes.VolumeAssertionInfoClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">VolumeAssertionInfoClass</span>(<span class="arg-name">type</span>, <span class="arg-name">entity</span>, <span class="arg-name">rowCountTotal</span> = <span class="arg-default">None</span>, <span class="arg-name">rowCountChange</span> = <span class="arg-default">None</span>, <span class="arg-name">incrementingSegmentRowCountTotal</span> = <span class="arg-default">None</span>, <span class="arg-name">incrementingSegmentRowCountChange</span> = <span class="arg-default">None</span>, <span class="arg-name">filter</span> = <span class="arg-default">None</span>)<a href="#datahub.metadata.schema_classes.VolumeAssertionInfoClass" class="hash-link"></a></div><p>Bases: <code>DictWrapper</code></p><p>Attributes defining a dataset Volume Assertion</p><ul><li><strong>Parameters:</strong><ul><li><strong>type</strong> (<code>Union</code>[<code>str</code>, <a href="#datahub.metadata.schema_classes.VolumeAssertionTypeClass"><code>VolumeAssertionTypeClass</code></a>]) – </li><li><strong>entity</strong> (<code>str</code>)</li><li><strong>rowCountTotal</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.RowCountTotalClass"><code>RowCountTotalClass</code></a>]) – </li><li><strong>rowCountChange</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.RowCountChangeClass"><code>RowCountChangeClass</code></a>]) – </li><li><strong>incrementingSegmentRowCountTotal</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.IncrementingSegmentRowCountTotalClass"><code>IncrementingSegmentRowCountTotalClass</code></a>]) – </li><li><strong>incrementingSegmentRowCountChange</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.IncrementingSegmentRowCountChangeClass"><code>IncrementingSegmentRowCountChangeClass</code></a>]) – </li><li><strong>filter</strong> (<code>Optional</code>[<a href="#datahub.metadata.schema_classes.DatasetFilterClass"><code>DatasetFilterClass</code></a>]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-entity--str-7"><em>property</em> entity <em>: str</em><a href="#property-entity--str-7" class="hash-link" aria-label="Direct link to property-entity--str-7" title="Direct link to property-entity--str-7"></a></h4><p>The entity targeted by this Volume check.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-filter--none--datasetfilterclass-2"><em>property</em> filter <em>: None | <a href="#datahub.metadata.schema_classes.DatasetFilterClass">DatasetFilterClass</a></em><a href="#property-filter--none--datasetfilterclass-2" class="hash-link" aria-label="Direct link to property-filter--none--datasetfilterclass-2" title="Direct link to property-filter--none--datasetfilterclass-2"></a></h4><p>A definition of the specific filters that should be applied, when performing monitoring.
|
||
If not provided, there is no filter, and the full table is under consideration.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-incrementingsegmentrowcountchange--none--incrementingsegmentrowcountchangeclass"><em>property</em> incrementingSegmentRowCountChange <em>: None | <a href="#datahub.metadata.schema_classes.IncrementingSegmentRowCountChangeClass">IncrementingSegmentRowCountChangeClass</a></em><a href="#property-incrementingsegmentrowcountchange--none--incrementingsegmentrowcountchangeclass" class="hash-link" aria-label="Direct link to property-incrementingsegmentrowcountchange--none--incrementingsegmentrowcountchangeclass" title="Direct link to property-incrementingsegmentrowcountchange--none--incrementingsegmentrowcountchangeclass"></a></h4><p>Produce FAILURE Assertion Result if the asset’s incrementing segment row count delta
|
||
does not meet specific requirements. Required if type is ‘INCREMENTING_SEGMENT_ROW_COUNT_CHANGE’</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-incrementingsegmentrowcounttotal--none--incrementingsegmentrowcounttotalclass"><em>property</em> incrementingSegmentRowCountTotal <em>: None | <a href="#datahub.metadata.schema_classes.IncrementingSegmentRowCountTotalClass">IncrementingSegmentRowCountTotalClass</a></em><a href="#property-incrementingsegmentrowcounttotal--none--incrementingsegmentrowcounttotalclass" class="hash-link" aria-label="Direct link to property-incrementingsegmentrowcounttotal--none--incrementingsegmentrowcounttotalclass" title="Direct link to property-incrementingsegmentrowcounttotal--none--incrementingsegmentrowcounttotalclass"></a></h4><p>Produce FAILURE Assertion Result if the asset’s latest incrementing segment row count total
|
||
does not meet specific requirements. Required if type is ‘INCREMENTING_SEGMENT_ROW_COUNT_TOTAL’</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-rowcountchange--none--rowcountchangeclass"><em>property</em> rowCountChange <em>: None | <a href="#datahub.metadata.schema_classes.RowCountChangeClass">RowCountChangeClass</a></em><a href="#property-rowcountchange--none--rowcountchangeclass" class="hash-link" aria-label="Direct link to property-rowcountchange--none--rowcountchangeclass" title="Direct link to property-rowcountchange--none--rowcountchangeclass"></a></h4><p>Produce FAILURE Assertion Result if the delta row count of the asset does not meet specific requirements
|
||
within a given period of time.
|
||
Required if type is ‘ROW_COUNT_CHANGE’</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-rowcounttotal--none--rowcounttotalclass"><em>property</em> rowCountTotal <em>: None | <a href="#datahub.metadata.schema_classes.RowCountTotalClass">RowCountTotalClass</a></em><a href="#property-rowcounttotal--none--rowcounttotalclass" class="hash-link" aria-label="Direct link to property-rowcounttotal--none--rowcounttotalclass" title="Direct link to property-rowcounttotal--none--rowcounttotalclass"></a></h4><p>Produce FAILURE Assertion Result if the row count of the asset does not meet specific requirements.
|
||
Required if type is ‘ROW_COUNT_TOTAL’</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-type--str--volumeassertiontypeclass"><em>property</em> type <em>: str | <a href="#datahub.metadata.schema_classes.VolumeAssertionTypeClass">VolumeAssertionTypeClass</a></em><a href="#property-type--str--volumeassertiontypeclass" class="hash-link" aria-label="Direct link to property-type--str--volumeassertiontypeclass" title="Direct link to property-type--str--volumeassertiontypeclass"></a></h4><p>The type of the volume assertion being monitored.</p></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.VolumeAssertionTypeClass"><span class="visually-hidden">VolumeAssertionTypeClass</span><a href="#datahub.metadata.schema_classes.VolumeAssertionTypeClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.VolumeAssertionTypeClass" title="Direct link to datahub.metadata.schema_classes.VolumeAssertionTypeClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">VolumeAssertionTypeClass</span>()<a href="#datahub.metadata.schema_classes.VolumeAssertionTypeClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="incrementing_segment_row_count_change--incrementing_segment_row_count_change">INCREMENTING_SEGMENT_ROW_COUNT_CHANGE <em>= 'INCREMENTING_SEGMENT_ROW_COUNT_CHANGE'</em><a href="#incrementing_segment_row_count_change--incrementing_segment_row_count_change" class="hash-link" aria-label="Direct link to incrementing_segment_row_count_change--incrementing_segment_row_count_change" title="Direct link to incrementing_segment_row_count_change--incrementing_segment_row_count_change"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="incrementing_segment_row_count_total--incrementing_segment_row_count_total">INCREMENTING_SEGMENT_ROW_COUNT_TOTAL <em>= 'INCREMENTING_SEGMENT_ROW_COUNT_TOTAL'</em><a href="#incrementing_segment_row_count_total--incrementing_segment_row_count_total" class="hash-link" aria-label="Direct link to incrementing_segment_row_count_total--incrementing_segment_row_count_total" title="Direct link to incrementing_segment_row_count_total--incrementing_segment_row_count_total"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="row_count_change--row_count_change">ROW_COUNT_CHANGE <em>= 'ROW_COUNT_CHANGE'</em><a href="#row_count_change--row_count_change" class="hash-link" aria-label="Direct link to row_count_change--row_count_change" title="Direct link to row_count_change--row_count_change"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="row_count_total--row_count_total">ROW_COUNT_TOTAL <em>= 'ROW_COUNT_TOTAL'</em><a href="#row_count_total--row_count_total" class="hash-link" aria-label="Direct link to row_count_total--row_count_total" title="Direct link to row_count_total--row_count_total"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.WindowDurationClass"><span class="visually-hidden">WindowDurationClass</span><a href="#datahub.metadata.schema_classes.WindowDurationClass" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.WindowDurationClass" title="Direct link to datahub.metadata.schema_classes.WindowDurationClass"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">WindowDurationClass</span>()<a href="#datahub.metadata.schema_classes.WindowDurationClass" class="hash-link"></a></div><p>Bases: <code>object</code></p><p>Enum to define the length of a bucket when doing aggregations</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="day--day-1">DAY <em>= 'DAY'</em><a href="#day--day-1" class="hash-link" aria-label="Direct link to day--day-1" title="Direct link to day--day-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="hour--hour-1">HOUR <em>= 'HOUR'</em><a href="#hour--hour-1" class="hash-link" aria-label="Direct link to hour--hour-1" title="Direct link to hour--hour-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="month--month-1">MONTH <em>= 'MONTH'</em><a href="#month--month-1" class="hash-link" aria-label="Direct link to month--month-1" title="Direct link to month--month-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="week--week-1">WEEK <em>= 'WEEK'</em><a href="#week--week-1" class="hash-link" aria-label="Direct link to week--week-1" title="Direct link to week--week-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="year--year-1">YEAR <em>= 'YEAR'</em><a href="#year--year-1" class="hash-link" aria-label="Direct link to year--year-1" title="Direct link to year--year-1"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.metadata.schema_classes.get_schema_type"><span class="visually-hidden">get_schema_type</span><a href="#datahub.metadata.schema_classes.get_schema_type" class="hash-link" aria-label="Direct link to datahub.metadata.schema_classes.get_schema_type" title="Direct link to datahub.metadata.schema_classes.get_schema_type"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-owner">datahub.metadata.schema_classes.</span><span class="class-name">get_schema_type</span>(<span class="arg-name">fullname</span>)<a href="#datahub.metadata.schema_classes.get_schema_type" class="hash-link"></a></div><ul><li><strong>Parameters:</strong><strong>fullname</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>RecordSchema</code></li></ul></div></div></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=python-sdk/models">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/python-sdk/models.mdx" 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/python-sdk/sdk-v2/search-client"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Search Client</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/python-sdk/urns"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">URNs</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="#datahub.metadata.schema_classes.AccessClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AccessClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AccessLevelClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AccessLevelClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ActorsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ActorsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ApplicationKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ApplicationKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ApplicationPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ApplicationPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ApplicationsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ApplicationsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ArrayTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ArrayTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AspectBag" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AspectBag</span></a></li><li><a href="#datahub.metadata.schema_classes.AssertionActionClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AssertionActionClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AssertionActionTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AssertionActionTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AssertionActionsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AssertionActionsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AssertionInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AssertionInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AssertionKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AssertionKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AssertionResultClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AssertionResultClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AssertionResultErrorClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AssertionResultErrorClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AssertionResultErrorTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AssertionResultErrorTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AssertionResultTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AssertionResultTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AssertionRunEventClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AssertionRunEventClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AssertionRunStatusClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AssertionRunStatusClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AssertionSourceClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AssertionSourceClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AssertionSourceTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AssertionSourceTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AssertionStdAggregationClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AssertionStdAggregationClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AssertionStdOperatorClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AssertionStdOperatorClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AssertionStdParameterClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AssertionStdParameterClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AssertionStdParameterTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AssertionStdParameterTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AssertionStdParametersClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AssertionStdParametersClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AssertionTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AssertionTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AssertionValueChangeTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AssertionValueChangeTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AuditStampClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AuditStampClass</span></a></li><li><a href="#datahub.metadata.schema_classes.AzkabanJobTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">AzkabanJobTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.BaseDataClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">BaseDataClass</span></a></li><li><a href="#datahub.metadata.schema_classes.BatchSpecClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">BatchSpecClass</span></a></li><li><a href="#datahub.metadata.schema_classes.BinaryJsonSchemaClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">BinaryJsonSchemaClass</span></a></li><li><a href="#datahub.metadata.schema_classes.BooleanTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">BooleanTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.BrowsePathEntryClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">BrowsePathEntryClass</span></a></li><li><a href="#datahub.metadata.schema_classes.BrowsePathsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">BrowsePathsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.BrowsePathsV2Class" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">BrowsePathsV2Class</span></a></li><li><a href="#datahub.metadata.schema_classes.BusinessAttributeAssociationClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">BusinessAttributeAssociationClass</span></a></li><li><a href="#datahub.metadata.schema_classes.BusinessAttributeInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">BusinessAttributeInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.BusinessAttributeKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">BusinessAttributeKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.BusinessAttributesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">BusinessAttributesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.BytesTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">BytesTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CalendarIntervalClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CalendarIntervalClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CaveatDetailsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CaveatDetailsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CaveatsAndRecommendationsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CaveatsAndRecommendationsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ChangeAuditStampsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ChangeAuditStampsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ChangeTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ChangeTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ChartCellClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ChartCellClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ChartInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ChartInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ChartKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ChartKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ChartQueryClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ChartQueryClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ChartQueryTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ChartQueryTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ChartSnapshotClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ChartSnapshotClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ChartTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ChartTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ChartUsageStatisticsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ChartUsageStatisticsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ChartUserUsageCountsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ChartUserUsageCountsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ConditionClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ConditionClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ConjunctiveCriterionClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ConjunctiveCriterionClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ContainerClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ContainerClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ContainerKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ContainerKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ContainerPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ContainerPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CorpGroupEditableInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CorpGroupEditableInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CorpGroupInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CorpGroupInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CorpGroupKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CorpGroupKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CorpGroupSnapshotClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CorpGroupSnapshotClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CorpUserAppearanceSettingsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CorpUserAppearanceSettingsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CorpUserCredentialsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CorpUserCredentialsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CorpUserEditableInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CorpUserEditableInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CorpUserHomePageSettingsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CorpUserHomePageSettingsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CorpUserInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CorpUserInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CorpUserKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CorpUserKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CorpUserSettingsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CorpUserSettingsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CorpUserSnapshotClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CorpUserSnapshotClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CorpUserStatusClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CorpUserStatusClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CorpUserViewsSettingsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CorpUserViewsSettingsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CostClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CostClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CostCostClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CostCostClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CostCostDiscriminatorClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CostCostDiscriminatorClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CostTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CostTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CriterionClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CriterionClass</span></a></li><li><a href="#datahub.metadata.schema_classes.CustomAssertionInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">CustomAssertionInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DashboardInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DashboardInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DashboardKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DashboardKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DashboardSnapshotClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DashboardSnapshotClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DashboardUsageStatisticsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DashboardUsageStatisticsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DashboardUserUsageCountsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DashboardUserUsageCountsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataContractKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataContractKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataContractPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataContractPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataContractStateClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataContractStateClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataContractStatusClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataContractStatusClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataFlowInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataFlowInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataFlowKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataFlowKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataFlowSnapshotClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataFlowSnapshotClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubAccessTokenInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubAccessTokenInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubAccessTokenKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubAccessTokenKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubActionKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubActionKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubActorFilterClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubActorFilterClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubConnectionDetailsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubConnectionDetailsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubConnectionDetailsTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubConnectionDetailsTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubConnectionKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubConnectionKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubIngestionSourceConfigClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubIngestionSourceConfigClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubIngestionSourceInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubIngestionSourceInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubIngestionSourceKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubIngestionSourceKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubIngestionSourceScheduleClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubIngestionSourceScheduleClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubIngestionSourceSourceClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubIngestionSourceSourceClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubIngestionSourceSourceTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubIngestionSourceSourceTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubJsonConnectionClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubJsonConnectionClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubOpenAPISchemaKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubOpenAPISchemaKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubPageModuleKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubPageModuleKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubPageModuleParamsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubPageModuleParamsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubPageModulePropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubPageModulePropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubPageModuleTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubPageModuleTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubPageModuleVisibilityClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubPageModuleVisibilityClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubPageTemplateKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubPageTemplateKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubPageTemplatePropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubPageTemplatePropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubPageTemplateRowClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubPageTemplateRowClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubPageTemplateSurfaceClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubPageTemplateSurfaceClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubPageTemplateVisibilityClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubPageTemplateVisibilityClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubPersonaInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubPersonaInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubPersonaKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubPersonaKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubPolicyInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubPolicyInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubPolicyKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubPolicyKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubPolicySnapshotClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubPolicySnapshotClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubResourceFilterClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubResourceFilterClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubRetentionConfigClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubRetentionConfigClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubRetentionKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubRetentionKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubRetentionSnapshotClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubRetentionSnapshotClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubRoleInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubRoleInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubRoleKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubRoleKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubSearchConfigClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubSearchConfigClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubSecretKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubSecretKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubSecretValueClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubSecretValueClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubStepStateKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubStepStateKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubStepStatePropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubStepStatePropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubUpgradeKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubUpgradeKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubUpgradeRequestClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubUpgradeRequestClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubUpgradeResultClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubUpgradeResultClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubUpgradeStateClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubUpgradeStateClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubViewDefinitionClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubViewDefinitionClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubViewInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubViewInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubViewKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubViewKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataHubViewTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataHubViewTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataJobInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataJobInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataJobInputOutputClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataJobInputOutputClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataJobKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataJobKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataJobSnapshotClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataJobSnapshotClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataPlatformInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataPlatformInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataPlatformInstanceClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataPlatformInstanceKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataPlatformInstanceKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataPlatformInstancePropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataPlatformInstancePropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataPlatformKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataPlatformKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataPlatformSnapshotClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataPlatformSnapshotClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataProcessInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataProcessInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataProcessInstanceInputClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataProcessInstanceInputClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataProcessInstanceKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataProcessInstanceKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataProcessInstanceOutputClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataProcessInstanceOutputClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataProcessInstancePropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataProcessInstancePropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataProcessInstanceRelationshipsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataProcessInstanceRelationshipsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataProcessInstanceRunEventClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataProcessInstanceRunEventClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataProcessInstanceRunResultClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataProcessInstanceRunResultClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataProcessKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataProcessKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataProcessRunStatusClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataProcessRunStatusClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataProcessSnapshotClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataProcessSnapshotClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataProcessTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataProcessTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataProductAssociationClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataProductAssociationClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataProductKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataProductKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataProductPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataProductPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataQualityContractClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataQualityContractClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataTransformClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataTransformClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataTransformLogicClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataTransformLogicClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataTypeInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataTypeInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DataTypeKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataTypeKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DatahubIngestionCheckpointClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DatahubIngestionCheckpointClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DatahubIngestionRunSummaryClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DatasetAssertionInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DatasetAssertionInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DatasetAssertionScopeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DatasetAssertionScopeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DatasetDeprecationClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DatasetDeprecationClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DatasetFieldForeignKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DatasetFieldForeignKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DatasetFieldMappingClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DatasetFieldMappingClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DatasetFieldProfileClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DatasetFieldProfileClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DatasetFieldUsageCountsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DatasetFieldUsageCountsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DatasetFilterClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DatasetFilterClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DatasetFilterTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DatasetFilterTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DatasetKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DatasetKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DatasetLineageTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DatasetLineageTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DatasetProfileClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DatasetProfileClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DatasetPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DatasetPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DatasetSnapshotClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DatasetSnapshotClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DatasetUpstreamLineageClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DatasetUpstreamLineageClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DatasetUsageStatisticsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DatasetUsageStatisticsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DatasetUserUsageCountsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DatasetUserUsageCountsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DateTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DateTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DeploymentStatusClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DeploymentStatusClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DeprecationClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DeprecationClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DisplayPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DisplayPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DocPropagationFeatureSettingsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DocPropagationFeatureSettingsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DocumentationAssociationClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DocumentationAssociationClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DocumentationClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DocumentationClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DomainKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DomainKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DomainPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DomainPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DomainsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DomainsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.DynamicFormAssignmentClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DynamicFormAssignmentClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ERModelRelationshipCardinalityClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ERModelRelationshipCardinalityClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ERModelRelationshipKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ERModelRelationshipKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ERModelRelationshipPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ERModelRelationshipPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EdgeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EdgeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EditableChartPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EditableChartPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EditableContainerPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EditableContainerPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EditableDashboardPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EditableDashboardPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EditableDataFlowPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EditableDataFlowPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EditableDataJobPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EditableDataJobPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EditableDatasetPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EditableDatasetPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EditableERModelRelationshipPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EditableERModelRelationshipPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EditableMLFeaturePropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EditableMLFeaturePropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EditableMLFeatureTablePropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EditableMLFeatureTablePropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EditableMLModelGroupPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EditableMLModelGroupPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EditableMLModelPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EditableMLModelPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EditableMLPrimaryKeyPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EditableMLPrimaryKeyPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EditableNotebookPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EditableNotebookPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EditableSchemaFieldInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EditableSchemaFieldInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EditableSchemaMetadataClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EditableSchemaMetadataClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EmailNotificationSettingsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EmailNotificationSettingsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EmbedClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EmbedClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EntityChangeEventClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EntityChangeEventClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EntityTypeInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EntityTypeInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EntityTypeKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EntityTypeKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EnumTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EnumTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EspressoSchemaClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EspressoSchemaClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EthicalConsiderationsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EthicalConsiderationsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.EvaluationDataClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">EvaluationDataClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ExecutionRequestInputClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ExecutionRequestInputClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ExecutionRequestKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ExecutionRequestKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ExecutionRequestResultClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ExecutionRequestResultClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ExecutionRequestSignalClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ExecutionRequestSignalClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ExecutionRequestSourceClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ExecutionRequestSourceClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FabricTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FabricTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FieldAssertionInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FieldAssertionInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FieldAssertionTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FieldAssertionTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FieldFormPromptAssociationClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FieldFormPromptAssociationClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FieldMetricAssertionClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FieldMetricAssertionClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FieldMetricTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FieldMetricTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FieldTransformClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FieldTransformClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FieldTransformTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FieldTransformTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FieldUsageCountsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FieldUsageCountsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FieldValuesAssertionClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FieldValuesAssertionClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FieldValuesFailThresholdClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FieldValuesFailThresholdClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FieldValuesFailThresholdTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FieldValuesFailThresholdTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FilterClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FilterClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FineGrainedLineageClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FineGrainedLineageClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FineGrainedLineageDownstreamTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FineGrainedLineageDownstreamTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FineGrainedLineageUpstreamTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FineGrainedLineageUpstreamTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FixedIntervalScheduleClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FixedIntervalScheduleClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FixedTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FixedTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ForeignKeyConstraintClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ForeignKeyConstraintClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ForeignKeySpecClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ForeignKeySpecClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FormActorAssignmentClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FormActorAssignmentClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FormAssociationClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FormAssociationClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FormInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FormInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FormKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FormKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FormPromptAssociationClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FormPromptAssociationClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FormPromptClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FormPromptClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FormPromptFieldAssociationsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FormPromptFieldAssociationsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FormPromptTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FormPromptTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FormTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FormTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FormVerificationAssociationClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FormVerificationAssociationClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FormsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FormsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FreshnessAssertionInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FreshnessAssertionInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FreshnessAssertionScheduleClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FreshnessAssertionScheduleClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FreshnessAssertionScheduleTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FreshnessAssertionScheduleTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FreshnessAssertionTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FreshnessAssertionTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FreshnessContractClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FreshnessContractClass</span></a></li><li><a href="#datahub.metadata.schema_classes.FreshnessCronScheduleClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">FreshnessCronScheduleClass</span></a></li><li><a href="#datahub.metadata.schema_classes.GenericAspectClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">GenericAspectClass</span></a></li><li><a href="#datahub.metadata.schema_classes.GenericPayloadClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">GenericPayloadClass</span></a></li><li><a href="#datahub.metadata.schema_classes.GlobalHomePageSettingsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">GlobalHomePageSettingsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.GlobalSettingsInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">GlobalSettingsInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.GlobalSettingsKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">GlobalSettingsKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.GlobalTagsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">GlobalTagsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.GlobalViewsSettingsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">GlobalViewsSettingsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.GlossaryNodeInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">GlossaryNodeInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.GlossaryNodeKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">GlossaryNodeKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.GlossaryNodeSnapshotClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">GlossaryNodeSnapshotClass</span></a></li><li><a href="#datahub.metadata.schema_classes.GlossaryRelatedTermsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">GlossaryRelatedTermsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.GlossaryTermAssociationClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">GlossaryTermAssociationClass</span></a></li><li><a href="#datahub.metadata.schema_classes.GlossaryTermInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">GlossaryTermInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.GlossaryTermKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">GlossaryTermKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.GlossaryTermSnapshotClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">GlossaryTermSnapshotClass</span></a></li><li><a href="#datahub.metadata.schema_classes.GlossaryTermsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">GlossaryTermsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.GroupMembershipClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">GroupMembershipClass</span></a></li><li><a href="#datahub.metadata.schema_classes.HistogramClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">HistogramClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IcebergCatalogInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IcebergCatalogInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IcebergWarehouseInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IcebergWarehouseInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IconLibraryClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IconLibraryClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IconPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IconPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IncidentAssigneeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IncidentAssigneeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IncidentInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IncidentInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IncidentKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IncidentKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IncidentSourceClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IncidentSourceClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IncidentSourceTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IncidentSourceTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IncidentStageClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IncidentStageClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IncidentStateClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IncidentStateClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IncidentStatusClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IncidentStatusClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IncidentSummaryDetailsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IncidentSummaryDetailsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IncidentTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IncidentTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IncidentsSummaryClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IncidentsSummaryClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IncrementingSegmentFieldTransformerClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IncrementingSegmentFieldTransformerTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IncrementingSegmentRowCountChangeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IncrementingSegmentRowCountChangeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IncrementingSegmentRowCountTotalClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IncrementingSegmentRowCountTotalClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IncrementingSegmentSpecClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IncrementingSegmentSpecClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IngestionCheckpointStateClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IngestionCheckpointStateClass</span></a></li><li><a href="#datahub.metadata.schema_classes.InputFieldClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">InputFieldClass</span></a></li><li><a href="#datahub.metadata.schema_classes.InputFieldsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">InputFieldsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.InstitutionalMemoryClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">InstitutionalMemoryClass</span></a></li><li><a href="#datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">InstitutionalMemoryMetadataClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IntendedUseClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IntendedUseClass</span></a></li><li><a href="#datahub.metadata.schema_classes.IntendedUserTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">IntendedUserTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.InviteTokenClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">InviteTokenClass</span></a></li><li><a href="#datahub.metadata.schema_classes.InviteTokenKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">InviteTokenKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.JobStatusClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">JobStatusClass</span></a></li><li><a href="#datahub.metadata.schema_classes.KafkaAuditHeaderClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">KafkaAuditHeaderClass</span></a></li><li><a href="#datahub.metadata.schema_classes.KafkaSchemaClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">KafkaSchemaClass</span></a></li><li><a href="#datahub.metadata.schema_classes.KeyValueSchemaClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">KeyValueSchemaClass</span></a></li><li><a href="#datahub.metadata.schema_classes.LinkModuleParamsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">LinkModuleParamsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLFeatureDataTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLFeatureDataTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLFeatureKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLFeatureKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLFeaturePropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLFeaturePropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLFeatureSnapshotClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLFeatureSnapshotClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLFeatureTableKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLFeatureTableKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLFeatureTablePropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLFeatureTablePropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLFeatureTableSnapshotClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLFeatureTableSnapshotClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLHyperParamClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLHyperParamClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLMetricClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLMetricClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLModelDeploymentKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLModelDeploymentKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLModelDeploymentPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLModelDeploymentPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLModelDeploymentSnapshotClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLModelDeploymentSnapshotClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLModelFactorPromptsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLModelFactorPromptsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLModelFactorsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLModelFactorsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLModelGroupKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLModelGroupKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLModelGroupPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLModelGroupPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLModelGroupSnapshotClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLModelGroupSnapshotClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLModelKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLModelKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLModelPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLModelPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLModelSnapshotClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLModelSnapshotClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLPrimaryKeyKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLPrimaryKeyKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLPrimaryKeyPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLPrimaryKeyPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLPrimaryKeySnapshotClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLPrimaryKeySnapshotClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MLTrainingRunPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLTrainingRunPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MapTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MapTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MediaClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MediaClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MediaTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MediaTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MetadataAttributionClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MetadataAttributionClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MetadataChangeEventClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MetadataChangeEventClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MetadataChangeLogClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MetadataChangeLogClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MetadataChangeProposalClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MetadataChangeProposalClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MetricsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MetricsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.MySqlDDLClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MySqlDDLClass</span></a></li><li><a href="#datahub.metadata.schema_classes.NativeGroupMembershipClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">NativeGroupMembershipClass</span></a></li><li><a href="#datahub.metadata.schema_classes.NotebookCellClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">NotebookCellClass</span></a></li><li><a href="#datahub.metadata.schema_classes.NotebookCellTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">NotebookCellTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.NotebookContentClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">NotebookContentClass</span></a></li><li><a href="#datahub.metadata.schema_classes.NotebookInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">NotebookInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.NotebookKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">NotebookKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.NotificationSettingsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">NotificationSettingsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.NotificationSinkTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">NotificationSinkTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.NullTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">NullTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.NumberTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">NumberTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.OidcSettingsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">OidcSettingsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.OperationClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">OperationClass</span></a></li><li><a href="#datahub.metadata.schema_classes.OperationSourceTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">OperationSourceTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.OperationTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">OperationTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.OracleDDLClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">OracleDDLClass</span></a></li><li><a href="#datahub.metadata.schema_classes.OrcSchemaClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">OrcSchemaClass</span></a></li><li><a href="#datahub.metadata.schema_classes.OriginClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">OriginClass</span></a></li><li><a href="#datahub.metadata.schema_classes.OriginTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">OriginTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.OtherSchemaClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">OtherSchemaClass</span></a></li><li><a href="#datahub.metadata.schema_classes.OwnerClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">OwnerClass</span></a></li><li><a href="#datahub.metadata.schema_classes.OwnershipClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">OwnershipClass</span></a></li><li><a href="#datahub.metadata.schema_classes.OwnershipSourceClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">OwnershipSourceClass</span></a></li><li><a href="#datahub.metadata.schema_classes.OwnershipSourceTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">OwnershipSourceTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.OwnershipTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">OwnershipTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.OwnershipTypeInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">OwnershipTypeInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.OwnershipTypeKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">OwnershipTypeKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PageModuleScopeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PageModuleScopeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PageTemplateScopeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PageTemplateScopeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PageTemplateSurfaceTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PageTemplateSurfaceTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ParametersClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ParametersClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PartitionSpecClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PartitionSpecClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PartitionSummaryClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PartitionSummaryClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PartitionTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PartitionTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PartitionsSummaryClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PartitionsSummaryClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PlatformEventClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PlatformEventClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PlatformEventHeaderClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PlatformEventHeaderClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PlatformResourceInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PlatformResourceInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PlatformResourceKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PlatformResourceKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PlatformTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PlatformTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PolicyMatchConditionClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PolicyMatchConditionClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PolicyMatchCriterionClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PolicyMatchCriterionClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PolicyMatchFilterClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PolicyMatchFilterClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PostContentClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PostContentClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PostContentTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PostContentTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PostInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PostInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PostKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PostKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PostTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PostTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PrestoDDLClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PrestoDDLClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PropertyCardinalityClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PropertyCardinalityClass</span></a></li><li><a href="#datahub.metadata.schema_classes.PropertyValueClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">PropertyValueClass</span></a></li><li><a href="#datahub.metadata.schema_classes.QuantileClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">QuantileClass</span></a></li><li><a href="#datahub.metadata.schema_classes.QuantitativeAnalysesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">QuantitativeAnalysesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.QueryCellClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">QueryCellClass</span></a></li><li><a href="#datahub.metadata.schema_classes.QueryKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">QueryKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.QueryLanguageClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">QueryLanguageClass</span></a></li><li><a href="#datahub.metadata.schema_classes.QueryPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">QueryPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.QuerySourceClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">QuerySourceClass</span></a></li><li><a href="#datahub.metadata.schema_classes.QueryStatementClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">QueryStatementClass</span></a></li><li><a href="#datahub.metadata.schema_classes.QuerySubjectClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">QuerySubjectClass</span></a></li><li><a href="#datahub.metadata.schema_classes.QuerySubjectsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">QuerySubjectsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.QueryUsageStatisticsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">QueryUsageStatisticsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.RecordTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">RecordTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.RelationshipFieldMappingClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">RelationshipFieldMappingClass</span></a></li><li><a href="#datahub.metadata.schema_classes.RetentionClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">RetentionClass</span></a></li><li><a href="#datahub.metadata.schema_classes.RichTextModuleParamsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">RichTextModuleParamsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.RoleAssociationClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">RoleAssociationClass</span></a></li><li><a href="#datahub.metadata.schema_classes.RoleKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">RoleKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.RoleMembershipClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">RoleMembershipClass</span></a></li><li><a href="#datahub.metadata.schema_classes.RolePropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">RolePropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.RoleUserClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">RoleUserClass</span></a></li><li><a href="#datahub.metadata.schema_classes.RowCountChangeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">RowCountChangeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.RowCountTotalClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">RowCountTotalClass</span></a></li><li><a href="#datahub.metadata.schema_classes.RunResultTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">RunResultTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SchemaAssertionCompatibilityClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SchemaAssertionCompatibilityClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SchemaAssertionInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SchemaAssertionInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SchemaContractClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SchemaContractClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SchemaFieldAliasesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SchemaFieldAliasesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SchemaFieldClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SchemaFieldClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SchemaFieldDataTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SchemaFieldDataTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SchemaFieldInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SchemaFieldInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SchemaFieldKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SchemaFieldKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SchemaFieldSnapshotClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SchemaFieldSnapshotClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SchemaFieldSpecClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SchemaFieldSpecClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SchemaMetadataClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SchemaMetadataClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SchemalessClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SchemalessClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SearchFieldTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SearchFieldTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SerializedValueClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SerializedValueClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SerializedValueContentTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SerializedValueContentTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SerializedValueSchemaTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SerializedValueSchemaTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SiblingsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SiblingsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SlackNotificationSettingsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SlackNotificationSettingsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SlackUserInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SlackUserInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SourceCodeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SourceCodeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SourceCodeUrlClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SourceCodeUrlClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SourceCodeUrlTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SourceCodeUrlTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SqlAssertionInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SqlAssertionInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SqlAssertionTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SqlAssertionTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SsoSettingsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SsoSettingsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.StatusClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">StatusClass</span></a></li><li><a href="#datahub.metadata.schema_classes.StringTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">StringTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.StructuredExecutionReportClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">StructuredExecutionReportClass</span></a></li><li><a href="#datahub.metadata.schema_classes.StructuredPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">StructuredPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.StructuredPropertyDefinitionClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">StructuredPropertyDefinitionClass</span></a></li><li><a href="#datahub.metadata.schema_classes.StructuredPropertyKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">StructuredPropertyKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.StructuredPropertyParamsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">StructuredPropertyParamsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.StructuredPropertySettingsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">StructuredPropertySettingsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.StructuredPropertyValueAssignmentClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">StructuredPropertyValueAssignmentClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SubTypesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SubTypesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.SystemMetadataClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SystemMetadataClass</span></a></li><li><a href="#datahub.metadata.schema_classes.TagAssociationClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">TagAssociationClass</span></a></li><li><a href="#datahub.metadata.schema_classes.TagKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">TagKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.TagPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">TagPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.TagSnapshotClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">TagSnapshotClass</span></a></li><li><a href="#datahub.metadata.schema_classes.TelemetryClientIdClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">TelemetryClientIdClass</span></a></li><li><a href="#datahub.metadata.schema_classes.TelemetryKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">TelemetryKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.TestDefinitionClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">TestDefinitionClass</span></a></li><li><a href="#datahub.metadata.schema_classes.TestDefinitionTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">TestDefinitionTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.TestInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">TestInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.TestKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">TestKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.TestResultClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">TestResultClass</span></a></li><li><a href="#datahub.metadata.schema_classes.TestResultTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">TestResultTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.TestResultsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">TestResultsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.TextCellClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">TextCellClass</span></a></li><li><a href="#datahub.metadata.schema_classes.TimeBasedRetentionClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">TimeBasedRetentionClass</span></a></li><li><a href="#datahub.metadata.schema_classes.TimeStampClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">TimeStampClass</span></a></li><li><a href="#datahub.metadata.schema_classes.TimeTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">TimeTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.TimeWindowClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">TimeWindowClass</span></a></li><li><a href="#datahub.metadata.schema_classes.TimeWindowSizeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">TimeWindowSizeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.TrainingDataClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">TrainingDataClass</span></a></li><li><a href="#datahub.metadata.schema_classes.TransformationTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">TransformationTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.UDFTransformerClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">UDFTransformerClass</span></a></li><li><a href="#datahub.metadata.schema_classes.UnionTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">UnionTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.UpstreamClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">UpstreamClass</span></a></li><li><a href="#datahub.metadata.schema_classes.UpstreamLineageClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">UpstreamLineageClass</span></a></li><li><a href="#datahub.metadata.schema_classes.UrnForeignKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">UrnForeignKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.UsageAggregationClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">UsageAggregationClass</span></a></li><li><a href="#datahub.metadata.schema_classes.UsageAggregationMetricsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">UsageAggregationMetricsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.UserUsageCountsClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">UserUsageCountsClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ValueFrequencyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ValueFrequencyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.VersionBasedRetentionClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">VersionBasedRetentionClass</span></a></li><li><a href="#datahub.metadata.schema_classes.VersionInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">VersionInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.VersionPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">VersionPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.VersionSetKeyClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">VersionSetKeyClass</span></a></li><li><a href="#datahub.metadata.schema_classes.VersionSetPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">VersionSetPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.VersionTagClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">VersionTagClass</span></a></li><li><a href="#datahub.metadata.schema_classes.VersioningSchemeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">VersioningSchemeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.ViewPropertiesClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">ViewPropertiesClass</span></a></li><li><a href="#datahub.metadata.schema_classes.VolumeAssertionInfoClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">VolumeAssertionInfoClass</span></a></li><li><a href="#datahub.metadata.schema_classes.VolumeAssertionTypeClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">VolumeAssertionTypeClass</span></a></li><li><a href="#datahub.metadata.schema_classes.WindowDurationClass" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">WindowDurationClass</span></a></li><li><a href="#datahub.metadata.schema_classes.get_schema_type" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">get_schema_type</span></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.50e13f51.js"></script>
|
||
<script src="/assets/js/main.edc0853c.js"></script>
|
||
</body>
|
||
</html> |