mirror of
https://github.com/datahub-project/datahub.git
synced 2025-07-09 10:12:20 +00:00
158 lines
184 KiB
HTML
158 lines
184 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-python-sdk/sdk-v2/entities" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v2.4.3">
|
||
<title data-rh="true">Entities | 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/sdk-v2/entities"><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="Entities | DataHub"><meta data-rh="true" name="description" content="The DataHub SDK provides a set of entities that can be used to interact with DataHub’s metadata."><meta data-rh="true" property="og:description" content="The DataHub SDK provides a set of entities that can be used to interact with DataHub’s metadata."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.datahub.com/docs/python-sdk/sdk-v2/entities"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/python-sdk/sdk-v2/entities" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/python-sdk/sdk-v2/entities" 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.70c656f4.css">
|
||
<link rel="preload" href="/assets/js/runtime~main.985d5e64.js" as="script">
|
||
<link rel="preload" href="/assets/js/main.74c17b7b.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/sdk-v2/entities">Next</a></li><li><a class="dropdown__link" href="/docs/1.1.0/features">1.1.0</a></li><li><a class="dropdown__link" href="/docs/1.0.0/features">1.0.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/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-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/managed-datahub/managed-datahub-overview">DataHub Cloud</a><button aria-label="Toggle the collapsible sidebar category 'DataHub Cloud'" 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>Integrations</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/metadata-ingestion">Overview</a><button aria-label="Toggle the collapsible sidebar category 'Overview'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/metadata-ingestion/cli-ingestion">Quickstart Guides</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/metadata-ingestion/source_overview">Sources</a><button aria-label="Toggle the collapsible sidebar category 'Sources'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/metadata-ingestion/schedule_docs/intro">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>API & SDKs</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/metadata-modeling/metadata-model">DataHub's Open Metadata Standard</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/what-is-datahub/datahub-concepts">Concepts</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/metadata-standards">Metadata Standards</a><button aria-label="Toggle the collapsible sidebar category 'Metadata Standards'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/api/datahub-apis">APIs and SDKs Overview</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/api/graphql/overview">API</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/metadata-ingestion/as-a-library">Python SDK</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/metadata-ingestion/as-a-library">Python Emitter</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" tabindex="0" href="/docs/python-sdk/builder/mce-builder">SDK Reference</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/python-sdk/builder/mce-builder">Builder</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/python-sdk/clients/graph-client">Clients</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" tabindex="0" href="/docs/python-sdk/sdk-v2/entities">SDK V2</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/python-sdk/sdk-v2/entities">Entities</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/python-sdk/sdk-v2/entity-client">Entity Client</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/python-sdk/sdk-v2/lineage-client">Lineage Client</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/python-sdk/sdk-v2/main-client">Main Client</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/python-sdk/sdk-v2/resolver-client">Resolver Client</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/python-sdk/sdk-v2/search-client">Search Client</a></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/python-sdk/models">Models</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/python-sdk/urns">URNs</a></li></ul></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/metadata-integration/java/as-a-library">Java SDK</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/cli">DataHub CLI</a><button aria-label="Toggle the collapsible sidebar category 'DataHub CLI'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/act-on-metadata">DataHub Actions</a><button aria-label="Toggle the collapsible sidebar category 'DataHub Actions'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/api/tutorials/datasets">Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Admin</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/authentication">Authentication</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/authorization">Authorization</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/how/delete-metadata">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Deployment</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/category/deployment-guides">Deployment Guides</a><button aria-label="Toggle the collapsible sidebar category 'Deployment Guides'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/deploy/confluent-cloud">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Developers</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/architecture/architecture">Architecture</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/developers">Developing on DataHub</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/advanced/mcp-mcl">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Community</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/category/community">Community</a><button aria-label="Toggle the collapsible sidebar category 'Community'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/releases">Release History</a></div></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Python SDK</span><meta itemprop="position" content="1"></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">SDK Reference</span><meta itemprop="position" content="2"></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">SDK V2</span><meta itemprop="position" content="3"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Entities</span><meta itemprop="position" content="4"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: Next</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Entities</h1></header><div class="sphinx-api-docs"><a id="entities"></a><p>The DataHub SDK provides a set of entities that can be used to interact with DataHub’s metadata.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.sdk.dataset.Dataset"><span class="visually-hidden">Dataset</span><a href="#datahub.sdk.dataset.Dataset" class="hash-link" aria-label="Direct link to datahub.sdk.dataset.Dataset" title="Direct link to datahub.sdk.dataset.Dataset"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.sdk.dataset.</span><span class="class-name">Dataset</span>(*, <span class="arg-name">platform</span>, <span class="arg-name">name</span>, <span class="arg-name">platform_instance</span> = <span class="arg-default">None</span>, <span class="arg-name">env</span> = <span class="arg-default">'PROD'</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">display_name</span> = <span class="arg-default">None</span>, <span class="arg-name">qualified_name</span> = <span class="arg-default">None</span>, <span class="arg-name">external_url</span> = <span class="arg-default">None</span>, <span class="arg-name">custom_properties</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">last_modified</span> = <span class="arg-default">None</span>, <span class="arg-name">parent_container</span> = <span class="arg-default">Unset.token</span>, <span class="arg-name">subtype</span> = <span class="arg-default">None</span>, <span class="arg-name">owners</span> = <span class="arg-default">None</span>, <span class="arg-name">links</span> = <span class="arg-default">None</span>, <span class="arg-name">tags</span> = <span class="arg-default">None</span>, <span class="arg-name">terms</span> = <span class="arg-default">None</span>, <span class="arg-name">domain</span> = <span class="arg-default">None</span>, <span class="arg-name">schema</span> = <span class="arg-default">None</span>, <span class="arg-name">upstreams</span> = <span class="arg-default">None</span>, <span class="arg-name">structured_properties</span> = <span class="arg-default">None</span>, <span class="arg-name">extra_aspects</span> = <span class="arg-default">None</span>)<a href="#datahub.sdk.dataset.Dataset" class="hash-link"></a></div><p>Bases: <code>HasPlatformInstance</code>, <code>HasSubtype</code>, <code>HasContainer</code>, <code>HasOwnership</code>, <code>HasInstitutionalMemory</code>, <code>HasTags</code>, <code>HasTerms</code>, <code>HasDomain</code>, <code>HasStructuredProperties</code>, <code>Entity</code></p><p>Represents a dataset in DataHub.</p><p>A dataset represents a collection of data, such as a table, view, or file.
|
||
This class provides methods for managing dataset metadata including schema,
|
||
lineage, and various aspects like ownership, tags, and terms.</p><ul><li><strong>Parameters:</strong><ul><li><strong>platform</strong> (<em>str</em>)</li><li><strong>name</strong> (<em>str</em>)</li><li><strong>platform_instance</strong> (<em>Optional</em> <em>[<strong>str</strong>]</em>)</li><li><strong>env</strong> (<em>str</em>)</li><li><strong>description</strong> (<em>Optional</em> <em>[<strong>str</strong>]</em>)</li><li><strong>display_name</strong> (<em>Optional</em> <em>[<strong>str</strong>]</em>)</li><li><strong>qualified_name</strong> (<em>Optional</em> <em>[<strong>str</strong>]</em>)</li><li><strong>external_url</strong> (<em>Optional</em> <em>[<strong>str</strong>]</em>)</li><li><strong>custom_properties</strong> (<em>Optional</em> <em>[<strong>Dict</strong>[<strong>str</strong>,<strong>str</strong>]</em> <em>]</em>)</li><li><strong>created</strong> (<em>Optional</em> <em>[<strong>datetime</strong>]</em>)</li><li><strong>last_modified</strong> (<em>Optional</em> <em>[<strong>datetime</strong>]</em>)</li><li><strong>parent_container</strong> (<em>ParentContainerInputType</em> <em>|</em> <em>Unset</em>)</li><li><strong>subtype</strong> (<em>Optional</em> <em>[<strong>str</strong>]</em>)</li><li><strong>owners</strong> (<em>Optional</em> <em>[<strong>OwnersInputType</strong>]</em>)</li><li><strong>links</strong> (<em>Optional</em> <em>[<strong>LinksInputType</strong>]</em>)</li><li><strong>tags</strong> (<em>Optional</em> <em>[<strong>TagsInputType</strong>]</em>)</li><li><strong>terms</strong> (<em>Optional</em> <em>[<strong>TermsInputType</strong>]</em>)</li><li><strong>domain</strong> (<em>Optional</em> <em>[<strong>DomainInputType</strong>]</em>)</li><li><strong>schema</strong> (<em>Optional</em> <em>[<strong>SchemaFieldsInputType</strong>]</em>)</li><li><strong>upstreams</strong> (<em>Optional</em> <em>[<strong>models.UpstreamLineageClass</strong>]</em>)</li><li><strong>structured_properties</strong> (<em>Optional</em> <em>[<strong>StructuredPropertyInputType</strong>]</em>)</li><li><strong>extra_aspects</strong> (<em>ExtraAspectsType</em>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--datetime--none"><em>property</em> created <em>: datetime | None</em><a href="#property-created--datetime--none" class="hash-link" aria-label="Direct link to property-created--datetime--none" title="Direct link to property-created--datetime--none"></a></h4><p>Get the creation timestamp of the dataset.</p><ul><li><strong>Returns:</strong>
|
||
The creation timestamp if set, None otherwise.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-custom_properties--dictstr-str"><em>property</em> custom_properties <em>: Dict<!-- -->[str, str]</em><a href="#property-custom_properties--dictstr-str" class="hash-link" aria-label="Direct link to property-custom_properties--dictstr-str" title="Direct link to property-custom_properties--dictstr-str"></a></h4><p>Get the custom properties of the dataset.</p><ul><li><strong>Returns:</strong>
|
||
Dictionary of custom properties.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--str--none"><em>property</em> description <em>: str | None</em><a href="#property-description--str--none" class="hash-link" aria-label="Direct link to property-description--str--none" title="Direct link to property-description--str--none"></a></h4><p>Get the description of the dataset.</p><ul><li><strong>Returns:</strong>
|
||
The description if set, None otherwise.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-display_name--str--none"><em>property</em> display_name <em>: str | None</em><a href="#property-display_name--str--none" class="hash-link" aria-label="Direct link to property-display_name--str--none" title="Direct link to property-display_name--str--none"></a></h4><p>Get the display name of the dataset.</p><ul><li><strong>Returns:</strong>
|
||
The display name if set, None otherwise.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-external_url--str--none"><em>property</em> external_url <em>: str | None</em><a href="#property-external_url--str--none" class="hash-link" aria-label="Direct link to property-external_url--str--none" title="Direct link to property-external_url--str--none"></a></h4><p>Get the external URL of the dataset.</p><ul><li><strong>Returns:</strong>
|
||
The external URL if set, None otherwise.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="classmethod-get_urn_type"><em>classmethod</em> get_urn_type()<a href="#classmethod-get_urn_type" class="hash-link" aria-label="Direct link to classmethod-get_urn_type" title="Direct link to classmethod-get_urn_type"></a></h4><p>Get the URN type for datasets.</p><ul><li><strong>Return type:</strong><code>Type</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>]</li><li><strong>Returns:</strong>
|
||
The DatasetUrn class.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-last_modified--datetime--none"><em>property</em> last_modified <em>: datetime | None</em><a href="#property-last_modified--datetime--none" class="hash-link" aria-label="Direct link to property-last_modified--datetime--none" title="Direct link to property-last_modified--datetime--none"></a></h4><p>Get the last modification timestamp of the dataset.</p><ul><li><strong>Returns:</strong>
|
||
The last modification timestamp if set, None otherwise.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-qualified_name--str--none"><em>property</em> qualified_name <em>: str | None</em><a href="#property-qualified_name--str--none" class="hash-link" aria-label="Direct link to property-qualified_name--str--none" title="Direct link to property-qualified_name--str--none"></a></h4><p>Get the qualified name of the dataset.</p><ul><li><strong>Returns:</strong>
|
||
The qualified name if set, None otherwise.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-schema--listschemafield"><em>property</em> schema <em>: List[<a href="#datahub.sdk.dataset.SchemaField">SchemaField</a>]</em><a href="#property-schema--listschemafield" class="hash-link" aria-label="Direct link to property-schema--listschemafield" title="Direct link to property-schema--listschemafield"></a></h4><p>Get the schema fields of the dataset.</p><ul><li><strong>Returns:</strong>
|
||
List of SchemaField objects representing the dataset’s schema.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_createdcreated">set_created(created)<a href="#set_createdcreated" class="hash-link" aria-label="Direct link to set_created(created)" title="Direct link to set_created(created)"></a></h4><p>Set the creation timestamp of the dataset.</p><ul><li><strong>Parameters:</strong><strong>created</strong> (<code>datetime</code>) – The creation timestamp to set.</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_custom_propertiescustom_properties">set_custom_properties(custom_properties)<a href="#set_custom_propertiescustom_properties" class="hash-link" aria-label="Direct link to set_custom_properties(custom_properties)" title="Direct link to set_custom_properties(custom_properties)"></a></h4><p>Set the custom properties of the dataset.</p><ul><li><strong>Parameters:</strong><strong>custom_properties</strong> (<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->) – Dictionary of custom properties to set.</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_descriptiondescription">set_description(description)<a href="#set_descriptiondescription" class="hash-link" aria-label="Direct link to set_description(description)" title="Direct link to set_description(description)"></a></h4><p>Set the description of the dataset.</p><ul><li><strong>Parameters:</strong><strong>description</strong> (<code>str</code>) – The description to set.</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="note">NOTE<a href="#note" class="hash-link" aria-label="Direct link to NOTE" title="Direct link to NOTE"></a></h4><p>If called during ingestion, this will warn if overwriting
|
||
a non-ingestion description.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_display_namedisplay_name">set_display_name(display_name)<a href="#set_display_namedisplay_name" class="hash-link" aria-label="Direct link to set_display_name(display_name)" title="Direct link to set_display_name(display_name)"></a></h4><p>Set the display name of the dataset.</p><ul><li><strong>Parameters:</strong><strong>display_name</strong> (<code>str</code>) – The display name to set.</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_external_urlexternal_url">set_external_url(external_url)<a href="#set_external_urlexternal_url" class="hash-link" aria-label="Direct link to set_external_url(external_url)" title="Direct link to set_external_url(external_url)"></a></h4><p>Set the external URL of the dataset.</p><ul><li><strong>Parameters:</strong><strong>external_url</strong> (<code>str</code>) – The external URL to set.</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_last_modifiedlast_modified">set_last_modified(last_modified)<a href="#set_last_modifiedlast_modified" class="hash-link" aria-label="Direct link to set_last_modified(last_modified)" title="Direct link to set_last_modified(last_modified)"></a></h4><ul><li><strong>Parameters:</strong><strong>last_modified</strong> (<code>datetime</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_qualified_namequalified_name">set_qualified_name(qualified_name)<a href="#set_qualified_namequalified_name" class="hash-link" aria-label="Direct link to set_qualified_name(qualified_name)" title="Direct link to set_qualified_name(qualified_name)"></a></h4><p>Set the qualified name of the dataset.</p><ul><li><strong>Parameters:</strong><strong>qualified_name</strong> (<code>str</code>) – The qualified name to set.</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_upstreamsupstreams">set_upstreams(upstreams)<a href="#set_upstreamsupstreams" class="hash-link" aria-label="Direct link to set_upstreams(upstreams)" title="Direct link to set_upstreams(upstreams)"></a></h4><ul><li><strong>Parameters:</strong><strong>upstreams</strong> (<code>Union</code>[<a href="/docs/python-sdk/models#datahub.metadata.schema_classes.UpstreamLineageClass"><code>UpstreamLineageClass</code></a>, <code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.UpstreamClass"><code>UpstreamClass</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.FineGrainedLineageClass"><code>FineGrainedLineageClass</code></a>]], <code>Dict</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>], <code>Dict</code>[<code>str</code>, <code>List</code>[<code>str</code>]<!-- -->]]]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-upstreams--upstreamlineageclass--none"><em>property</em> upstreams <em>: <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.UpstreamLineageClass">UpstreamLineageClass</a> | None</em><a href="#property-upstreams--upstreamlineageclass--none" class="hash-link" aria-label="Direct link to property-upstreams--upstreamlineageclass--none" title="Direct link to property-upstreams--upstreamlineageclass--none"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--dataseturn"><em>property</em> urn <em>: <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn">DatasetUrn</a></em><a href="#property-urn--dataseturn" class="hash-link" aria-label="Direct link to property-urn--dataseturn" title="Direct link to property-urn--dataseturn"></a></h4><p>Get the entity’s URN.</p><ul><li><strong>Returns:</strong>
|
||
The URN that uniquely identifies this entity.</li></ul></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.sdk.dataset.SchemaField"><span class="visually-hidden">SchemaField</span><a href="#datahub.sdk.dataset.SchemaField" class="hash-link" aria-label="Direct link to datahub.sdk.dataset.SchemaField" title="Direct link to datahub.sdk.dataset.SchemaField"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.sdk.dataset.</span><span class="class-name">SchemaField</span>(<span class="arg-name">parent</span>, <span class="arg-name">field_path</span>)<a href="#datahub.sdk.dataset.SchemaField" class="hash-link"></a></div><p>Bases: <code>object</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>parent</strong> (<a href="#datahub.sdk.dataset.Dataset"><code>Dataset</code></a>) – </li><li><strong>field_path</strong> (<code>str</code>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="add_tagtag">add_tag(tag)<a href="#add_tagtag" class="hash-link" aria-label="Direct link to add_tag(tag)" title="Direct link to add_tag(tag)"></a></h4><ul><li><strong>Parameters:</strong><strong>tag</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.TagUrn"><code>TagUrn</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.TagAssociationClass"><code>TagAssociationClass</code></a>]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="add_termterm">add_term(term)<a href="#add_termterm" class="hash-link" aria-label="Direct link to add_term(term)" title="Direct link to add_term(term)"></a></h4><ul><li><strong>Parameters:</strong><strong>term</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.GlossaryTermUrn"><code>GlossaryTermUrn</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.GlossaryTermAssociationClass"><code>GlossaryTermAssociationClass</code></a>]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--str--none-1"><em>property</em> description <em>: str | None</em><a href="#property-description--str--none-1" class="hash-link" aria-label="Direct link to property-description--str--none-1" title="Direct link to property-description--str--none-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-field_path--str"><em>property</em> field_path <em>: str</em><a href="#property-field_path--str" class="hash-link" aria-label="Direct link to property-field_path--str" title="Direct link to property-field_path--str"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-mapped_type--schemafielddatatypeclass"><em>property</em> mapped_type <em>: <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.SchemaFieldDataTypeClass">SchemaFieldDataTypeClass</a></em><a href="#property-mapped_type--schemafielddatatypeclass" class="hash-link" aria-label="Direct link to property-mapped_type--schemafielddatatypeclass" title="Direct link to property-mapped_type--schemafielddatatypeclass"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-native_type--str"><em>property</em> native_type <em>: str</em><a href="#property-native_type--str" class="hash-link" aria-label="Direct link to property-native_type--str" title="Direct link to property-native_type--str"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="remove_tagtag">remove_tag(tag)<a href="#remove_tagtag" class="hash-link" aria-label="Direct link to remove_tag(tag)" title="Direct link to remove_tag(tag)"></a></h4><ul><li><strong>Parameters:</strong><strong>tag</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.TagUrn"><code>TagUrn</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.TagAssociationClass"><code>TagAssociationClass</code></a>]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="remove_termterm">remove_term(term)<a href="#remove_termterm" class="hash-link" aria-label="Direct link to remove_term(term)" title="Direct link to remove_term(term)"></a></h4><ul><li><strong>Parameters:</strong><strong>term</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.GlossaryTermUrn"><code>GlossaryTermUrn</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.GlossaryTermAssociationClass"><code>GlossaryTermAssociationClass</code></a>]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_descriptiondescription-1">set_description(description)<a href="#set_descriptiondescription-1" class="hash-link" aria-label="Direct link to set_description(description)" title="Direct link to set_description(description)"></a></h4><ul><li><strong>Parameters:</strong><strong>description</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_tagstags">set_tags(tags)<a href="#set_tagstags" class="hash-link" aria-label="Direct link to set_tags(tags)" title="Direct link to set_tags(tags)"></a></h4><ul><li><strong>Parameters:</strong><strong>tags</strong> (<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.TagUrn"><code>TagUrn</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.TagAssociationClass"><code>TagAssociationClass</code></a>]]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_termsterms">set_terms(terms)<a href="#set_termsterms" class="hash-link" aria-label="Direct link to set_terms(terms)" title="Direct link to set_terms(terms)"></a></h4><ul><li><strong>Parameters:</strong><strong>terms</strong> (<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.GlossaryTermUrn"><code>GlossaryTermUrn</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.GlossaryTermAssociationClass"><code>GlossaryTermAssociationClass</code></a>]]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-tags--listtagassociationclass--none"><em>property</em> tags <em>: List[<a href="/docs/python-sdk/models#datahub.metadata.schema_classes.TagAssociationClass">TagAssociationClass</a>] | None</em><a href="#property-tags--listtagassociationclass--none" class="hash-link" aria-label="Direct link to property-tags--listtagassociationclass--none" title="Direct link to property-tags--listtagassociationclass--none"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-terms--listglossarytermassociationclass--none"><em>property</em> terms <em>: List[<a href="/docs/python-sdk/models#datahub.metadata.schema_classes.GlossaryTermAssociationClass">GlossaryTermAssociationClass</a>] | None</em><a href="#property-terms--listglossarytermassociationclass--none" class="hash-link" aria-label="Direct link to property-terms--listglossarytermassociationclass--none" title="Direct link to property-terms--listglossarytermassociationclass--none"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.sdk.dataset.parse_cll_mapping"><span class="visually-hidden">parse_cll_mapping</span><a href="#datahub.sdk.dataset.parse_cll_mapping" class="hash-link" aria-label="Direct link to datahub.sdk.dataset.parse_cll_mapping" title="Direct link to datahub.sdk.dataset.parse_cll_mapping"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-owner">datahub.sdk.dataset.</span><span class="class-name">parse_cll_mapping</span>(*, <span class="arg-name">upstream</span>, <span class="arg-name">downstream</span>, <span class="arg-name">cll_mapping</span>)<a href="#datahub.sdk.dataset.parse_cll_mapping" class="hash-link"></a></div><ul><li><strong>Parameters:</strong><ul><li><strong>upstream</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>]) – </li><li><strong>downstream</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>]) – </li><li><strong>cll_mapping</strong> (<code>Dict</code>[<code>str</code>, <code>List</code>[<code>str</code>]<!-- -->])</li></ul></li><li><strong>Return type:</strong><code>List</code>[<a href="/docs/python-sdk/models#datahub.metadata.schema_classes.FineGrainedLineageClass"><code>FineGrainedLineageClass</code></a>]</li></ul></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.sdk.container.Container"><span class="visually-hidden">Container</span><a href="#datahub.sdk.container.Container" class="hash-link" aria-label="Direct link to datahub.sdk.container.Container" title="Direct link to datahub.sdk.container.Container"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.sdk.container.</span><span class="class-name">Container</span>(<span class="arg-name">container_key</span>, *, <span class="arg-name">display_name</span>, <span class="arg-name">qualified_name</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">external_url</span> = <span class="arg-default">None</span>, <span class="arg-name">extra_properties</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">last_modified</span> = <span class="arg-default">None</span>, <span class="arg-name">parent_container</span> = <span class="arg-default">Auto.token</span>, <span class="arg-name">subtype</span> = <span class="arg-default">None</span>, <span class="arg-name">owners</span> = <span class="arg-default">None</span>, <span class="arg-name">links</span> = <span class="arg-default">None</span>, <span class="arg-name">tags</span> = <span class="arg-default">None</span>, <span class="arg-name">terms</span> = <span class="arg-default">None</span>, <span class="arg-name">domain</span> = <span class="arg-default">None</span>, <span class="arg-name">structured_properties</span> = <span class="arg-default">None</span>, <span class="arg-name">extra_aspects</span> = <span class="arg-default">None</span>)<a href="#datahub.sdk.container.Container" class="hash-link"></a></div><p>Bases: <code>HasPlatformInstance</code>, <code>HasSubtype</code>, <code>HasContainer</code>, <code>HasOwnership</code>, <code>HasInstitutionalMemory</code>, <code>HasStructuredProperties</code>, <code>HasTags</code>, <code>HasTerms</code>, <code>HasDomain</code>, <code>Entity</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>container_key</strong> (<a href="/docs/python-sdk/builder/mcp-builder#datahub.emitter.mcp_builder.ContainerKey"><code>ContainerKey</code></a>) – </li><li><strong>display_name</strong> (<code>str</code>)</li><li><strong>qualified_name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>external_url</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>extra_properties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>created</strong> (<code>Optional</code>[<code>datetime</code>]<!-- -->)</li><li><strong>last_modified</strong> (<code>Optional</code>[<code>datetime</code>]<!-- -->)</li><li><strong>parent_container</strong> (<code>Union</code>[<code>Auto</code>, <a href="#datahub.sdk.container.Container"><code>Container</code></a>, <a href="/docs/python-sdk/builder/mcp-builder#datahub.emitter.mcp_builder.ContainerKey"><code>ContainerKey</code></a>, <code>List</code>[<code>Union</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.Urn"><code>Urn</code></a>, <code>str</code>]], <code>None</code>]) – </li><li><strong>subtype</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>owners</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpUserUrn"><code>CorpUserUrn</code></a>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpGroupUrn"><code>CorpGroupUrn</code></a>, <code>Tuple</code>[<code>Union</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpUserUrn"><code>CorpUserUrn</code></a>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpGroupUrn"><code>CorpGroupUrn</code></a>], <code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.OwnershipTypeUrn"><code>OwnershipTypeUrn</code></a>]], <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.OwnerClass"><code>OwnerClass</code></a>]]]) – </li><li><strong>links</strong> (<code>Optional</code>[<code>Sequence</code>[<code>Union</code>[<code>str</code>, <code>Tuple</code>[<code>str</code>, <code>str</code>]<!-- -->, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass"><code>InstitutionalMemoryMetadataClass</code></a>]]]) – </li><li><strong>tags</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.TagUrn"><code>TagUrn</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.TagAssociationClass"><code>TagAssociationClass</code></a>]]]) – </li><li><strong>terms</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.GlossaryTermUrn"><code>GlossaryTermUrn</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.GlossaryTermAssociationClass"><code>GlossaryTermAssociationClass</code></a>]]]) – </li><li><strong>domain</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DomainUrn"><code>DomainUrn</code></a>, <code>None</code>]) – </li><li><strong>structured_properties</strong> (<code>Optional</code>[<code>Dict</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.StructuredPropertyUrn"><code>StructuredPropertyUrn</code></a>], <code>Sequence</code>[<code>Union</code>[<code>str</code>, <code>float</code>, <code>int</code>]<!-- -->]]]) – </li><li><strong>extra_aspects</strong> (<code>Optional</code>[<code>List</code>[<code>TypeVar</code>(<code>Aspect</code>, bound= <code>_Aspect</code>)]<!-- -->]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--datetime--none-1"><em>property</em> created <em>: datetime | None</em><a href="#property-created--datetime--none-1" class="hash-link" aria-label="Direct link to property-created--datetime--none-1" title="Direct link to property-created--datetime--none-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-custom_properties--dictstr-str--none"><em>property</em> custom_properties <em>: Dict<!-- -->[str, str]<!-- --> | None</em><a href="#property-custom_properties--dictstr-str--none" class="hash-link" aria-label="Direct link to property-custom_properties--dictstr-str--none" title="Direct link to property-custom_properties--dictstr-str--none"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--str--none-2"><em>property</em> description <em>: str | None</em><a href="#property-description--str--none-2" class="hash-link" aria-label="Direct link to property-description--str--none-2" title="Direct link to property-description--str--none-2"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-display_name--str"><em>property</em> display_name <em>: str</em><a href="#property-display_name--str" class="hash-link" aria-label="Direct link to property-display_name--str" title="Direct link to property-display_name--str"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-external_url--str--none-1"><em>property</em> external_url <em>: str | None</em><a href="#property-external_url--str--none-1" class="hash-link" aria-label="Direct link to property-external_url--str--none-1" title="Direct link to property-external_url--str--none-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="classmethod-get_urn_type-1"><em>classmethod</em> get_urn_type()<a href="#classmethod-get_urn_type-1" class="hash-link" aria-label="Direct link to classmethod-get_urn_type-1" title="Direct link to classmethod-get_urn_type-1"></a></h4><p>Get the URN type for this entity class.</p><ul><li><strong>Return type:</strong><code>Type</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.ContainerUrn"><code>ContainerUrn</code></a>]</li><li><strong>Returns:</strong>
|
||
The URN type class that corresponds to this entity type.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-last_modified--datetime--none-1"><em>property</em> last_modified <em>: datetime | None</em><a href="#property-last_modified--datetime--none-1" class="hash-link" aria-label="Direct link to property-last_modified--datetime--none-1" title="Direct link to property-last_modified--datetime--none-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-qualified_name--str--none-1"><em>property</em> qualified_name <em>: str | None</em><a href="#property-qualified_name--str--none-1" class="hash-link" aria-label="Direct link to property-qualified_name--str--none-1" title="Direct link to property-qualified_name--str--none-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_createdcreated-1">set_created(created)<a href="#set_createdcreated-1" class="hash-link" aria-label="Direct link to set_created(created)" title="Direct link to set_created(created)"></a></h4><ul><li><strong>Parameters:</strong><strong>created</strong> (<code>datetime</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_custom_propertiescustom_properties-1">set_custom_properties(custom_properties)<a href="#set_custom_propertiescustom_properties-1" class="hash-link" aria-label="Direct link to set_custom_properties(custom_properties)" title="Direct link to set_custom_properties(custom_properties)"></a></h4><ul><li><strong>Parameters:</strong><strong>custom_properties</strong> (<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_descriptiondescription-2">set_description(description)<a href="#set_descriptiondescription-2" class="hash-link" aria-label="Direct link to set_description(description)" title="Direct link to set_description(description)"></a></h4><ul><li><strong>Parameters:</strong><strong>description</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_display_namevalue">set_display_name(value)<a href="#set_display_namevalue" class="hash-link" aria-label="Direct link to set_display_name(value)" title="Direct link to set_display_name(value)"></a></h4><ul><li><strong>Parameters:</strong><strong>value</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_external_urlexternal_url-1">set_external_url(external_url)<a href="#set_external_urlexternal_url-1" class="hash-link" aria-label="Direct link to set_external_url(external_url)" title="Direct link to set_external_url(external_url)"></a></h4><ul><li><strong>Parameters:</strong><strong>external_url</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_last_modifiedlast_modified-1">set_last_modified(last_modified)<a href="#set_last_modifiedlast_modified-1" class="hash-link" aria-label="Direct link to set_last_modified(last_modified)" title="Direct link to set_last_modified(last_modified)"></a></h4><ul><li><strong>Parameters:</strong><strong>last_modified</strong> (<code>datetime</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_qualified_namequalified_name-1">set_qualified_name(qualified_name)<a href="#set_qualified_namequalified_name-1" class="hash-link" aria-label="Direct link to set_qualified_name(qualified_name)" title="Direct link to set_qualified_name(qualified_name)"></a></h4><ul><li><strong>Parameters:</strong><strong>qualified_name</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.sdk.mlmodel.MLModel"><span class="visually-hidden">MLModel</span><a href="#datahub.sdk.mlmodel.MLModel" class="hash-link" aria-label="Direct link to datahub.sdk.mlmodel.MLModel" title="Direct link to datahub.sdk.mlmodel.MLModel"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.sdk.mlmodel.</span><span class="class-name">MLModel</span>(<span class="arg-name">id</span>, <span class="arg-name">platform</span>, <span class="arg-name">version</span> = <span class="arg-default">None</span>, <span class="arg-name">aliases</span> = <span class="arg-default">None</span>, <span class="arg-name">platform_instance</span> = <span class="arg-default">None</span>, <span class="arg-name">env</span> = <span class="arg-default">'PROD'</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">training_metrics</span> = <span class="arg-default">None</span>, <span class="arg-name">hyper_params</span> = <span class="arg-default">None</span>, <span class="arg-name">external_url</span> = <span class="arg-default">None</span>, <span class="arg-name">custom_properties</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">last_modified</span> = <span class="arg-default">None</span>, <span class="arg-name">owners</span> = <span class="arg-default">None</span>, <span class="arg-name">links</span> = <span class="arg-default">None</span>, <span class="arg-name">tags</span> = <span class="arg-default">None</span>, <span class="arg-name">terms</span> = <span class="arg-default">None</span>, <span class="arg-name">domain</span> = <span class="arg-default">None</span>, <span class="arg-name">model_group</span> = <span class="arg-default">None</span>, <span class="arg-name">training_jobs</span> = <span class="arg-default">None</span>, <span class="arg-name">downstream_jobs</span> = <span class="arg-default">None</span>, <span class="arg-name">structured_properties</span> = <span class="arg-default">None</span>, <span class="arg-name">extra_aspects</span> = <span class="arg-default">None</span>)<a href="#datahub.sdk.mlmodel.MLModel" class="hash-link"></a></div><p>Bases: <code>HasPlatformInstance</code>, <code>HasOwnership</code>, <code>HasInstitutionalMemory</code>, <code>HasTags</code>, <code>HasTerms</code>, <code>HasDomain</code>, <code>HasVersion</code>, <code>HasStructuredProperties</code>, <code>Entity</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>id</strong> (<code>str</code>)</li><li><strong>platform</strong> (<code>str</code>)</li><li><strong>version</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>aliases</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>platform_instance</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>env</strong> (<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>training_metrics</strong> (<code>Union</code>[<code>List</code>[<a href="/docs/python-sdk/models#datahub.metadata.schema_classes.MLMetricClass"><code>MLMetricClass</code></a>], <code>Dict</code>[<code>str</code>, <code>Optional</code>[<code>str</code>]<!-- -->], <code>None</code>]) – </li><li><strong>hyper_params</strong> (<code>Union</code>[<code>List</code>[<a href="/docs/python-sdk/models#datahub.metadata.schema_classes.MLHyperParamClass"><code>MLHyperParamClass</code></a>], <code>Dict</code>[<code>str</code>, <code>Optional</code>[<code>str</code>]<!-- -->], <code>None</code>]) – </li><li><strong>external_url</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>custom_properties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>created</strong> (<code>Optional</code>[<code>datetime</code>]<!-- -->)</li><li><strong>last_modified</strong> (<code>Optional</code>[<code>datetime</code>]<!-- -->)</li><li><strong>owners</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpUserUrn"><code>CorpUserUrn</code></a>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpGroupUrn"><code>CorpGroupUrn</code></a>, <code>Tuple</code>[<code>Union</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpUserUrn"><code>CorpUserUrn</code></a>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpGroupUrn"><code>CorpGroupUrn</code></a>], <code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.OwnershipTypeUrn"><code>OwnershipTypeUrn</code></a>]], <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.OwnerClass"><code>OwnerClass</code></a>]]]) – </li><li><strong>links</strong> (<code>Optional</code>[<code>Sequence</code>[<code>Union</code>[<code>str</code>, <code>Tuple</code>[<code>str</code>, <code>str</code>]<!-- -->, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass"><code>InstitutionalMemoryMetadataClass</code></a>]]]) – </li><li><strong>tags</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.TagUrn"><code>TagUrn</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.TagAssociationClass"><code>TagAssociationClass</code></a>]]]) – </li><li><strong>terms</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.GlossaryTermUrn"><code>GlossaryTermUrn</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.GlossaryTermAssociationClass"><code>GlossaryTermAssociationClass</code></a>]]]) – </li><li><strong>domain</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DomainUrn"><code>DomainUrn</code></a>, <code>None</code>]) – </li><li><strong>model_group</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.MlModelGroupUrn"><code>MlModelGroupUrn</code></a>, <code>None</code>]) – </li><li><strong>training_jobs</strong> (<code>Optional</code>[<code>Sequence</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataProcessInstanceUrn"><code>DataProcessInstanceUrn</code></a>]]]) – </li><li><strong>downstream_jobs</strong> (<code>Optional</code>[<code>Sequence</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataProcessInstanceUrn"><code>DataProcessInstanceUrn</code></a>]]]) – </li><li><strong>structured_properties</strong> (<code>Optional</code>[<code>Dict</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.StructuredPropertyUrn"><code>StructuredPropertyUrn</code></a>], <code>Sequence</code>[<code>Union</code>[<code>str</code>, <code>float</code>, <code>int</code>]<!-- -->]]]) – </li><li><strong>extra_aspects</strong> (<code>Optional</code>[<code>List</code>[<code>TypeVar</code>(<code>Aspect</code>, bound= <code>_Aspect</code>)]<!-- -->]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="add_downstream_jobdownstream_job">add_downstream_job(downstream_job)<a href="#add_downstream_jobdownstream_job" class="hash-link" aria-label="Direct link to add_downstream_job(downstream_job)" title="Direct link to add_downstream_job(downstream_job)"></a></h4><ul><li><strong>Parameters:</strong><strong>downstream_job</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataProcessInstanceUrn"><code>DataProcessInstanceUrn</code></a>]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="add_hyper_paramsparams">add_hyper_params(params)<a href="#add_hyper_paramsparams" class="hash-link" aria-label="Direct link to add_hyper_params(params)" title="Direct link to add_hyper_params(params)"></a></h4><ul><li><strong>Parameters:</strong><strong>params</strong> (<code>Union</code>[<code>List</code>[<a href="/docs/python-sdk/models#datahub.metadata.schema_classes.MLHyperParamClass"><code>MLHyperParamClass</code></a>], <code>Dict</code>[<code>str</code>, <code>Optional</code>[<code>str</code>]<!-- -->]]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="add_training_jobtraining_job">add_training_job(training_job)<a href="#add_training_jobtraining_job" class="hash-link" aria-label="Direct link to add_training_job(training_job)" title="Direct link to add_training_job(training_job)"></a></h4><ul><li><strong>Parameters:</strong><strong>training_job</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataProcessInstanceUrn"><code>DataProcessInstanceUrn</code></a>]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="add_training_metricsmetrics">add_training_metrics(metrics)<a href="#add_training_metricsmetrics" class="hash-link" aria-label="Direct link to add_training_metrics(metrics)" title="Direct link to add_training_metrics(metrics)"></a></h4><ul><li><strong>Parameters:</strong><strong>metrics</strong> (<code>Union</code>[<code>List</code>[<a href="/docs/python-sdk/models#datahub.metadata.schema_classes.MLMetricClass"><code>MLMetricClass</code></a>], <code>Dict</code>[<code>str</code>, <code>Optional</code>[<code>str</code>]<!-- -->]]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--datetime--none-2"><em>property</em> created <em>: datetime | None</em><a href="#property-created--datetime--none-2" class="hash-link" aria-label="Direct link to property-created--datetime--none-2" title="Direct link to property-created--datetime--none-2"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-custom_properties--dictstr-str--none-1"><em>property</em> custom_properties <em>: Dict<!-- -->[str, str]<!-- --> | None</em><a href="#property-custom_properties--dictstr-str--none-1" class="hash-link" aria-label="Direct link to property-custom_properties--dictstr-str--none-1" title="Direct link to property-custom_properties--dictstr-str--none-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--str--none-3"><em>property</em> description <em>: str | None</em><a href="#property-description--str--none-3" class="hash-link" aria-label="Direct link to property-description--str--none-3" title="Direct link to property-description--str--none-3"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-downstream_jobs--liststr--none"><em>property</em> downstream_jobs <em>: List<!-- -->[str]<!-- --> | None</em><a href="#property-downstream_jobs--liststr--none" class="hash-link" aria-label="Direct link to property-downstream_jobs--liststr--none" title="Direct link to property-downstream_jobs--liststr--none"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-external_url--str--none-2"><em>property</em> external_url <em>: str | None</em><a href="#property-external_url--str--none-2" class="hash-link" aria-label="Direct link to property-external_url--str--none-2" title="Direct link to property-external_url--str--none-2"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="classmethod-get_urn_type-2"><em>classmethod</em> get_urn_type()<a href="#classmethod-get_urn_type-2" class="hash-link" aria-label="Direct link to classmethod-get_urn_type-2" title="Direct link to classmethod-get_urn_type-2"></a></h4><p>Get the URN type for this entity class.</p><ul><li><strong>Return type:</strong><code>Type</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.MlModelUrn"><code>MlModelUrn</code></a>]</li><li><strong>Returns:</strong>
|
||
The URN type class that corresponds to this entity type.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-hyper_params--listmlhyperparamclass--none"><em>property</em> hyper_params <em>: List[<a href="/docs/python-sdk/models#datahub.metadata.schema_classes.MLHyperParamClass">MLHyperParamClass</a>] | None</em><a href="#property-hyper_params--listmlhyperparamclass--none" class="hash-link" aria-label="Direct link to property-hyper_params--listmlhyperparamclass--none" title="Direct link to property-hyper_params--listmlhyperparamclass--none"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-last_modified--datetime--none-2"><em>property</em> last_modified <em>: datetime | None</em><a href="#property-last_modified--datetime--none-2" class="hash-link" aria-label="Direct link to property-last_modified--datetime--none-2" title="Direct link to property-last_modified--datetime--none-2"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-model_group--str--none"><em>property</em> model_group <em>: str | None</em><a href="#property-model_group--str--none" class="hash-link" aria-label="Direct link to property-model_group--str--none" title="Direct link to property-model_group--str--none"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str--none"><em>property</em> name <em>: str | None</em><a href="#property-name--str--none" class="hash-link" aria-label="Direct link to property-name--str--none" title="Direct link to property-name--str--none"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="remove_downstream_jobdownstream_job">remove_downstream_job(downstream_job)<a href="#remove_downstream_jobdownstream_job" class="hash-link" aria-label="Direct link to remove_downstream_job(downstream_job)" title="Direct link to remove_downstream_job(downstream_job)"></a></h4><ul><li><strong>Parameters:</strong><strong>downstream_job</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataProcessInstanceUrn"><code>DataProcessInstanceUrn</code></a>]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="remove_training_jobtraining_job">remove_training_job(training_job)<a href="#remove_training_jobtraining_job" class="hash-link" aria-label="Direct link to remove_training_job(training_job)" title="Direct link to remove_training_job(training_job)"></a></h4><ul><li><strong>Parameters:</strong><strong>training_job</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataProcessInstanceUrn"><code>DataProcessInstanceUrn</code></a>]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_createdcreated-2">set_created(created)<a href="#set_createdcreated-2" class="hash-link" aria-label="Direct link to set_created(created)" title="Direct link to set_created(created)"></a></h4><ul><li><strong>Parameters:</strong><strong>created</strong> (<code>datetime</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_custom_propertiescustom_properties-2">set_custom_properties(custom_properties)<a href="#set_custom_propertiescustom_properties-2" class="hash-link" aria-label="Direct link to set_custom_properties(custom_properties)" title="Direct link to set_custom_properties(custom_properties)"></a></h4><ul><li><strong>Parameters:</strong><strong>custom_properties</strong> (<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_descriptiondescription-3">set_description(description)<a href="#set_descriptiondescription-3" class="hash-link" aria-label="Direct link to set_description(description)" title="Direct link to set_description(description)"></a></h4><ul><li><strong>Parameters:</strong><strong>description</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_downstream_jobsdownstream_jobs">set_downstream_jobs(downstream_jobs)<a href="#set_downstream_jobsdownstream_jobs" class="hash-link" aria-label="Direct link to set_downstream_jobs(downstream_jobs)" title="Direct link to set_downstream_jobs(downstream_jobs)"></a></h4><ul><li><strong>Parameters:</strong><strong>downstream_jobs</strong> (<code>Sequence</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataProcessInstanceUrn"><code>DataProcessInstanceUrn</code></a>]]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_external_urlexternal_url-2">set_external_url(external_url)<a href="#set_external_urlexternal_url-2" class="hash-link" aria-label="Direct link to set_external_url(external_url)" title="Direct link to set_external_url(external_url)"></a></h4><ul><li><strong>Parameters:</strong><strong>external_url</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_hyper_paramsparams">set_hyper_params(params)<a href="#set_hyper_paramsparams" class="hash-link" aria-label="Direct link to set_hyper_params(params)" title="Direct link to set_hyper_params(params)"></a></h4><ul><li><strong>Parameters:</strong><strong>params</strong> (<code>Union</code>[<code>List</code>[<a href="/docs/python-sdk/models#datahub.metadata.schema_classes.MLHyperParamClass"><code>MLHyperParamClass</code></a>], <code>Dict</code>[<code>str</code>, <code>Optional</code>[<code>str</code>]<!-- -->]]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_last_modifiedlast_modified-2">set_last_modified(last_modified)<a href="#set_last_modifiedlast_modified-2" class="hash-link" aria-label="Direct link to set_last_modified(last_modified)" title="Direct link to set_last_modified(last_modified)"></a></h4><ul><li><strong>Parameters:</strong><strong>last_modified</strong> (<code>datetime</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_model_groupgroup">set_model_group(group)<a href="#set_model_groupgroup" class="hash-link" aria-label="Direct link to set_model_group(group)" title="Direct link to set_model_group(group)"></a></h4><ul><li><strong>Parameters:</strong><strong>group</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.MlModelGroupUrn"><code>MlModelGroupUrn</code></a>]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_namename">set_name(name)<a href="#set_namename" class="hash-link" aria-label="Direct link to set_name(name)" title="Direct link to set_name(name)"></a></h4><ul><li><strong>Parameters:</strong><strong>name</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_training_jobstraining_jobs">set_training_jobs(training_jobs)<a href="#set_training_jobstraining_jobs" class="hash-link" aria-label="Direct link to set_training_jobs(training_jobs)" title="Direct link to set_training_jobs(training_jobs)"></a></h4><ul><li><strong>Parameters:</strong><strong>training_jobs</strong> (<code>Sequence</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataProcessInstanceUrn"><code>DataProcessInstanceUrn</code></a>]]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_training_metricsmetrics">set_training_metrics(metrics)<a href="#set_training_metricsmetrics" class="hash-link" aria-label="Direct link to set_training_metrics(metrics)" title="Direct link to set_training_metrics(metrics)"></a></h4><ul><li><strong>Parameters:</strong><strong>metrics</strong> (<code>Union</code>[<code>List</code>[<a href="/docs/python-sdk/models#datahub.metadata.schema_classes.MLMetricClass"><code>MLMetricClass</code></a>], <code>Dict</code>[<code>str</code>, <code>Optional</code>[<code>str</code>]<!-- -->]]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-training_jobs--liststr--none"><em>property</em> training_jobs <em>: List<!-- -->[str]<!-- --> | None</em><a href="#property-training_jobs--liststr--none" class="hash-link" aria-label="Direct link to property-training_jobs--liststr--none" title="Direct link to property-training_jobs--liststr--none"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-training_metrics--listmlmetricclass--none"><em>property</em> training_metrics <em>: List[<a href="/docs/python-sdk/models#datahub.metadata.schema_classes.MLMetricClass">MLMetricClass</a>] | None</em><a href="#property-training_metrics--listmlmetricclass--none" class="hash-link" aria-label="Direct link to property-training_metrics--listmlmetricclass--none" title="Direct link to property-training_metrics--listmlmetricclass--none"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--mlmodelurn"><em>property</em> urn <em>: <a href="/docs/python-sdk/urns#datahub.metadata.urns.MlModelUrn">MlModelUrn</a></em><a href="#property-urn--mlmodelurn" class="hash-link" aria-label="Direct link to property-urn--mlmodelurn" title="Direct link to property-urn--mlmodelurn"></a></h4><p>Get the entity’s URN.</p><ul><li><strong>Returns:</strong>
|
||
The URN that uniquely identifies this entity.</li></ul></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.sdk.mlmodelgroup.MLModelGroup"><span class="visually-hidden">MLModelGroup</span><a href="#datahub.sdk.mlmodelgroup.MLModelGroup" class="hash-link" aria-label="Direct link to datahub.sdk.mlmodelgroup.MLModelGroup" title="Direct link to datahub.sdk.mlmodelgroup.MLModelGroup"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.sdk.mlmodelgroup.</span><span class="class-name">MLModelGroup</span>(<span class="arg-name">id</span>, <span class="arg-name">platform</span>, <span class="arg-name">name</span> = <span class="arg-default">''</span>, <span class="arg-name">platform_instance</span> = <span class="arg-default">None</span>, <span class="arg-name">env</span> = <span class="arg-default">'PROD'</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">display_name</span> = <span class="arg-default">None</span>, <span class="arg-name">external_url</span> = <span class="arg-default">None</span>, <span class="arg-name">custom_properties</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">last_modified</span> = <span class="arg-default">None</span>, <span class="arg-name">owners</span> = <span class="arg-default">None</span>, <span class="arg-name">links</span> = <span class="arg-default">None</span>, <span class="arg-name">tags</span> = <span class="arg-default">None</span>, <span class="arg-name">terms</span> = <span class="arg-default">None</span>, <span class="arg-name">domain</span> = <span class="arg-default">None</span>, <span class="arg-name">training_jobs</span> = <span class="arg-default">None</span>, <span class="arg-name">downstream_jobs</span> = <span class="arg-default">None</span>, <span class="arg-name">structured_properties</span> = <span class="arg-default">None</span>, <span class="arg-name">extra_aspects</span> = <span class="arg-default">None</span>)<a href="#datahub.sdk.mlmodelgroup.MLModelGroup" class="hash-link"></a></div><p>Bases: <code>HasPlatformInstance</code>, <code>HasOwnership</code>, <code>HasInstitutionalMemory</code>, <code>HasTags</code>, <code>HasTerms</code>, <code>HasDomain</code>, <code>HasStructuredProperties</code>, <code>Entity</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>id</strong> (<code>str</code>)</li><li><strong>platform</strong> (<code>str</code>)</li><li><strong>name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>platform_instance</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>env</strong> (<code>str</code>)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>display_name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>external_url</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>custom_properties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>created</strong> (<code>Optional</code>[<code>datetime</code>]<!-- -->)</li><li><strong>last_modified</strong> (<code>Optional</code>[<code>datetime</code>]<!-- -->)</li><li><strong>owners</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpUserUrn"><code>CorpUserUrn</code></a>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpGroupUrn"><code>CorpGroupUrn</code></a>, <code>Tuple</code>[<code>Union</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpUserUrn"><code>CorpUserUrn</code></a>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpGroupUrn"><code>CorpGroupUrn</code></a>], <code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.OwnershipTypeUrn"><code>OwnershipTypeUrn</code></a>]], <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.OwnerClass"><code>OwnerClass</code></a>]]]) – </li><li><strong>links</strong> (<code>Optional</code>[<code>Sequence</code>[<code>Union</code>[<code>str</code>, <code>Tuple</code>[<code>str</code>, <code>str</code>]<!-- -->, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass"><code>InstitutionalMemoryMetadataClass</code></a>]]]) – </li><li><strong>tags</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.TagUrn"><code>TagUrn</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.TagAssociationClass"><code>TagAssociationClass</code></a>]]]) – </li><li><strong>terms</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.GlossaryTermUrn"><code>GlossaryTermUrn</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.GlossaryTermAssociationClass"><code>GlossaryTermAssociationClass</code></a>]]]) – </li><li><strong>domain</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DomainUrn"><code>DomainUrn</code></a>, <code>None</code>]) – </li><li><strong>training_jobs</strong> (<code>Optional</code>[<code>Sequence</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataProcessInstanceUrn"><code>DataProcessInstanceUrn</code></a>]]]) – </li><li><strong>downstream_jobs</strong> (<code>Optional</code>[<code>Sequence</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataProcessInstanceUrn"><code>DataProcessInstanceUrn</code></a>]]]) – </li><li><strong>structured_properties</strong> (<code>Optional</code>[<code>Dict</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.StructuredPropertyUrn"><code>StructuredPropertyUrn</code></a>], <code>Sequence</code>[<code>Union</code>[<code>str</code>, <code>float</code>, <code>int</code>]<!-- -->]]]) – </li><li><strong>extra_aspects</strong> (<code>Optional</code>[<code>List</code>[<code>TypeVar</code>(<code>Aspect</code>, bound= <code>_Aspect</code>)]<!-- -->]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="add_downstream_jobdownstream_job-1">add_downstream_job(downstream_job)<a href="#add_downstream_jobdownstream_job-1" class="hash-link" aria-label="Direct link to add_downstream_job(downstream_job)" title="Direct link to add_downstream_job(downstream_job)"></a></h4><ul><li><strong>Parameters:</strong><strong>downstream_job</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataProcessInstanceUrn"><code>DataProcessInstanceUrn</code></a>]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="add_training_jobtraining_job-1">add_training_job(training_job)<a href="#add_training_jobtraining_job-1" class="hash-link" aria-label="Direct link to add_training_job(training_job)" title="Direct link to add_training_job(training_job)"></a></h4><ul><li><strong>Parameters:</strong><strong>training_job</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataProcessInstanceUrn"><code>DataProcessInstanceUrn</code></a>]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--datetime--none-3"><em>property</em> created <em>: datetime | None</em><a href="#property-created--datetime--none-3" class="hash-link" aria-label="Direct link to property-created--datetime--none-3" title="Direct link to property-created--datetime--none-3"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-custom_properties--dictstr-str--none-2"><em>property</em> custom_properties <em>: Dict<!-- -->[str, str]<!-- --> | None</em><a href="#property-custom_properties--dictstr-str--none-2" class="hash-link" aria-label="Direct link to property-custom_properties--dictstr-str--none-2" title="Direct link to property-custom_properties--dictstr-str--none-2"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--str--none-4"><em>property</em> description <em>: str | None</em><a href="#property-description--str--none-4" class="hash-link" aria-label="Direct link to property-description--str--none-4" title="Direct link to property-description--str--none-4"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-downstream_jobs--liststr--none-1"><em>property</em> downstream_jobs <em>: List<!-- -->[str]<!-- --> | None</em><a href="#property-downstream_jobs--liststr--none-1" class="hash-link" aria-label="Direct link to property-downstream_jobs--liststr--none-1" title="Direct link to property-downstream_jobs--liststr--none-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-external_url--str--none-3"><em>property</em> external_url <em>: str | None</em><a href="#property-external_url--str--none-3" class="hash-link" aria-label="Direct link to property-external_url--str--none-3" title="Direct link to property-external_url--str--none-3"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="classmethod-get_urn_type-3"><em>classmethod</em> get_urn_type()<a href="#classmethod-get_urn_type-3" class="hash-link" aria-label="Direct link to classmethod-get_urn_type-3" title="Direct link to classmethod-get_urn_type-3"></a></h4><p>Get the URN type for this entity class.</p><ul><li><strong>Return type:</strong><code>Type</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.MlModelGroupUrn"><code>MlModelGroupUrn</code></a>]</li><li><strong>Returns:</strong>
|
||
The URN type class that corresponds to this entity type.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-last_modified--datetime--none-3"><em>property</em> last_modified <em>: datetime | None</em><a href="#property-last_modified--datetime--none-3" class="hash-link" aria-label="Direct link to property-last_modified--datetime--none-3" title="Direct link to property-last_modified--datetime--none-3"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str--none-1"><em>property</em> name <em>: str | None</em><a href="#property-name--str--none-1" class="hash-link" aria-label="Direct link to property-name--str--none-1" title="Direct link to property-name--str--none-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="remove_downstream_jobdownstream_job-1">remove_downstream_job(downstream_job)<a href="#remove_downstream_jobdownstream_job-1" class="hash-link" aria-label="Direct link to remove_downstream_job(downstream_job)" title="Direct link to remove_downstream_job(downstream_job)"></a></h4><ul><li><strong>Parameters:</strong><strong>downstream_job</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataProcessInstanceUrn"><code>DataProcessInstanceUrn</code></a>]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="remove_training_jobtraining_job-1">remove_training_job(training_job)<a href="#remove_training_jobtraining_job-1" class="hash-link" aria-label="Direct link to remove_training_job(training_job)" title="Direct link to remove_training_job(training_job)"></a></h4><ul><li><strong>Parameters:</strong><strong>training_job</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataProcessInstanceUrn"><code>DataProcessInstanceUrn</code></a>]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_createdcreated-3">set_created(created)<a href="#set_createdcreated-3" class="hash-link" aria-label="Direct link to set_created(created)" title="Direct link to set_created(created)"></a></h4><ul><li><strong>Parameters:</strong><strong>created</strong> (<code>datetime</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_custom_propertiescustom_properties-3">set_custom_properties(custom_properties)<a href="#set_custom_propertiescustom_properties-3" class="hash-link" aria-label="Direct link to set_custom_properties(custom_properties)" title="Direct link to set_custom_properties(custom_properties)"></a></h4><ul><li><strong>Parameters:</strong><strong>custom_properties</strong> (<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_descriptiondescription-4">set_description(description)<a href="#set_descriptiondescription-4" class="hash-link" aria-label="Direct link to set_description(description)" title="Direct link to set_description(description)"></a></h4><ul><li><strong>Parameters:</strong><strong>description</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_downstream_jobsdownstream_jobs-1">set_downstream_jobs(downstream_jobs)<a href="#set_downstream_jobsdownstream_jobs-1" class="hash-link" aria-label="Direct link to set_downstream_jobs(downstream_jobs)" title="Direct link to set_downstream_jobs(downstream_jobs)"></a></h4><ul><li><strong>Parameters:</strong><strong>downstream_jobs</strong> (<code>Sequence</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataProcessInstanceUrn"><code>DataProcessInstanceUrn</code></a>]]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_external_urlexternal_url-3">set_external_url(external_url)<a href="#set_external_urlexternal_url-3" class="hash-link" aria-label="Direct link to set_external_url(external_url)" title="Direct link to set_external_url(external_url)"></a></h4><ul><li><strong>Parameters:</strong><strong>external_url</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_last_modifiedlast_modified-3">set_last_modified(last_modified)<a href="#set_last_modifiedlast_modified-3" class="hash-link" aria-label="Direct link to set_last_modified(last_modified)" title="Direct link to set_last_modified(last_modified)"></a></h4><ul><li><strong>Parameters:</strong><strong>last_modified</strong> (<code>datetime</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_namedisplay_name">set_name(display_name)<a href="#set_namedisplay_name" class="hash-link" aria-label="Direct link to set_name(display_name)" title="Direct link to set_name(display_name)"></a></h4><ul><li><strong>Parameters:</strong><strong>display_name</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_training_jobstraining_jobs-1">set_training_jobs(training_jobs)<a href="#set_training_jobstraining_jobs-1" class="hash-link" aria-label="Direct link to set_training_jobs(training_jobs)" title="Direct link to set_training_jobs(training_jobs)"></a></h4><ul><li><strong>Parameters:</strong><strong>training_jobs</strong> (<code>Sequence</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataProcessInstanceUrn"><code>DataProcessInstanceUrn</code></a>]]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-training_jobs--liststr--none-1"><em>property</em> training_jobs <em>: List<!-- -->[str]<!-- --> | None</em><a href="#property-training_jobs--liststr--none-1" class="hash-link" aria-label="Direct link to property-training_jobs--liststr--none-1" title="Direct link to property-training_jobs--liststr--none-1"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--mlmodelgroupurn"><em>property</em> urn <em>: <a href="/docs/python-sdk/urns#datahub.metadata.urns.MlModelGroupUrn">MlModelGroupUrn</a></em><a href="#property-urn--mlmodelgroupurn" class="hash-link" aria-label="Direct link to property-urn--mlmodelgroupurn" title="Direct link to property-urn--mlmodelgroupurn"></a></h4><p>Get the entity’s URN.</p><ul><li><strong>Returns:</strong>
|
||
The URN that uniquely identifies this entity.</li></ul></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.sdk.dashboard.Dashboard"><span class="visually-hidden">Dashboard</span><a href="#datahub.sdk.dashboard.Dashboard" class="hash-link" aria-label="Direct link to datahub.sdk.dashboard.Dashboard" title="Direct link to datahub.sdk.dashboard.Dashboard"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.sdk.dashboard.</span><span class="class-name">Dashboard</span>(*, <span class="arg-name">name</span>, <span class="arg-name">platform</span>, <span class="arg-name">display_name</span> = <span class="arg-default">None</span>, <span class="arg-name">platform_instance</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">''</span>, <span class="arg-name">external_url</span> = <span class="arg-default">None</span>, <span class="arg-name">dashboard_url</span> = <span class="arg-default">None</span>, <span class="arg-name">custom_properties</span> = <span class="arg-default">None</span>, <span class="arg-name">last_modified</span> = <span class="arg-default">None</span>, <span class="arg-name">last_refreshed</span> = <span class="arg-default">None</span>, <span class="arg-name">input_datasets</span> = <span class="arg-default">None</span>, <span class="arg-name">charts</span> = <span class="arg-default">None</span>, <span class="arg-name">dashboards</span> = <span class="arg-default">None</span>, <span class="arg-name">subtype</span> = <span class="arg-default">None</span>, <span class="arg-name">owners</span> = <span class="arg-default">None</span>, <span class="arg-name">links</span> = <span class="arg-default">None</span>, <span class="arg-name">tags</span> = <span class="arg-default">None</span>, <span class="arg-name">terms</span> = <span class="arg-default">None</span>, <span class="arg-name">domain</span> = <span class="arg-default">None</span>, <span class="arg-name">extra_aspects</span> = <span class="arg-default">None</span>)<a href="#datahub.sdk.dashboard.Dashboard" class="hash-link"></a></div><p>Bases: <code>HasPlatformInstance</code>, <code>HasSubtype</code>, <code>HasOwnership</code>, <code>HasContainer</code>, <code>HasInstitutionalMemory</code>, <code>HasTags</code>, <code>HasTerms</code>, <code>HasDomain</code>, <code>Entity</code></p><p>Represents a dashboard in DataHub.</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>platform</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataPlatformUrn"><code>DataPlatformUrn</code></a>]) – </li><li><strong>display_name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>platform_instance</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataPlatformInstanceUrn"><code>DataPlatformInstanceUrn</code></a>, <code>None</code>]) – </li><li><strong>description</strong> (<code>str</code>)</li><li><strong>external_url</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>dashboard_url</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>custom_properties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>last_modified</strong> (<code>Optional</code>[<code>datetime</code>]<!-- -->)</li><li><strong>last_refreshed</strong> (<code>Optional</code>[<code>datetime</code>]<!-- -->)</li><li><strong>input_datasets</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>, <a href="#datahub.sdk.dataset.Dataset"><code>Dataset</code></a>]]]) – </li><li><strong>charts</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.ChartUrn"><code>ChartUrn</code></a>, <a href="#datahub.sdk.chart.Chart"><code>Chart</code></a>]]]) – </li><li><strong>dashboards</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DashboardUrn"><code>DashboardUrn</code></a>, <a href="#datahub.sdk.dashboard.Dashboard"><code>Dashboard</code></a>]]]) – </li><li><strong>subtype</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>owners</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpUserUrn"><code>CorpUserUrn</code></a>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpGroupUrn"><code>CorpGroupUrn</code></a>, <code>Tuple</code>[<code>Union</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpUserUrn"><code>CorpUserUrn</code></a>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpGroupUrn"><code>CorpGroupUrn</code></a>], <code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.OwnershipTypeUrn"><code>OwnershipTypeUrn</code></a>]], <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.OwnerClass"><code>OwnerClass</code></a>]]]) – </li><li><strong>links</strong> (<code>Optional</code>[<code>Sequence</code>[<code>Union</code>[<code>str</code>, <code>Tuple</code>[<code>str</code>, <code>str</code>]<!-- -->, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass"><code>InstitutionalMemoryMetadataClass</code></a>]]]) – </li><li><strong>tags</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.TagUrn"><code>TagUrn</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.TagAssociationClass"><code>TagAssociationClass</code></a>]]]) – </li><li><strong>terms</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.GlossaryTermUrn"><code>GlossaryTermUrn</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.GlossaryTermAssociationClass"><code>GlossaryTermAssociationClass</code></a>]]]) – </li><li><strong>domain</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DomainUrn"><code>DomainUrn</code></a>, <code>None</code>]) – </li><li><strong>extra_aspects</strong> (<code>Optional</code>[<code>List</code>[<code>TypeVar</code>(<code>Aspect</code>, bound= <code>_Aspect</code>)]<!-- -->]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="add_chartchart">add_chart(chart)<a href="#add_chartchart" class="hash-link" aria-label="Direct link to add_chart(chart)" title="Direct link to add_chart(chart)"></a></h4><p>Add a chart to the dashboard.</p><ul><li><strong>Parameters:</strong><strong>chart</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.ChartUrn"><code>ChartUrn</code></a>, <a href="#datahub.sdk.chart.Chart"><code>Chart</code></a>]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="add_dashboarddashboard">add_dashboard(dashboard)<a href="#add_dashboarddashboard" class="hash-link" aria-label="Direct link to add_dashboard(dashboard)" title="Direct link to add_dashboard(dashboard)"></a></h4><p>Add a dashboard to the dashboard.</p><ul><li><strong>Parameters:</strong><strong>dashboard</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DashboardUrn"><code>DashboardUrn</code></a>, <a href="#datahub.sdk.dashboard.Dashboard"><code>Dashboard</code></a>]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="add_input_datasetinput_dataset">add_input_dataset(input_dataset)<a href="#add_input_datasetinput_dataset" class="hash-link" aria-label="Direct link to add_input_dataset(input_dataset)" title="Direct link to add_input_dataset(input_dataset)"></a></h4><p>Add an input dataset to the dashboard.</p><ul><li><strong>Parameters:</strong><strong>input_dataset</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>, <a href="#datahub.sdk.dataset.Dataset"><code>Dataset</code></a>]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-charts--listcharturn"><em>property</em> charts <em>: List[<a href="/docs/python-sdk/urns#datahub.metadata.urns.ChartUrn">ChartUrn</a>]</em><a href="#property-charts--listcharturn" class="hash-link" aria-label="Direct link to property-charts--listcharturn" title="Direct link to property-charts--listcharturn"></a></h4><p>Get the charts of the dashboard.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-custom_properties--dictstr-str-1"><em>property</em> custom_properties <em>: Dict<!-- -->[str, str]</em><a href="#property-custom_properties--dictstr-str-1" class="hash-link" aria-label="Direct link to property-custom_properties--dictstr-str-1" title="Direct link to property-custom_properties--dictstr-str-1"></a></h4><p>Get the custom properties of the dashboard.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-dashboard_url--str--none"><em>property</em> dashboard_url <em>: str | None</em><a href="#property-dashboard_url--str--none" class="hash-link" aria-label="Direct link to property-dashboard_url--str--none" title="Direct link to property-dashboard_url--str--none"></a></h4><p>Get the dashboard URL.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-dashboards--listdashboardurn"><em>property</em> dashboards <em>: List[<a href="/docs/python-sdk/urns#datahub.metadata.urns.DashboardUrn">DashboardUrn</a>]</em><a href="#property-dashboards--listdashboardurn" class="hash-link" aria-label="Direct link to property-dashboards--listdashboardurn" title="Direct link to property-dashboards--listdashboardurn"></a></h4><p>Get the dashboards of the dashboard.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--str--none-5"><em>property</em> description <em>: str | None</em><a href="#property-description--str--none-5" class="hash-link" aria-label="Direct link to property-description--str--none-5" title="Direct link to property-description--str--none-5"></a></h4><p>Get the description of the dashboard.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-display_name--str--none-1"><em>property</em> display_name <em>: str | None</em><a href="#property-display_name--str--none-1" class="hash-link" aria-label="Direct link to property-display_name--str--none-1" title="Direct link to property-display_name--str--none-1"></a></h4><p>Get the display name of the dashboard.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-external_url--str--none-4"><em>property</em> external_url <em>: str | None</em><a href="#property-external_url--str--none-4" class="hash-link" aria-label="Direct link to property-external_url--str--none-4" title="Direct link to property-external_url--str--none-4"></a></h4><p>Get the external URL of the dashboard.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="classmethod-get_urn_type-4"><em>classmethod</em> get_urn_type()<a href="#classmethod-get_urn_type-4" class="hash-link" aria-label="Direct link to classmethod-get_urn_type-4" title="Direct link to classmethod-get_urn_type-4"></a></h4><p>Get the URN type for dashboards.
|
||
:rtype: <code>Type</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.DashboardUrn"><code>DashboardUrn</code></a>]
|
||
:returns: The DashboardUrn class.</p><ul><li><strong>Return type:</strong><em>Type</em>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.DashboardUrn"><em>DashboardUrn</em></a>]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-input_datasets--listdataseturn"><em>property</em> input_datasets <em>: List[<a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn">DatasetUrn</a>]</em><a href="#property-input_datasets--listdataseturn" class="hash-link" aria-label="Direct link to property-input_datasets--listdataseturn" title="Direct link to property-input_datasets--listdataseturn"></a></h4><p>Get the input datasets of the dashboard.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-last_modified--datetime--none-4"><em>property</em> last_modified <em>: datetime | None</em><a href="#property-last_modified--datetime--none-4" class="hash-link" aria-label="Direct link to property-last_modified--datetime--none-4" title="Direct link to property-last_modified--datetime--none-4"></a></h4><p>Get the last modification timestamp of the dashboard.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-last_refreshed--datetime--none"><em>property</em> last_refreshed <em>: datetime | None</em><a href="#property-last_refreshed--datetime--none" class="hash-link" aria-label="Direct link to property-last_refreshed--datetime--none" title="Direct link to property-last_refreshed--datetime--none"></a></h4><p>Get the last refresh timestamp of the dashboard.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str"><em>property</em> name <em>: str</em><a href="#property-name--str" class="hash-link" aria-label="Direct link to property-name--str" title="Direct link to property-name--str"></a></h4><p>Get the name of the dashboard.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="remove_chartchart">remove_chart(chart)<a href="#remove_chartchart" class="hash-link" aria-label="Direct link to remove_chart(chart)" title="Direct link to remove_chart(chart)"></a></h4><p>Remove a chart from the dashboard.</p><ul><li><strong>Parameters:</strong><strong>chart</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.ChartUrn"><code>ChartUrn</code></a>, <a href="#datahub.sdk.chart.Chart"><code>Chart</code></a>]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="remove_input_datasetinput_dataset">remove_input_dataset(input_dataset)<a href="#remove_input_datasetinput_dataset" class="hash-link" aria-label="Direct link to remove_input_dataset(input_dataset)" title="Direct link to remove_input_dataset(input_dataset)"></a></h4><p>Remove an input dataset from the dashboard.</p><ul><li><strong>Parameters:</strong><strong>input_dataset</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>, <a href="#datahub.sdk.dataset.Dataset"><code>Dataset</code></a>]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_chartscharts">set_charts(charts)<a href="#set_chartscharts" class="hash-link" aria-label="Direct link to set_charts(charts)" title="Direct link to set_charts(charts)"></a></h4><p>Set the charts of the dashboard.</p><ul><li><strong>Parameters:</strong><strong>charts</strong> (<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.ChartUrn"><code>ChartUrn</code></a>, <a href="#datahub.sdk.chart.Chart"><code>Chart</code></a>]]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_custom_propertiescustom_properties-4">set_custom_properties(custom_properties)<a href="#set_custom_propertiescustom_properties-4" class="hash-link" aria-label="Direct link to set_custom_properties(custom_properties)" title="Direct link to set_custom_properties(custom_properties)"></a></h4><p>Set the custom properties of the dashboard.</p><ul><li><strong>Parameters:</strong><strong>custom_properties</strong> (<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_dashboard_urldashboard_url">set_dashboard_url(dashboard_url)<a href="#set_dashboard_urldashboard_url" class="hash-link" aria-label="Direct link to set_dashboard_url(dashboard_url)" title="Direct link to set_dashboard_url(dashboard_url)"></a></h4><p>Set the dashboard URL.</p><ul><li><strong>Parameters:</strong><strong>dashboard_url</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_dashboardsdashboards">set_dashboards(dashboards)<a href="#set_dashboardsdashboards" class="hash-link" aria-label="Direct link to set_dashboards(dashboards)" title="Direct link to set_dashboards(dashboards)"></a></h4><p>Set the dashboards of the dashboard.</p><ul><li><strong>Parameters:</strong><strong>dashboards</strong> (<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DashboardUrn"><code>DashboardUrn</code></a>, <a href="#datahub.sdk.dashboard.Dashboard"><code>Dashboard</code></a>]]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_descriptiondescription-5">set_description(description)<a href="#set_descriptiondescription-5" class="hash-link" aria-label="Direct link to set_description(description)" title="Direct link to set_description(description)"></a></h4><p>Set the description of the dashboard.</p><ul><li><strong>Parameters:</strong><strong>description</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_display_namedisplay_name-1">set_display_name(display_name)<a href="#set_display_namedisplay_name-1" class="hash-link" aria-label="Direct link to set_display_name(display_name)" title="Direct link to set_display_name(display_name)"></a></h4><p>Set the display name of the dashboard.</p><ul><li><strong>Parameters:</strong><strong>display_name</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_external_urlexternal_url-4">set_external_url(external_url)<a href="#set_external_urlexternal_url-4" class="hash-link" aria-label="Direct link to set_external_url(external_url)" title="Direct link to set_external_url(external_url)"></a></h4><p>Set the external URL of the dashboard.</p><ul><li><strong>Parameters:</strong><strong>external_url</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_input_datasetsinput_datasets">set_input_datasets(input_datasets)<a href="#set_input_datasetsinput_datasets" class="hash-link" aria-label="Direct link to set_input_datasets(input_datasets)" title="Direct link to set_input_datasets(input_datasets)"></a></h4><p>Set the input datasets of the dashboard.</p><ul><li><strong>Parameters:</strong><strong>input_datasets</strong> (<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>, <a href="#datahub.sdk.dataset.Dataset"><code>Dataset</code></a>]]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_last_modifiedlast_modified-4">set_last_modified(last_modified)<a href="#set_last_modifiedlast_modified-4" class="hash-link" aria-label="Direct link to set_last_modified(last_modified)" title="Direct link to set_last_modified(last_modified)"></a></h4><p>Set the last modification timestamp of the dashboard.</p><ul><li><strong>Parameters:</strong><strong>last_modified</strong> (<code>datetime</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_last_refreshedlast_refreshed">set_last_refreshed(last_refreshed)<a href="#set_last_refreshedlast_refreshed" class="hash-link" aria-label="Direct link to set_last_refreshed(last_refreshed)" title="Direct link to set_last_refreshed(last_refreshed)"></a></h4><p>Set the last refresh timestamp of the dashboard.</p><ul><li><strong>Parameters:</strong><strong>last_refreshed</strong> (<code>datetime</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_titletitle">set_title(title)<a href="#set_titletitle" class="hash-link" aria-label="Direct link to set_title(title)" title="Direct link to set_title(title)"></a></h4><p>Set the title of the dashboard.</p><ul><li><strong>Parameters:</strong><strong>title</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><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>Get the title of the dashboard.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--dashboardurn"><em>property</em> urn <em>: <a href="/docs/python-sdk/urns#datahub.metadata.urns.DashboardUrn">DashboardUrn</a></em><a href="#property-urn--dashboardurn" class="hash-link" aria-label="Direct link to property-urn--dashboardurn" title="Direct link to property-urn--dashboardurn"></a></h4><p>Get the entity’s URN.</p><ul><li><strong>Returns:</strong>
|
||
The URN that uniquely identifies this entity.</li></ul></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.sdk.chart.Chart"><span class="visually-hidden">Chart</span><a href="#datahub.sdk.chart.Chart" class="hash-link" aria-label="Direct link to datahub.sdk.chart.Chart" title="Direct link to datahub.sdk.chart.Chart"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.sdk.chart.</span><span class="class-name">Chart</span>(*, <span class="arg-name">name</span>, <span class="arg-name">platform</span>, <span class="arg-name">display_name</span> = <span class="arg-default">None</span>, <span class="arg-name">platform_instance</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">''</span>, <span class="arg-name">external_url</span> = <span class="arg-default">None</span>, <span class="arg-name">chart_url</span> = <span class="arg-default">None</span>, <span class="arg-name">custom_properties</span> = <span class="arg-default">None</span>, <span class="arg-name">last_modified</span> = <span class="arg-default">None</span>, <span class="arg-name">last_refreshed</span> = <span class="arg-default">None</span>, <span class="arg-name">chart_type</span> = <span class="arg-default">None</span>, <span class="arg-name">access</span> = <span class="arg-default">None</span>, <span class="arg-name">subtype</span> = <span class="arg-default">None</span>, <span class="arg-name">owners</span> = <span class="arg-default">None</span>, <span class="arg-name">links</span> = <span class="arg-default">None</span>, <span class="arg-name">tags</span> = <span class="arg-default">None</span>, <span class="arg-name">terms</span> = <span class="arg-default">None</span>, <span class="arg-name">domain</span> = <span class="arg-default">None</span>, <span class="arg-name">input_datasets</span> = <span class="arg-default">None</span>, <span class="arg-name">extra_aspects</span> = <span class="arg-default">None</span>)<a href="#datahub.sdk.chart.Chart" class="hash-link"></a></div><p>Bases: <code>HasPlatformInstance</code>, <code>HasSubtype</code>, <code>HasOwnership</code>, <code>HasContainer</code>, <code>HasInstitutionalMemory</code>, <code>HasTags</code>, <code>HasTerms</code>, <code>HasDomain</code>, <code>Entity</code></p><p>Represents a chart in DataHub.</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>platform</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataPlatformUrn"><code>DataPlatformUrn</code></a>]) – </li><li><strong>display_name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>platform_instance</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataPlatformInstanceUrn"><code>DataPlatformInstanceUrn</code></a>, <code>None</code>]) – </li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>external_url</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>chart_url</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>custom_properties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>last_modified</strong> (<code>Optional</code>[<code>datetime</code>]<!-- -->)</li><li><strong>last_refreshed</strong> (<code>Optional</code>[<code>datetime</code>]<!-- -->)</li><li><strong>chart_type</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.ChartTypeClass"><code>ChartTypeClass</code></a>, <code>None</code>]) – </li><li><strong>access</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>subtype</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>owners</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpUserUrn"><code>CorpUserUrn</code></a>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpGroupUrn"><code>CorpGroupUrn</code></a>, <code>Tuple</code>[<code>Union</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpUserUrn"><code>CorpUserUrn</code></a>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpGroupUrn"><code>CorpGroupUrn</code></a>], <code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.OwnershipTypeUrn"><code>OwnershipTypeUrn</code></a>]], <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.OwnerClass"><code>OwnerClass</code></a>]]]) – </li><li><strong>links</strong> (<code>Optional</code>[<code>Sequence</code>[<code>Union</code>[<code>str</code>, <code>Tuple</code>[<code>str</code>, <code>str</code>]<!-- -->, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass"><code>InstitutionalMemoryMetadataClass</code></a>]]]) – </li><li><strong>tags</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.TagUrn"><code>TagUrn</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.TagAssociationClass"><code>TagAssociationClass</code></a>]]]) – </li><li><strong>terms</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.GlossaryTermUrn"><code>GlossaryTermUrn</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.GlossaryTermAssociationClass"><code>GlossaryTermAssociationClass</code></a>]]]) – </li><li><strong>domain</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DomainUrn"><code>DomainUrn</code></a>, <code>None</code>]) – </li><li><strong>input_datasets</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>, <a href="#datahub.sdk.dataset.Dataset"><code>Dataset</code></a>]]]) – </li><li><strong>extra_aspects</strong> (<code>Optional</code>[<code>List</code>[<code>TypeVar</code>(<code>Aspect</code>, bound= <code>_Aspect</code>)]<!-- -->]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-access--str--none"><em>property</em> access <em>: str | None</em><a href="#property-access--str--none" class="hash-link" aria-label="Direct link to property-access--str--none" title="Direct link to property-access--str--none"></a></h4><p>Get the access level of the chart as a string.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="add_input_datasetinput_dataset-1">add_input_dataset(input_dataset)<a href="#add_input_datasetinput_dataset-1" class="hash-link" aria-label="Direct link to add_input_dataset(input_dataset)" title="Direct link to add_input_dataset(input_dataset)"></a></h4><p>Add an input to the chart.</p><ul><li><strong>Parameters:</strong><strong>input_dataset</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>, <a href="#datahub.sdk.dataset.Dataset"><code>Dataset</code></a>]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-chart_type--str--none"><em>property</em> chart_type <em>: str | None</em><a href="#property-chart_type--str--none" class="hash-link" aria-label="Direct link to property-chart_type--str--none" title="Direct link to property-chart_type--str--none"></a></h4><p>Get the type of the chart as a string.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-chart_url--str--none"><em>property</em> chart_url <em>: str | None</em><a href="#property-chart_url--str--none" class="hash-link" aria-label="Direct link to property-chart_url--str--none" title="Direct link to property-chart_url--str--none"></a></h4><p>Get the chart URL.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-custom_properties--dictstr-str-2"><em>property</em> custom_properties <em>: Dict<!-- -->[str, str]</em><a href="#property-custom_properties--dictstr-str-2" class="hash-link" aria-label="Direct link to property-custom_properties--dictstr-str-2" title="Direct link to property-custom_properties--dictstr-str-2"></a></h4><p>Get the custom properties of the chart.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--str--none-6"><em>property</em> description <em>: str | None</em><a href="#property-description--str--none-6" class="hash-link" aria-label="Direct link to property-description--str--none-6" title="Direct link to property-description--str--none-6"></a></h4><p>Get the description of the chart.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-display_name--str--none-2"><em>property</em> display_name <em>: str | None</em><a href="#property-display_name--str--none-2" class="hash-link" aria-label="Direct link to property-display_name--str--none-2" title="Direct link to property-display_name--str--none-2"></a></h4><p>Get the display name of the chart.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-external_url--str--none-5"><em>property</em> external_url <em>: str | None</em><a href="#property-external_url--str--none-5" class="hash-link" aria-label="Direct link to property-external_url--str--none-5" title="Direct link to property-external_url--str--none-5"></a></h4><p>Get the external URL of the chart.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="classmethod-get_urn_type-5"><em>classmethod</em> get_urn_type()<a href="#classmethod-get_urn_type-5" class="hash-link" aria-label="Direct link to classmethod-get_urn_type-5" title="Direct link to classmethod-get_urn_type-5"></a></h4><p>Get the URN type for charts.
|
||
:rtype: <code>Type</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.ChartUrn"><code>ChartUrn</code></a>]
|
||
:returns: The ChartUrn class.</p><ul><li><strong>Return type:</strong><em>Type</em>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.ChartUrn"><em>ChartUrn</em></a>]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-input_datasets--listdataseturn-1"><em>property</em> input_datasets <em>: List[<a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn">DatasetUrn</a>]</em><a href="#property-input_datasets--listdataseturn-1" class="hash-link" aria-label="Direct link to property-input_datasets--listdataseturn-1" title="Direct link to property-input_datasets--listdataseturn-1"></a></h4><p>Get the input datasets of the chart.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-last_modified--datetime--none-5"><em>property</em> last_modified <em>: datetime | None</em><a href="#property-last_modified--datetime--none-5" class="hash-link" aria-label="Direct link to property-last_modified--datetime--none-5" title="Direct link to property-last_modified--datetime--none-5"></a></h4><p>Get the last modification timestamp of the chart.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-last_refreshed--datetime--none-1"><em>property</em> last_refreshed <em>: datetime | None</em><a href="#property-last_refreshed--datetime--none-1" class="hash-link" aria-label="Direct link to property-last_refreshed--datetime--none-1" title="Direct link to property-last_refreshed--datetime--none-1"></a></h4><p>Get the last refresh timestamp of the chart.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-1"><em>property</em> name <em>: str</em><a href="#property-name--str-1" class="hash-link" aria-label="Direct link to property-name--str-1" title="Direct link to property-name--str-1"></a></h4><p>Get the name of the chart.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="remove_input_datasetinput_dataset-1">remove_input_dataset(input_dataset)<a href="#remove_input_datasetinput_dataset-1" class="hash-link" aria-label="Direct link to remove_input_dataset(input_dataset)" title="Direct link to remove_input_dataset(input_dataset)"></a></h4><p>Remove an input from the chart.</p><ul><li><strong>Parameters:</strong><strong>input_dataset</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>, <a href="#datahub.sdk.dataset.Dataset"><code>Dataset</code></a>]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_accessaccess">set_access(access)<a href="#set_accessaccess" class="hash-link" aria-label="Direct link to set_access(access)" title="Direct link to set_access(access)"></a></h4><p>Set the access level of the chart.</p><ul><li><strong>Parameters:</strong><strong>access</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.AccessLevelClass"><code>AccessLevelClass</code></a>]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_chart_typechart_type">set_chart_type(chart_type)<a href="#set_chart_typechart_type" class="hash-link" aria-label="Direct link to set_chart_type(chart_type)" title="Direct link to set_chart_type(chart_type)"></a></h4><p>Set the type of the chart.</p><ul><li><strong>Parameters:</strong><strong>chart_type</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.ChartTypeClass"><code>ChartTypeClass</code></a>]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_chart_urlchart_url">set_chart_url(chart_url)<a href="#set_chart_urlchart_url" class="hash-link" aria-label="Direct link to set_chart_url(chart_url)" title="Direct link to set_chart_url(chart_url)"></a></h4><p>Set the chart URL.</p><ul><li><strong>Parameters:</strong><strong>chart_url</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_custom_propertiescustom_properties-5">set_custom_properties(custom_properties)<a href="#set_custom_propertiescustom_properties-5" class="hash-link" aria-label="Direct link to set_custom_properties(custom_properties)" title="Direct link to set_custom_properties(custom_properties)"></a></h4><p>Set the custom properties of the chart.</p><ul><li><strong>Parameters:</strong><strong>custom_properties</strong> (<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_descriptiondescription-6">set_description(description)<a href="#set_descriptiondescription-6" class="hash-link" aria-label="Direct link to set_description(description)" title="Direct link to set_description(description)"></a></h4><p>Set the description of the chart.</p><ul><li><strong>Parameters:</strong><strong>description</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_display_namedisplay_name-2">set_display_name(display_name)<a href="#set_display_namedisplay_name-2" class="hash-link" aria-label="Direct link to set_display_name(display_name)" title="Direct link to set_display_name(display_name)"></a></h4><p>Set the display name of the chart.</p><ul><li><strong>Parameters:</strong><strong>display_name</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_external_urlexternal_url-5">set_external_url(external_url)<a href="#set_external_urlexternal_url-5" class="hash-link" aria-label="Direct link to set_external_url(external_url)" title="Direct link to set_external_url(external_url)"></a></h4><p>Set the external URL of the chart.</p><ul><li><strong>Parameters:</strong><strong>external_url</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_input_datasetsinput_datasets-1">set_input_datasets(input_datasets)<a href="#set_input_datasetsinput_datasets-1" class="hash-link" aria-label="Direct link to set_input_datasets(input_datasets)" title="Direct link to set_input_datasets(input_datasets)"></a></h4><p>Set the input datasets of the chart.</p><ul><li><strong>Parameters:</strong><strong>input_datasets</strong> (<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>, <a href="#datahub.sdk.dataset.Dataset"><code>Dataset</code></a>]]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_last_modifiedlast_modified-5">set_last_modified(last_modified)<a href="#set_last_modifiedlast_modified-5" class="hash-link" aria-label="Direct link to set_last_modified(last_modified)" title="Direct link to set_last_modified(last_modified)"></a></h4><p>Set the last modification timestamp of the chart.</p><ul><li><strong>Parameters:</strong><strong>last_modified</strong> (<code>datetime</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_last_refreshedlast_refreshed-1">set_last_refreshed(last_refreshed)<a href="#set_last_refreshedlast_refreshed-1" class="hash-link" aria-label="Direct link to set_last_refreshed(last_refreshed)" title="Direct link to set_last_refreshed(last_refreshed)"></a></h4><p>Set the last refresh timestamp of the chart.</p><ul><li><strong>Parameters:</strong><strong>last_refreshed</strong> (<code>datetime</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_titletitle-1">set_title(title)<a href="#set_titletitle-1" class="hash-link" aria-label="Direct link to set_title(title)" title="Direct link to set_title(title)"></a></h4><p>Set the title of the chart.</p><ul><li><strong>Parameters:</strong><strong>title</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><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>Get the title of the chart.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--charturn"><em>property</em> urn <em>: <a href="/docs/python-sdk/urns#datahub.metadata.urns.ChartUrn">ChartUrn</a></em><a href="#property-urn--charturn" class="hash-link" aria-label="Direct link to property-urn--charturn" title="Direct link to property-urn--charturn"></a></h4><p>Get the entity’s URN.</p><ul><li><strong>Returns:</strong>
|
||
The URN that uniquely identifies this entity.</li></ul></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.sdk.datajob.DataJob"><span class="visually-hidden">DataJob</span><a href="#datahub.sdk.datajob.DataJob" class="hash-link" aria-label="Direct link to datahub.sdk.datajob.DataJob" title="Direct link to datahub.sdk.datajob.DataJob"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.sdk.datajob.</span><span class="class-name">DataJob</span>(*, <span class="arg-name">name</span>, <span class="arg-name">flow</span> = <span class="arg-default">None</span>, <span class="arg-name">flow_urn</span> = <span class="arg-default">None</span>, <span class="arg-name">platform_instance</span> = <span class="arg-default">None</span>, <span class="arg-name">display_name</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">external_url</span> = <span class="arg-default">None</span>, <span class="arg-name">custom_properties</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">last_modified</span> = <span class="arg-default">None</span>, <span class="arg-name">subtype</span> = <span class="arg-default">None</span>, <span class="arg-name">owners</span> = <span class="arg-default">None</span>, <span class="arg-name">links</span> = <span class="arg-default">None</span>, <span class="arg-name">tags</span> = <span class="arg-default">None</span>, <span class="arg-name">terms</span> = <span class="arg-default">None</span>, <span class="arg-name">domain</span> = <span class="arg-default">None</span>, <span class="arg-name">inlets</span> = <span class="arg-default">None</span>, <span class="arg-name">outlets</span> = <span class="arg-default">None</span>, <span class="arg-name">structured_properties</span> = <span class="arg-default">None</span>, <span class="arg-name">extra_aspects</span> = <span class="arg-default">None</span>)<a href="#datahub.sdk.datajob.DataJob" class="hash-link"></a></div><p>Bases: <code>HasPlatformInstance</code>, <code>HasSubtype</code>, <code>HasContainer</code>, <code>HasOwnership</code>, <code>HasInstitutionalMemory</code>, <code>HasTags</code>, <code>HasTerms</code>, <code>HasDomain</code>, <code>HasStructuredProperties</code>, <code>Entity</code></p><p>Represents a data job in DataHub.
|
||
A data job is an executable unit of a data pipeline, such as an Airflow task or a Spark job.</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>flow</strong> (<code>Optional</code>[<a href="#datahub.sdk.dataflow.DataFlow"><code>DataFlow</code></a>]) – </li><li><strong>flow_urn</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataFlowUrn"><code>DataFlowUrn</code></a>, <code>None</code>]) – </li><li><strong>platform_instance</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>display_name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>external_url</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>custom_properties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>created</strong> (<code>Optional</code>[<code>datetime</code>]<!-- -->)</li><li><strong>last_modified</strong> (<code>Optional</code>[<code>datetime</code>]<!-- -->)</li><li><strong>subtype</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>owners</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpUserUrn"><code>CorpUserUrn</code></a>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpGroupUrn"><code>CorpGroupUrn</code></a>, <code>Tuple</code>[<code>Union</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpUserUrn"><code>CorpUserUrn</code></a>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpGroupUrn"><code>CorpGroupUrn</code></a>], <code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.OwnershipTypeUrn"><code>OwnershipTypeUrn</code></a>]], <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.OwnerClass"><code>OwnerClass</code></a>]]]) – </li><li><strong>links</strong> (<code>Optional</code>[<code>Sequence</code>[<code>Union</code>[<code>str</code>, <code>Tuple</code>[<code>str</code>, <code>str</code>]<!-- -->, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass"><code>InstitutionalMemoryMetadataClass</code></a>]]]) – </li><li><strong>tags</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.TagUrn"><code>TagUrn</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.TagAssociationClass"><code>TagAssociationClass</code></a>]]]) – </li><li><strong>terms</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.GlossaryTermUrn"><code>GlossaryTermUrn</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.GlossaryTermAssociationClass"><code>GlossaryTermAssociationClass</code></a>]]]) – </li><li><strong>domain</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DomainUrn"><code>DomainUrn</code></a>, <code>None</code>]) – </li><li><strong>inlets</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>]]]) – </li><li><strong>outlets</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>]]]) – </li><li><strong>structured_properties</strong> (<code>Optional</code>[<code>Dict</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.StructuredPropertyUrn"><code>StructuredPropertyUrn</code></a>], <code>Sequence</code>[<code>Union</code>[<code>str</code>, <code>float</code>, <code>int</code>]<!-- -->]]]) – </li><li><strong>extra_aspects</strong> (<code>Optional</code>[<code>List</code>[<code>TypeVar</code>(<code>Aspect</code>, bound= <code>_Aspect</code>)]<!-- -->]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--datetime--none-4"><em>property</em> created <em>: datetime | None</em><a href="#property-created--datetime--none-4" class="hash-link" aria-label="Direct link to property-created--datetime--none-4" title="Direct link to property-created--datetime--none-4"></a></h4><p>Get the creation timestamp of the data job.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-custom_properties--dictstr-str-3"><em>property</em> custom_properties <em>: Dict<!-- -->[str, str]</em><a href="#property-custom_properties--dictstr-str-3" class="hash-link" aria-label="Direct link to property-custom_properties--dictstr-str-3" title="Direct link to property-custom_properties--dictstr-str-3"></a></h4><p>Get the custom properties of the data job.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--str--none-7"><em>property</em> description <em>: str | None</em><a href="#property-description--str--none-7" class="hash-link" aria-label="Direct link to property-description--str--none-7" title="Direct link to property-description--str--none-7"></a></h4><p>Get the description of the data job.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-display_name--str--none-3"><em>property</em> display_name <em>: str | None</em><a href="#property-display_name--str--none-3" class="hash-link" aria-label="Direct link to property-display_name--str--none-3" title="Direct link to property-display_name--str--none-3"></a></h4><p>Get the display name of the data job.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-external_url--str--none-6"><em>property</em> external_url <em>: str | None</em><a href="#property-external_url--str--none-6" class="hash-link" aria-label="Direct link to property-external_url--str--none-6" title="Direct link to property-external_url--str--none-6"></a></h4><p>Get the external URL of the data job.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-flow_urn--dataflowurn"><em>property</em> flow_urn <em>: <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataFlowUrn">DataFlowUrn</a></em><a href="#property-flow_urn--dataflowurn" class="hash-link" aria-label="Direct link to property-flow_urn--dataflowurn" title="Direct link to property-flow_urn--dataflowurn"></a></h4><p>Get the data flow associated with the data job.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="classmethod-get_urn_type-6"><em>classmethod</em> get_urn_type()<a href="#classmethod-get_urn_type-6" class="hash-link" aria-label="Direct link to classmethod-get_urn_type-6" title="Direct link to classmethod-get_urn_type-6"></a></h4><p>Get the URN type for data jobs.</p><ul><li><strong>Return type:</strong><code>Type</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.DataJobUrn"><code>DataJobUrn</code></a>]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-inlets--listdataseturn"><em>property</em> inlets <em>: List[<a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn">DatasetUrn</a>]</em><a href="#property-inlets--listdataseturn" class="hash-link" aria-label="Direct link to property-inlets--listdataseturn" title="Direct link to property-inlets--listdataseturn"></a></h4><p>Get the inlets of the data job.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-last_modified--datetime--none-6"><em>property</em> last_modified <em>: datetime | None</em><a href="#property-last_modified--datetime--none-6" class="hash-link" aria-label="Direct link to property-last_modified--datetime--none-6" title="Direct link to property-last_modified--datetime--none-6"></a></h4><p>Get the last modification timestamp of the data job.</p><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>Get the name of the data job.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-outlets--listdataseturn"><em>property</em> outlets <em>: List[<a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn">DatasetUrn</a>]</em><a href="#property-outlets--listdataseturn" class="hash-link" aria-label="Direct link to property-outlets--listdataseturn" title="Direct link to property-outlets--listdataseturn"></a></h4><p>Get the outlets of the data job.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_createdcreated-4">set_created(created)<a href="#set_createdcreated-4" class="hash-link" aria-label="Direct link to set_created(created)" title="Direct link to set_created(created)"></a></h4><p>Set the creation timestamp of the data job.</p><ul><li><strong>Parameters:</strong><strong>created</strong> (<code>datetime</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_custom_propertiescustom_properties-6">set_custom_properties(custom_properties)<a href="#set_custom_propertiescustom_properties-6" class="hash-link" aria-label="Direct link to set_custom_properties(custom_properties)" title="Direct link to set_custom_properties(custom_properties)"></a></h4><p>Set the custom properties of the data job.</p><ul><li><strong>Parameters:</strong><strong>custom_properties</strong> (<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_descriptiondescription-7">set_description(description)<a href="#set_descriptiondescription-7" class="hash-link" aria-label="Direct link to set_description(description)" title="Direct link to set_description(description)"></a></h4><p>Set the description of the data job.</p><ul><li><strong>Parameters:</strong><strong>description</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_display_namedisplay_name-3">set_display_name(display_name)<a href="#set_display_namedisplay_name-3" class="hash-link" aria-label="Direct link to set_display_name(display_name)" title="Direct link to set_display_name(display_name)"></a></h4><p>Set the display name of the data job.</p><ul><li><strong>Parameters:</strong><strong>display_name</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_external_urlexternal_url-6">set_external_url(external_url)<a href="#set_external_urlexternal_url-6" class="hash-link" aria-label="Direct link to set_external_url(external_url)" title="Direct link to set_external_url(external_url)"></a></h4><p>Set the external URL of the data job.</p><ul><li><strong>Parameters:</strong><strong>external_url</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_inletsinlets">set_inlets(inlets)<a href="#set_inletsinlets" class="hash-link" aria-label="Direct link to set_inlets(inlets)" title="Direct link to set_inlets(inlets)"></a></h4><p>Set the inlets of the data job.</p><ul><li><strong>Parameters:</strong><strong>inlets</strong> (<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>]]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_last_modifiedlast_modified-6">set_last_modified(last_modified)<a href="#set_last_modifiedlast_modified-6" class="hash-link" aria-label="Direct link to set_last_modified(last_modified)" title="Direct link to set_last_modified(last_modified)"></a></h4><p>Set the last modification timestamp of the data job.</p><ul><li><strong>Parameters:</strong><strong>last_modified</strong> (<code>datetime</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_outletsoutlets">set_outlets(outlets)<a href="#set_outletsoutlets" class="hash-link" aria-label="Direct link to set_outlets(outlets)" title="Direct link to set_outlets(outlets)"></a></h4><p>Set the outlets of the data job.</p><ul><li><strong>Parameters:</strong><strong>outlets</strong> (<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>]]) – </li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--datajoburn"><em>property</em> urn <em>: <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataJobUrn">DataJobUrn</a></em><a href="#property-urn--datajoburn" class="hash-link" aria-label="Direct link to property-urn--datajoburn" title="Direct link to property-urn--datajoburn"></a></h4><p>Get the entity’s URN.</p><ul><li><strong>Returns:</strong>
|
||
The URN that uniquely identifies this entity.</li></ul></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.sdk.dataflow.DataFlow"><span class="visually-hidden">DataFlow</span><a href="#datahub.sdk.dataflow.DataFlow" class="hash-link" aria-label="Direct link to datahub.sdk.dataflow.DataFlow" title="Direct link to datahub.sdk.dataflow.DataFlow"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.sdk.dataflow.</span><span class="class-name">DataFlow</span>(*, <span class="arg-name">name</span>, <span class="arg-name">platform</span>, <span class="arg-name">display_name</span> = <span class="arg-default">None</span>, <span class="arg-name">platform_instance</span> = <span class="arg-default">None</span>, <span class="arg-name">env</span> = <span class="arg-default">'PROD'</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">external_url</span> = <span class="arg-default">None</span>, <span class="arg-name">custom_properties</span> = <span class="arg-default">None</span>, <span class="arg-name">created</span> = <span class="arg-default">None</span>, <span class="arg-name">last_modified</span> = <span class="arg-default">None</span>, <span class="arg-name">subtype</span> = <span class="arg-default">None</span>, <span class="arg-name">owners</span> = <span class="arg-default">None</span>, <span class="arg-name">links</span> = <span class="arg-default">None</span>, <span class="arg-name">tags</span> = <span class="arg-default">None</span>, <span class="arg-name">terms</span> = <span class="arg-default">None</span>, <span class="arg-name">domain</span> = <span class="arg-default">None</span>, <span class="arg-name">parent_container</span> = <span class="arg-default">Unset.token</span>, <span class="arg-name">structured_properties</span> = <span class="arg-default">None</span>, <span class="arg-name">extra_aspects</span> = <span class="arg-default">None</span>)<a href="#datahub.sdk.dataflow.DataFlow" class="hash-link"></a></div><p>Bases: <code>HasPlatformInstance</code>, <code>HasSubtype</code>, <code>HasOwnership</code>, <code>HasContainer</code>, <code>HasInstitutionalMemory</code>, <code>HasTags</code>, <code>HasTerms</code>, <code>HasDomain</code>, <code>HasStructuredProperties</code>, <code>Entity</code></p><p>Represents a dataflow in DataHub.
|
||
A dataflow represents a collection of data, such as a table, view, or file.
|
||
This class provides methods for managing dataflow metadata including schema,
|
||
lineage, and various aspects like ownership, tags, and terms.</p><ul><li><strong>Parameters:</strong><ul><li><strong>name</strong> (<code>str</code>)</li><li><strong>platform</strong> (<code>str</code>)</li><li><strong>display_name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>platform_instance</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>env</strong> (<code>str</code>)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>external_url</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>custom_properties</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>created</strong> (<code>Optional</code>[<code>datetime</code>]<!-- -->)</li><li><strong>last_modified</strong> (<code>Optional</code>[<code>datetime</code>]<!-- -->)</li><li><strong>subtype</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>owners</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpUserUrn"><code>CorpUserUrn</code></a>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpGroupUrn"><code>CorpGroupUrn</code></a>, <code>Tuple</code>[<code>Union</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpUserUrn"><code>CorpUserUrn</code></a>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.CorpGroupUrn"><code>CorpGroupUrn</code></a>], <code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.OwnershipTypeUrn"><code>OwnershipTypeUrn</code></a>]], <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.OwnerClass"><code>OwnerClass</code></a>]]]) – </li><li><strong>links</strong> (<code>Optional</code>[<code>Sequence</code>[<code>Union</code>[<code>str</code>, <code>Tuple</code>[<code>str</code>, <code>str</code>]<!-- -->, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass"><code>InstitutionalMemoryMetadataClass</code></a>]]]) – </li><li><strong>tags</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.TagUrn"><code>TagUrn</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.TagAssociationClass"><code>TagAssociationClass</code></a>]]]) – </li><li><strong>terms</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.GlossaryTermUrn"><code>GlossaryTermUrn</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.GlossaryTermAssociationClass"><code>GlossaryTermAssociationClass</code></a>]]]) – </li><li><strong>domain</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DomainUrn"><code>DomainUrn</code></a>, <code>None</code>]) – </li><li><strong>parent_container</strong> (<code>Union</code>[<a href="#datahub.sdk.container.Container"><code>Container</code></a>, <a href="/docs/python-sdk/builder/mcp-builder#datahub.emitter.mcp_builder.ContainerKey"><code>ContainerKey</code></a>, <code>List</code>[<code>Union</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.Urn"><code>Urn</code></a>, <code>str</code>]], <code>Unset</code>]) – </li><li><strong>structured_properties</strong> (<code>Optional</code>[<code>Dict</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.StructuredPropertyUrn"><code>StructuredPropertyUrn</code></a>], <code>Sequence</code>[<code>Union</code>[<code>str</code>, <code>float</code>, <code>int</code>]<!-- -->]]]) – </li><li><strong>extra_aspects</strong> (<code>Optional</code>[<code>List</code>[<code>TypeVar</code>(<code>Aspect</code>, bound= <code>_Aspect</code>)]<!-- -->]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-created--datetime--none-5"><em>property</em> created <em>: datetime | None</em><a href="#property-created--datetime--none-5" class="hash-link" aria-label="Direct link to property-created--datetime--none-5" title="Direct link to property-created--datetime--none-5"></a></h4><p>Get the creation timestamp of the dataflow.
|
||
:returns: The creation timestamp if set, None otherwise.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-custom_properties--dictstr-str-4"><em>property</em> custom_properties <em>: Dict<!-- -->[str, str]</em><a href="#property-custom_properties--dictstr-str-4" class="hash-link" aria-label="Direct link to property-custom_properties--dictstr-str-4" title="Direct link to property-custom_properties--dictstr-str-4"></a></h4><p>Get the custom properties of the dataflow.
|
||
:returns: Dictionary of custom properties.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-description--str--none-8"><em>property</em> description <em>: str | None</em><a href="#property-description--str--none-8" class="hash-link" aria-label="Direct link to property-description--str--none-8" title="Direct link to property-description--str--none-8"></a></h4><p>Get the description of the dataflow.
|
||
:returns: The description if set, None otherwise.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-display_name--str--none-4"><em>property</em> display_name <em>: str | None</em><a href="#property-display_name--str--none-4" class="hash-link" aria-label="Direct link to property-display_name--str--none-4" title="Direct link to property-display_name--str--none-4"></a></h4><p>Get the display name of the dataflow.
|
||
:returns: The display name if set, None otherwise.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-env--str--fabrictypeclass--none"><em>property</em> env <em>: str | <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.FabricTypeClass">FabricTypeClass</a> | None</em><a href="#property-env--str--fabrictypeclass--none" class="hash-link" aria-label="Direct link to property-env--str--fabrictypeclass--none" title="Direct link to property-env--str--fabrictypeclass--none"></a></h4><p>Get the environment of the dataflow.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-external_url--str--none-7"><em>property</em> external_url <em>: str | None</em><a href="#property-external_url--str--none-7" class="hash-link" aria-label="Direct link to property-external_url--str--none-7" title="Direct link to property-external_url--str--none-7"></a></h4><p>Get the external URL of the dataflow.
|
||
:returns: The external URL if set, None otherwise.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="classmethod-get_urn_type-7"><em>classmethod</em> get_urn_type()<a href="#classmethod-get_urn_type-7" class="hash-link" aria-label="Direct link to classmethod-get_urn_type-7" title="Direct link to classmethod-get_urn_type-7"></a></h4><p>Get the URN type for dataflows.
|
||
:rtype: <code>Type</code>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.DataFlowUrn"><code>DataFlowUrn</code></a>]
|
||
:returns: The DataflowUrn class.</p><ul><li><strong>Return type:</strong><em>Type</em>[<a href="/docs/python-sdk/urns#datahub.metadata.urns.DataFlowUrn"><em>DataFlowUrn</em></a>]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-last_modified--datetime--none-7"><em>property</em> last_modified <em>: datetime | None</em><a href="#property-last_modified--datetime--none-7" class="hash-link" aria-label="Direct link to property-last_modified--datetime--none-7" title="Direct link to property-last_modified--datetime--none-7"></a></h4><p>Get the last modification timestamp of the dataflow.
|
||
:returns: The last modification timestamp if set, None otherwise.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-name--str-3"><em>property</em> name <em>: str</em><a href="#property-name--str-3" class="hash-link" aria-label="Direct link to property-name--str-3" title="Direct link to property-name--str-3"></a></h4><p>Get the name of the dataflow.
|
||
:returns: The name of the dataflow.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_createdcreated-5">set_created(created)<a href="#set_createdcreated-5" class="hash-link" aria-label="Direct link to set_created(created)" title="Direct link to set_created(created)"></a></h4><p>Set the creation timestamp of the dataflow.
|
||
:type created: <code>datetime</code>
|
||
:param created: The creation timestamp to set.</p><ul><li><strong>Return type:</strong><code>None</code></li><li><strong>Parameters:</strong><strong>created</strong> (<em>datetime</em>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_custom_propertiescustom_properties-7">set_custom_properties(custom_properties)<a href="#set_custom_propertiescustom_properties-7" class="hash-link" aria-label="Direct link to set_custom_properties(custom_properties)" title="Direct link to set_custom_properties(custom_properties)"></a></h4><p>Set the custom properties of the dataflow.
|
||
:type custom_properties: <code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->
|
||
:param custom_properties: Dictionary of custom properties to set.</p><ul><li><strong>Return type:</strong><code>None</code></li><li><strong>Parameters:</strong><strong>custom_properties</strong> (<em>Dict</em> <em>[<strong>str</strong>,<strong>str</strong>]</em>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_descriptiondescription-8">set_description(description)<a href="#set_descriptiondescription-8" class="hash-link" aria-label="Direct link to set_description(description)" title="Direct link to set_description(description)"></a></h4><p>Set the description of the dataflow.
|
||
:type description: <code>str</code>
|
||
:param description: The description to set.
|
||
:rtype: <code>None</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="note-1">NOTE<a href="#note-1" class="hash-link" aria-label="Direct link to NOTE" title="Direct link to NOTE"></a></h4><p>If called during ingestion, this will warn if overwriting
|
||
a non-ingestion description.</p><ul><li><strong>Parameters:</strong><strong>description</strong> (<em>str</em>)</li><li><strong>Return type:</strong>
|
||
None</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_display_namedisplay_name-4">set_display_name(display_name)<a href="#set_display_namedisplay_name-4" class="hash-link" aria-label="Direct link to set_display_name(display_name)" title="Direct link to set_display_name(display_name)"></a></h4><p>Set the display name of the dataflow.
|
||
:type display_name: <code>str</code>
|
||
:param display_name: The display name to set.</p><ul><li><strong>Return type:</strong><code>None</code></li><li><strong>Parameters:</strong><strong>display_name</strong> (<em>str</em>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_external_urlexternal_url-7">set_external_url(external_url)<a href="#set_external_urlexternal_url-7" class="hash-link" aria-label="Direct link to set_external_url(external_url)" title="Direct link to set_external_url(external_url)"></a></h4><p>Set the external URL of the dataflow.
|
||
:type external_url: <code>str</code>
|
||
:param external_url: The external URL to set.</p><ul><li><strong>Return type:</strong><code>None</code></li><li><strong>Parameters:</strong><strong>external_url</strong> (<em>str</em>)</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_last_modifiedlast_modified-7">set_last_modified(last_modified)<a href="#set_last_modifiedlast_modified-7" class="hash-link" aria-label="Direct link to set_last_modified(last_modified)" title="Direct link to set_last_modified(last_modified)"></a></h4><ul><li><strong>Parameters:</strong><strong>last_modified</strong> (<code>datetime</code>)</li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-urn--dataflowurn"><em>property</em> urn <em>: <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataFlowUrn">DataFlowUrn</a></em><a href="#property-urn--dataflowurn" class="hash-link" aria-label="Direct link to property-urn--dataflowurn" title="Direct link to property-urn--dataflowurn"></a></h4><p>Get the entity’s URN.</p><ul><li><strong>Returns:</strong>
|
||
The URN that uniquely identifies this entity.</li></ul></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="slackUtm_uoBr"><div class="slackUtm_uoBr"><hr>Need more help? Join the conversation in <a href="https://datahub.com/slack?utm_source=docs&utm_medium=footer&utm_campaign=docs_footer&utm_content=python-sdk/sdk-v2/entities">Slack!</a></div></div><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/datahub-project/datahub/blob/master/genDocs/python-sdk/sdk-v2/entities.mdx" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_VsjB"></div></div></footer><div class="feedbackWrapper_mUHF"><div class="feedbackWidget_PX4d"><div class="feedbackButtons_wn3V"><strong>Is this page helpful?</strong><div><button class="feedbackButton_UgQs"><span role="img" aria-label="like" class="anticon anticon-like"><svg viewBox="64 64 896 896" focusable="false" data-icon="like" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M885.9 533.7c16.8-22.2 26.1-49.4 26.1-77.7 0-44.9-25.1-87.4-65.5-111.1a67.67 67.67 0 00-34.3-9.3H572.4l6-122.9c1.4-29.7-9.1-57.9-29.5-79.4A106.62 106.62 0 00471 99.9c-52 0-98 35-111.8 85.1l-85.9 311H144c-17.7 0-32 14.3-32 32v364c0 17.7 14.3 32 32 32h601.3c9.2 0 18.2-1.8 26.5-5.4 47.6-20.3 78.3-66.8 78.3-118.4 0-12.6-1.8-25-5.4-37 16.8-22.2 26.1-49.4 26.1-77.7 0-12.6-1.8-25-5.4-37 16.8-22.2 26.1-49.4 26.1-77.7-.2-12.6-2-25.1-5.6-37.1zM184 852V568h81v284h-81zm636.4-353l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 16.5-7.2 32.2-19.6 43l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 16.5-7.2 32.2-19.6 43l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 22.4-13.2 42.6-33.6 51.8H329V564.8l99.5-360.5a44.1 44.1 0 0142.2-32.3c7.6 0 15.1 2.2 21.1 6.7 9.9 7.4 15.2 18.6 14.6 30.5l-9.6 198.4h314.4C829 418.5 840 436.9 840 456c0 16.5-7.2 32.1-19.6 43z"></path></svg></span></button><button class="feedbackButton_UgQs"><span role="img" aria-label="dislike" class="anticon anticon-dislike"><svg viewBox="64 64 896 896" focusable="false" data-icon="dislike" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M885.9 490.3c3.6-12 5.4-24.4 5.4-37 0-28.3-9.3-55.5-26.1-77.7 3.6-12 5.4-24.4 5.4-37 0-28.3-9.3-55.5-26.1-77.7 3.6-12 5.4-24.4 5.4-37 0-51.6-30.7-98.1-78.3-118.4a66.1 66.1 0 00-26.5-5.4H144c-17.7 0-32 14.3-32 32v364c0 17.7 14.3 32 32 32h129.3l85.8 310.8C372.9 889 418.9 924 470.9 924c29.7 0 57.4-11.8 77.9-33.4 20.5-21.5 31-49.7 29.5-79.4l-6-122.9h239.9c12.1 0 23.9-3.2 34.3-9.3 40.4-23.5 65.5-66.1 65.5-111 0-28.3-9.3-55.5-26.1-77.7zM184 456V172h81v284h-81zm627.2 160.4H496.8l9.6 198.4c.6 11.9-4.7 23.1-14.6 30.5-6.1 4.5-13.6 6.8-21.1 6.7a44.28 44.28 0 01-42.2-32.3L329 459.2V172h415.4a56.85 56.85 0 0133.6 51.8c0 9.7-2.3 18.9-6.9 27.3l-13.9 25.4 21.9 19a56.76 56.76 0 0119.6 43c0 9.7-2.3 18.9-6.9 27.3l-13.9 25.4 21.9 19a56.76 56.76 0 0119.6 43c0 9.7-2.3 18.9-6.9 27.3l-14 25.5 21.9 19a56.76 56.76 0 0119.6 43c0 19.1-11 37.5-28.8 48.4z"></path></svg></span></button></div></div></div></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/python-sdk/clients/rest-emitter"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Rest Emitter</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/python-sdk/sdk-v2/entity-client"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Entity Client</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#datahub.sdk.dataset.Dataset" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">Dataset</span></a></li><li><a href="#datahub.sdk.dataset.SchemaField" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">SchemaField</span></a></li><li><a href="#datahub.sdk.dataset.parse_cll_mapping" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">parse_cll_mapping</span></a></li><li><a href="#datahub.sdk.container.Container" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">Container</span></a></li><li><a href="#datahub.sdk.mlmodel.MLModel" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLModel</span></a></li><li><a href="#datahub.sdk.mlmodelgroup.MLModelGroup" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">MLModelGroup</span></a></li><li><a href="#datahub.sdk.dashboard.Dashboard" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">Dashboard</span></a></li><li><a href="#datahub.sdk.chart.Chart" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">Chart</span></a></li><li><a href="#datahub.sdk.datajob.DataJob" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataJob</span></a></li><li><a href="#datahub.sdk.dataflow.DataFlow" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">DataFlow</span></a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/">Introduction</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/quickstart">Quickstart</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://datahub.com/slack" target="_blank" rel="noopener noreferrer" class="footer__link-item">Slack<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.youtube.com/channel/UC3qFQC5IiwR5fvWEqi_tJ5w" target="_blank" rel="noopener noreferrer" class="footer__link-item">YouTube<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://medium.com/datahub-project" target="_blank" rel="noopener noreferrer" class="footer__link-item">Blog<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/docs/townhalls">Town Halls</a></li><li class="footer__item"><a href="https://datahub.com/adoption-stories/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Adoption<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://demo.datahub.com/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Demo</a></li><li class="footer__item"><a href="https://feature-requests.datahubproject.io/roadmap" target="_blank" rel="noopener noreferrer" class="footer__link-item">Roadmap<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/docs/contributing">Contributing</a></li><li class="footer__item"><a href="https://github.com/datahub-project/datahub" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://feature-requests.datahubproject.io/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Feature Requests<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2015-2025 DataHub Project Authors.</div></div></div></footer></div>
|
||
<script src="/assets/js/runtime~main.985d5e64.js"></script>
|
||
<script src="/assets/js/main.74c17b7b.js"></script>
|
||
</body>
|
||
</html> |