mirror of
https://github.com/datahub-project/datahub.git
synced 2025-07-07 01:00:41 +00:00
387 lines
1.6 MiB
HTML
387 lines
1.6 MiB
HTML
|
<!doctype html>
|
|||
|
|
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-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--subli
|
|||
|
|
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 assertio
|
|||
|
|
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</spa
|
|||
|
|
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">PartitionSpecClas
|
|||
|
|
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="anc
|
|||
|
|
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
|
|||
|
|
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>Op
|
|||
|
|
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="p
|
|||
|
|
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_clas
|
|||
|
|
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 propert
|
|||
|
|
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 sup
|
|||
|
|
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-owne
|
|||
|
|
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"
|
|||
|
|
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="prope
|
|||
|
|
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_classe
|
|||
|
|
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
|
|||
|
|
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">DashboardSnapsho
|
|||
|
|
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 hr
|
|||
|
|
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>Di
|
|||
|
|
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
|
|||
|
|
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-lin
|
|||
|
|
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" c
|
|||
|
|
*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--owner
|
|||
|
|
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-labe
|
|||
|
|
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
|
|||
|
|
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
|
|||
|
|
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>C
|
|||
|
|
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 hre
|
|||
|
|
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-n
|
|||
|
|
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> =
|
|||
|
|
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.m
|
|||
|
|
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 anchorWithSti
|
|||
|
|
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 variou
|
|||
|
|
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">O
|
|||
|
|
: 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--auditstampclas
|
|||
|
|
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">Non
|
|||
|
|
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> (<c
|
|||
|
|
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.EditableDat
|
|||
|
|
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.EditableDataJobPr
|
|||
|
|
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="a
|
|||
|
|
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
|
|||
|
|
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 c
|
|||
|
|
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
|
|||
|
|
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
|
|||
|
|
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="Dir
|
|||
|
|
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<
|
|||
|
|
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 a
|
|||
|
|
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--uniq
|
|||
|
|
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.FineGr
|
|||
|
|
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 dat
|
|||
|
|
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
|
|||
|
|
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
|
|||
|
|
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.FormPromp
|
|||
|
|
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--li
|
|||
|
|
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_INTER
|
|||
|
|
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 S
|
|||
|
|
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"
|
|||
|
|
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:
|
|||
|
|
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">Non
|
|||
|
|
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
|
|||
|
|
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 anchorWithStic
|
|||
|
|
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.sc
|
|||
|
|
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="ar
|
|||
|
|
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-li
|
|||
|
|
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
|
|||
|
|
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 o
|
|||
|
|
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="a
|
|||
|
|
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><
|
|||
|
|
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>audi
|
|||
|
|
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="#pr
|
|||
|
|
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.metadat
|
|||
|
|
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 b
|
|||
|
|
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
|
|||
|
|
(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>
|
|||
|
|
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></h
|
|||
|
|
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 an
|
|||
|
|
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</s
|
|||
|
|
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--st
|
|||
|
|
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>prope
|
|||
|
|
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.R
|
|||
|
|
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>
|
|||
|
|
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">No
|
|||
|
|
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>,
|
|||
|
|
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
|
|||
|
|
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>
|
|||
|
|
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" cla
|
|||
|
|
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
|
|||
|
|
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"
|
|||
|
|
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>show
|
|||
|
|
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" c
|
|||
|
|
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-s
|
|||
|
|
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>proper
|
|||
|
|
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-lin
|
|||
|
|
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> (<cod
|
|||
|
|
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>in
|
|||
|
|
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="
|
|||
|
|
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.
|
|||
|
|
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="Di
|
|||
|
|
<script src="/assets/js/runtime~main.50e13f51.js"></script>
|
|||
|
|
<script src="/assets/js/main.edc0853c.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|