mirror of
https://github.com/datahub-project/datahub.git
synced 2025-07-28 03:49:37 +00:00
10726 lines
1.1 MiB
10726 lines
1.1 MiB
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-1.1.0 plugin-docs plugin-id-default docs-doc-id-python-sdk/urns" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v2.4.3">
|
||
<title data-rh="true">URNs | 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/1.1.0/python-sdk/urns"><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="1.1.0"><meta data-rh="true" name="docusaurus_tag" content="docs-default-1.1.0"><meta data-rh="true" name="docsearch:version" content="1.1.0"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-1.1.0"><meta data-rh="true" property="og:title" content="URNs | DataHub"><meta data-rh="true" name="description" content="\n\n\n\n\nclass datahub.metadata.urns.AssertionUrn(assertionid, *, allowcoercion=True)\nBases\n\nassertionid (Union[AssertionUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE str\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nAssertionUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type _SpecificUrn\n\nParameters ClassVar[Literal['businessAttribute']] = 'businessAttribute'\n\n\n\nclassmethod create_from_string(urn_str)\n\nParameters\nSelf\n\n\n\n\n\nproperty entity_ids str\n\n\n\nclassmethod from_key_aspect(key_aspect)\n\nParameters\nBusinessAttributeUrn\n\n\n\n\n\nclassmethod from_string(urn_str, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; urn = Urn.from_string(urn_str)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.from_string), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.from_string(urn_str)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic get_data_type_from_urn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentity_type (str)\n\nReturn type\nform (str)\n\nReturn type\nstructured_property (str)\n\nReturn type\nBusinessAttributeKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.ChartUrn(dashboard_tool, chart_id, , allowcoercion=True)\nBases\n\ndashboardtool (str)\nchartid (str)\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE str\n\n\n\nclassmethod createfromids(platform, name, platforminstance=None)\n\nParameters\nChartUrn\n\n\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty dashboardtool List[str]\n\n\n\nproperty entitytype\nkeyaspect (ChartKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nChartKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.ContainerUrn(guid, *, allowcoercion=True)\nBases\n\nguid (Union[ContainerUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (ContainerKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type _SpecificUrn\n\nParameters ClassVar[Literal['corpGroup']] = 'corpGroup'\n\n\n\nclassmethod create_from_id(id)\n\nDeprecated since version 0.12.0.2\nid (str)\n\nReturn type\nurn_str (str)\n\nReturn type List[str]\n\n\n\nproperty entity_type\nkey_aspect (CorpGroupKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurn_str (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentity_type (str)\n\nReturn type\nform (str)\n\nReturn type\nstructured_property (str)\n\nReturn type str\n\n\n\nto_key_aspect()\n\nReturn type\nstr\n\n\n\n\n\nurn_url_encoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['corpuser']] = 'corpuser'\n\n\n\nclassmethod createfromid(id)\n\nDeprecated since version 0.12.0.2\nid (str)\n\nReturn type\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (CorpUserKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nCorpUserKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\nproperty username SpecificUrn\n\nParameters ClassVar[Literal['dashboard']] = 'dashboard'\n\n\n\nclassmethod createfromids(platform, name, platforminstance=None)\n\nParameters\nDashboardUrn\n\n\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty dashboardid str\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nDashboardUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type _SpecificUrn\n\nParameters ClassVar[Literal['dataContract']] = 'dataContract'\n\n\n\nclassmethod create_from_string(urn_str)\n\nParameters\nSelf\n\n\n\n\n\nproperty entity_ids str\n\n\n\nclassmethod from_key_aspect(key_aspect)\n\nParameters\nDataContractUrn\n\n\n\n\n\nclassmethod from_string(urn_str, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; urn = Urn.from_string(urn_str)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.from_string), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.from_string(urn_str)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic get_data_type_from_urn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentity_type (str)\n\nReturn type\nform (str)\n\nReturn type\nstructured_property (str)\n\nReturn type\nDataContractKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.DataFlowUrn(orchestrator, flow_id, cluster, , allowcoercion=True)\nBases\n\norchestrator (str)\nflowid (str)\ncluster (str)\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE str\n\n\n\nclassmethod createfromids(orchestrator, flowid, env, platforminstance=None)\n\nParameters\nDataFlowUrn\n\n\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nproperty flowid\nkeyaspect (DataFlowKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type Use .cluster instead\n\n\nReturn type Use .flowid instead\n\n\nReturn type Use .orchestrator instead\n\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type str\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['dataHubAccessToken']] = 'dataHubAccessToken'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nDataHubAccessTokenUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nDataHubAccessTokenKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.DataHubActionUrn(id, , _allow_coercion=True)\nBases\n\nid (Union[DataHubActionUrn, str])\n_allow_coercion (bool)\n\n\n\n\n\nENTITY_TYPE\nurn_str (str)\n\nReturn type List[str]\n\n\n\nproperty entity_type\nkey_aspect (DataHubActionKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurn_str (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic make_data_type_urn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_entity_type_urn(entity_type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_form_urn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic make_structured_property_urn(structured_property)\n\nParameters\nstr\n\n\n\n\n\nto_key_aspect()\n\nReturn type\nstr\n\n\n\n\n\nurn_url_encoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['dataHubConnection']] = 'dataHubConnection'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nDataHubConnectionUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nDataHubConnectionKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.DataHubExecutionRequestUrn(id, *, allowcoercion=True)\nBases\n\nid (Union[DataHubExecutionRequestUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (ExecutionRequestKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type _SpecificUrn\n\nParameters ClassVar[Literal['dataHubIngestionSource']] = 'dataHubIngestionSource'\n\n\n\nclassmethod create_from_string(urn_str)\n\nParameters\nSelf\n\n\n\n\n\nproperty entity_ids str\n\n\n\nclassmethod from_key_aspect(key_aspect)\n\nParameters\nDataHubIngestionSourceUrn\n\n\n\n\n\nclassmethod from_string(urn_str, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; urn = Urn.from_string(urn_str)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.from_string), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.from_string(urn_str)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic get_data_type_from_urn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentity_type (str)\n\nReturn type\nform (str)\n\nReturn type\nstructured_property (str)\n\nReturn type\nDataHubIngestionSourceKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.DataHubOpenAPISchemaUrn(id, , allowcoercion=True)\nBases\n\nid (Union[DataHubOpenAPISchemaUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (DataHubOpenAPISchemaKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['dataHubPersona']] = 'dataHubPersona'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nDataHubPersonaUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nDataHubPersonaKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.DataHubPolicyUrn(id, , _allow_coercion=True)\nBases\n\nid (Union[DataHubPolicyUrn, str])\n_allow_coercion (bool)\n\n\n\n\n\nENTITY_TYPE\nurn_str (str)\n\nReturn type List[str]\n\n\n\nproperty entity_type\nkey_aspect (DataHubPolicyKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurn_str (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic make_data_type_urn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_entity_type_urn(entity_type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_form_urn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic make_structured_property_urn(structured_property)\n\nParameters\nstr\n\n\n\n\n\nto_key_aspect()\n\nReturn type\nstr\n\n\n\n\n\nurn_url_encoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['dataHubRetention']] = 'dataHubRetention'\n\n\n\nproperty aspectname\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entityname str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nDataHubRetentionUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['dataHubRole']] = 'dataHubRole'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nDataHubRoleUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nDataHubRoleKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.DataHubSecretUrn(id, , _allow_coercion=True)\nBases\n\nid (Union[DataHubSecretUrn, str])\n_allow_coercion (bool)\n\n\n\n\n\nENTITY_TYPE\nurn_str (str)\n\nReturn type List[str]\n\n\n\nproperty entity_type\nkey_aspect (DataHubSecretKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurn_str (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic make_data_type_urn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_entity_type_urn(entity_type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_form_urn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic make_structured_property_urn(structured_property)\n\nParameters\nstr\n\n\n\n\n\nto_key_aspect()\n\nReturn type\nstr\n\n\n\n\n\nurn_url_encoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['dataHubStepState']] = 'dataHubStepState'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nDataHubStepStateUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nDataHubStepStateKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.DataHubUpgradeUrn(id, *, allowcoercion=True)\nBases\n\nid (Union[DataHubUpgradeUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (DataHubUpgradeKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type _SpecificUrn\n\nParameters ClassVar[Literal['dataHubView']] = 'dataHubView'\n\n\n\nclassmethod create_from_string(urn_str)\n\nParameters\nSelf\n\n\n\n\n\nproperty entity_ids str\n\n\n\nclassmethod from_key_aspect(key_aspect)\n\nParameters\nDataHubViewUrn\n\n\n\n\n\nclassmethod from_string(urn_str, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; urn = Urn.from_string(urn_str)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.from_string), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.from_string(urn_str)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic get_data_type_from_urn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentity_type (str)\n\nReturn type\nform (str)\n\nReturn type\nstructured_property (str)\n\nReturn type\nDataHubViewKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.DataJobUrn(flow, job_id, , allowcoercion=True)\nBases\n\nflow (Union[DataFlowUrn, str])\njobid (str)\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\n\ndataflowurn (str)\njobid (str)\n\n\nReturn type\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nDataJobUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\ngetdataflowurn()\n\nReturn type\nurn (str)\n\nReturn type Use .jobid instead\n\n\nReturn type str\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['dataPlatformInstance']] = 'dataPlatformInstance'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nDataPlatformInstanceUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty instance\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type str\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['dataPlatform']] = 'dataPlatform'\n\n\n\nclassmethod createfromid(id)\n\nDeprecated since version 0.12.0.2\nid (str)\n\nReturn type\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (DataPlatformKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type str\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type _SpecificUrn\n\nParameters ClassVar[Literal['dataProcessInstance']] = 'dataProcessInstance'\n\n\n\nclassmethod create_from_id(id)\n\nDeprecated since version 0.12.0.2\nid (str)\n\nReturn type\nurn_str (str)\n\nReturn type List[str]\n\n\n\nproperty entity_type\nkey_aspect (DataProcessInstanceKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurn_str (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type Use .id instead\n\n\nReturn type str\n\n\n\nstatic make_data_type_urn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_entity_type_urn(entity_type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_form_urn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic make_structured_property_urn(structured_property)\n\nParameters\nstr\n\n\n\n\n\nto_key_aspect()\n\nReturn type\nstr\n\n\n\n\n\nurn_url_encoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['dataProcess']] = 'dataProcess'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nproperty env\nkeyaspect (DataProcessKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type str\n\n\n\nproperty orchestrator\nDataProcessKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.DataProductUrn(id, *, allowcoercion=True)\nBases\n\nid (Union[DataProductUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (DataProductKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type _SpecificUrn\n\nParameters ClassVar[Literal['dataType']] = 'dataType'\n\n\n\nclassmethod create_from_string(urn_str)\n\nParameters\nSelf\n\n\n\n\n\nproperty entity_ids str\n\n\n\nclassmethod from_key_aspect(key_aspect)\n\nParameters\nDataTypeUrn\n\n\n\n\n\nclassmethod from_string(urn_str, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; urn = Urn.from_string(urn_str)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.from_string), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.from_string(urn_str)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic get_data_type_from_urn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentity_type (str)\n\nReturn type\nform (str)\n\nReturn type\nstructured_property (str)\n\nReturn type\nDataTypeKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.DatasetUrn(platform, name, env='PROD', , allowcoercion=True)\nBases\n\nplatform (Union[DataPlatformUrn, str])\nname (str)\nenv (str)\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\n\nplatformid (str)\ntablename (str)\nenv (str)\nplatforminstance (Optional[str])\n\n\nReturn type\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nDatasetUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\ngetdataplatformurn()\n\nReturn type\nurn (str)\n\nReturn type Use .name instead\n\n\nReturn type Use .env instead\n\n\nReturn type Use the function from the fieldpaths module instead\n\n\nParameters\nstr\n\n\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\nproperty name str\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type _SpecificUrn\n\nParameters ClassVar[Literal['domain']] = 'domain'\n\n\n\nclassmethod create_from_id(id)\n\nDeprecated since version 0.12.0.2\nid (str)\n\nReturn type\nurn_str (str)\n\nReturn type List[str]\n\n\n\nproperty entity_type\nkey_aspect (DomainKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurn_str (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic make_data_type_urn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_entity_type_urn(entity_type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_form_urn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic make_structured_property_urn(structured_property)\n\nParameters\nstr\n\n\n\n\n\nto_key_aspect()\n\nReturn type\nstr\n\n\n\n\n\nurn_url_encoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['entityType']] = 'entityType'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nEntityTypeUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nEntityTypeKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.ErModelRelationshipUrn(id, *, allowcoercion=True)\nBases\n\nid (Union[ErModelRelationshipUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (ERModelRelationshipKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type _SpecificUrn\n\nParameters ClassVar[Literal['form']] = 'form'\n\n\n\nclassmethod create_from_string(urn_str)\n\nParameters\nSelf\n\n\n\n\n\nproperty entity_ids str\n\n\n\nclassmethod from_key_aspect(key_aspect)\n\nParameters\nFormUrn\n\n\n\n\n\nclassmethod from_string(urn_str, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; urn = Urn.from_string(urn_str)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.from_string), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.from_string(urn_str)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic get_data_type_from_urn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentity_type (str)\n\nReturn type\nform (str)\n\nReturn type\nstructured_property (str)\n\nReturn type\nFormKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.GlobalSettingsUrn(id, , allowcoercion=True)\nBases\n\nid (Union[GlobalSettingsUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (GlobalSettingsKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['glossaryNode']] = 'glossaryNode'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nGlossaryNodeUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\nproperty name\nGlossaryNodeKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.GlossaryTermUrn(name, , _allow_coercion=True)\nBases\n\nname (Union[GlossaryTermUrn, str])\n_allow_coercion (bool)\n\n\n\n\n\nENTITY_TYPE\nurn_str (str)\n\nReturn type List[str]\n\n\n\nproperty entity_type\nkey_aspect (GlossaryTermKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurn_str (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentity_type (str)\n\nReturn type\nform (str)\n\nReturn type\nstructured_property (str)\n\nReturn type str\n\n\n\nto_key_aspect()\n\nReturn type\nstr\n\n\n\n\n\nurn_url_encoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['incident']] = 'incident'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nIncidentUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nIncidentKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.InviteTokenUrn(id, *, allowcoercion=True)\nBases\n\nid (Union[InviteTokenUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (InviteTokenKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type _SpecificUrn\n\nParameters ClassVar[Literal['mlFeatureTable']] = 'mlFeatureTable'\n\n\n\nclassmethod create_from_string(urn_str)\n\nParameters\nSelf\n\n\n\n\n\nproperty entity_ids str\n\n\n\nclassmethod from_key_aspect(key_aspect)\n\nParameters\nMlFeatureTableUrn\n\n\n\n\n\nclassmethod from_string(urn_str, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; urn = Urn.from_string(urn_str)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.from_string), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.from_string(urn_str)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic get_data_type_from_urn(urn)\n\nParameters\nstr\n\n\n\n\n\nstatic make_data_type_urn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_entity_type_urn(entity_type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_form_urn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic make_structured_property_urn(structured_property)\n\nParameters\nstr\n\n\n\n\n\nproperty name str\n\n\n\nto_key_aspect()\n\nReturn type\nstr\n\n\n\n\n\nurn_url_encoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['mlFeature']] = 'mlFeature'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nproperty featurenamespace\nkeyaspect (MLFeatureKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type str\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['mlModelDeployment']] = 'mlModelDeployment'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nproperty env\nkeyaspect (MLModelDeploymentKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type str\n\n\n\nproperty platform\nMLModelDeploymentKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.MlModelGroupUrn(platform, name, env='PROD', , _allow_coercion=True)\nBases\n\nplatform (Union[DataPlatformUrn, str])\nname (str)\nenv (str)\n_allow_coercion (bool)\n\n\n\n\n\nENTITY_TYPE\nurn_str (str)\n\nReturn type List[str]\n\n\n\nproperty entity_type str\n\n\n\nclassmethod from_key_aspect(key_aspect)\n\nParameters\nMlModelGroupUrn\n\n\n\n\n\nclassmethod from_string(urn_str, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; urn = Urn.from_string(urn_str)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.from_string), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.from_string(urn_str)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic get_data_type_from_urn(urn)\n\nParameters\nstr\n\n\n\n\n\nstatic make_data_type_urn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_entity_type_urn(entity_type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_form_urn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic make_structured_property_urn(structured_property)\n\nParameters\nstr\n\n\n\n\n\nproperty name str\n\n\n\nto_key_aspect()\n\nReturn type\nstr\n\n\n\n\n\nurn_url_encoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['mlModel']] = 'mlModel'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nproperty env\nkeyaspect (MLModelKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type str\n\n\n\nproperty platform\nMLModelKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.MlPrimaryKeyUrn(featurenamespace, name, , _allow_coercion=True)\nBases\n\nfeature_namespace (str)\nname (str)\n_allow_coercion (bool)\n\n\n\n\n\nENTITY_TYPE\nurn_str (str)\n\nReturn type List[str]\n\n\n\nproperty entity_type str\n\n\n\nclassmethod from_key_aspect(key_aspect)\n\nParameters\nMlPrimaryKeyUrn\n\n\n\n\n\nclassmethod from_string(urn_str, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; urn = Urn.from_string(urn_str)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.from_string), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.from_string(urn_str)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic get_data_type_from_urn(urn)\n\nParameters\nstr\n\n\n\n\n\nstatic make_data_type_urn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_entity_type_urn(entity_type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_form_urn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic make_structured_property_urn(structured_property)\n\nParameters\nstr\n\n\n\n\n\nproperty name\nMLPrimaryKeyKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.NotebookUrn(notebook_tool, notebook_id, , allowcoercion=True)\nBases\n\nnotebooktool (str)\nnotebookid (str)\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (NotebookKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type Use .notebookid instead\n\n\nReturn type Use .notebooktool instead\n\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type str\n\n\n\nproperty notebooktool\nNotebookKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.OwnershipTypeUrn(id, *, allowcoercion=True)\nBases\n\nid (Union[OwnershipTypeUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (OwnershipTypeKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type _SpecificUrn\n\nParameters ClassVar[Literal['platformResource']] = 'platformResource'\n\n\n\nclassmethod create_from_string(urn_str)\n\nParameters\nSelf\n\n\n\n\n\nproperty entity_ids str\n\n\n\nclassmethod from_key_aspect(key_aspect)\n\nParameters\nPlatformResourceUrn\n\n\n\n\n\nclassmethod from_string(urn_str, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; urn = Urn.from_string(urn_str)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.from_string), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.from_string(urn_str)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic get_data_type_from_urn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentity_type (str)\n\nReturn type\nform (str)\n\nReturn type\nstructured_property (str)\n\nReturn type\nPlatformResourceKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.PostUrn(id, , allowcoercion=True)\nBases\n\nid (Union[PostUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (PostKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['query']] = 'query'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nQueryUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nQueryKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.RoleUrn(id, , _allow_coercion=True)\nBases\n\nid (Union[RoleUrn, str])\n_allow_coercion (bool)\n\n\n\n\n\nENTITY_TYPE\nurn_str (str)\n\nReturn type List[str]\n\n\n\nproperty entity_type\nkey_aspect (RoleKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurn_str (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic make_data_type_urn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_entity_type_urn(entity_type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_form_urn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic make_structured_property_urn(structured_property)\n\nParameters\nstr\n\n\n\n\n\nto_key_aspect()\n\nReturn type\nstr\n\n\n\n\n\nurn_url_encoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['schemaField']] = 'schemaField'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nproperty fieldpath\nkeyaspect (SchemaFieldKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type str\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['structuredProperty']] = 'structuredProperty'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nStructuredPropertyUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nStructuredPropertyKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.TagUrn(name, , _allow_coercion=True)\nBases\n\nname (Union[TagUrn, str])\n_allow_coercion (bool)\n\n\n\n\n\nENTITY_TYPE Use the constructor instead\n\n\nParameters\nTagUrn\n\n\n\n\n\nclassmethod create_from_string(urn_str)\n\nParameters\nSelf\n\n\n\n\n\nproperty entity_ids str\n\n\n\nclassmethod from_key_aspect(key_aspect)\n\nParameters\nTagUrn\n\n\n\n\n\nclassmethod from_string(urn_str, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; urn = Urn.from_string(urn_str)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.from_string), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.from_string(urn_str)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic get_data_type_from_urn(urn)\n\nParameters\nstr\n\n\n\n\n\nstatic make_data_type_urn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_entity_type_urn(entity_type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_form_urn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic make_structured_property_urn(structured_property)\n\nParameters\nstr\n\n\n\n\n\nproperty name\nTagKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.TelemetryUrn(name, , allowcoercion=True)\nBases\n\nname (Union[TelemetryUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (TelemetryKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type str\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['test']] = 'test'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nTestUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nTestKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.Urn(entitytype, entityid)\nBasesli&lt;id&gt; or urn&lt;type&gt; certain characters, particularly commas and parentheses, are\nnot allowed in string portions of the URN. However, these are allowed when the urn\nhas another urn embedded within it. The main URN class ignores this possibility,\nand assumes that the user provides a valid URN string. However, the specific URN\nclasses, such as DatasetUrn, will automatically encode these characters using\nurl-encoding when the URN is created and allowcoercion is enabled (the default).\nHowever, all fromstring methods will try to preserve the string as-is, and will\nraise an error if the string is invalid.\n\nParameters\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytypeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['versionSet']] = 'versionSet'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nVersionSetUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nVersionSetKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n"}}>"><meta data-rh="true" property="og:description" content="\n\n\n\n\nclass datahub.metadata.urns.AssertionUrn(assertionid, *, allowcoercion=True)\nBases\n\nassertionid (Union[AssertionUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE str\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nAssertionUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type _SpecificUrn\n\nParameters ClassVar[Literal['businessAttribute']] = 'businessAttribute'\n\n\n\nclassmethod create_from_string(urn_str)\n\nParameters\nSelf\n\n\n\n\n\nproperty entity_ids str\n\n\n\nclassmethod from_key_aspect(key_aspect)\n\nParameters\nBusinessAttributeUrn\n\n\n\n\n\nclassmethod from_string(urn_str, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; urn = Urn.from_string(urn_str)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.from_string), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.from_string(urn_str)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic get_data_type_from_urn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentity_type (str)\n\nReturn type\nform (str)\n\nReturn type\nstructured_property (str)\n\nReturn type\nBusinessAttributeKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.ChartUrn(dashboard_tool, chart_id, , allowcoercion=True)\nBases\n\ndashboardtool (str)\nchartid (str)\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE str\n\n\n\nclassmethod createfromids(platform, name, platforminstance=None)\n\nParameters\nChartUrn\n\n\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty dashboardtool List[str]\n\n\n\nproperty entitytype\nkeyaspect (ChartKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nChartKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.ContainerUrn(guid, *, allowcoercion=True)\nBases\n\nguid (Union[ContainerUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (ContainerKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type _SpecificUrn\n\nParameters ClassVar[Literal['corpGroup']] = 'corpGroup'\n\n\n\nclassmethod create_from_id(id)\n\nDeprecated since version 0.12.0.2\nid (str)\n\nReturn type\nurn_str (str)\n\nReturn type List[str]\n\n\n\nproperty entity_type\nkey_aspect (CorpGroupKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurn_str (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentity_type (str)\n\nReturn type\nform (str)\n\nReturn type\nstructured_property (str)\n\nReturn type str\n\n\n\nto_key_aspect()\n\nReturn type\nstr\n\n\n\n\n\nurn_url_encoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['corpuser']] = 'corpuser'\n\n\n\nclassmethod createfromid(id)\n\nDeprecated since version 0.12.0.2\nid (str)\n\nReturn type\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (CorpUserKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nCorpUserKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\nproperty username SpecificUrn\n\nParameters ClassVar[Literal['dashboard']] = 'dashboard'\n\n\n\nclassmethod createfromids(platform, name, platforminstance=None)\n\nParameters\nDashboardUrn\n\n\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty dashboardid str\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nDashboardUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type _SpecificUrn\n\nParameters ClassVar[Literal['dataContract']] = 'dataContract'\n\n\n\nclassmethod create_from_string(urn_str)\n\nParameters\nSelf\n\n\n\n\n\nproperty entity_ids str\n\n\n\nclassmethod from_key_aspect(key_aspect)\n\nParameters\nDataContractUrn\n\n\n\n\n\nclassmethod from_string(urn_str, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; urn = Urn.from_string(urn_str)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.from_string), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.from_string(urn_str)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic get_data_type_from_urn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentity_type (str)\n\nReturn type\nform (str)\n\nReturn type\nstructured_property (str)\n\nReturn type\nDataContractKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.DataFlowUrn(orchestrator, flow_id, cluster, , allowcoercion=True)\nBases\n\norchestrator (str)\nflowid (str)\ncluster (str)\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE str\n\n\n\nclassmethod createfromids(orchestrator, flowid, env, platforminstance=None)\n\nParameters\nDataFlowUrn\n\n\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nproperty flowid\nkeyaspect (DataFlowKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type Use .cluster instead\n\n\nReturn type Use .flowid instead\n\n\nReturn type Use .orchestrator instead\n\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type str\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['dataHubAccessToken']] = 'dataHubAccessToken'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nDataHubAccessTokenUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nDataHubAccessTokenKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.DataHubActionUrn(id, , _allow_coercion=True)\nBases\n\nid (Union[DataHubActionUrn, str])\n_allow_coercion (bool)\n\n\n\n\n\nENTITY_TYPE\nurn_str (str)\n\nReturn type List[str]\n\n\n\nproperty entity_type\nkey_aspect (DataHubActionKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurn_str (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic make_data_type_urn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_entity_type_urn(entity_type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_form_urn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic make_structured_property_urn(structured_property)\n\nParameters\nstr\n\n\n\n\n\nto_key_aspect()\n\nReturn type\nstr\n\n\n\n\n\nurn_url_encoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['dataHubConnection']] = 'dataHubConnection'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nDataHubConnectionUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nDataHubConnectionKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.DataHubExecutionRequestUrn(id, *, allowcoercion=True)\nBases\n\nid (Union[DataHubExecutionRequestUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (ExecutionRequestKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type _SpecificUrn\n\nParameters ClassVar[Literal['dataHubIngestionSource']] = 'dataHubIngestionSource'\n\n\n\nclassmethod create_from_string(urn_str)\n\nParameters\nSelf\n\n\n\n\n\nproperty entity_ids str\n\n\n\nclassmethod from_key_aspect(key_aspect)\n\nParameters\nDataHubIngestionSourceUrn\n\n\n\n\n\nclassmethod from_string(urn_str, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; urn = Urn.from_string(urn_str)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.from_string), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.from_string(urn_str)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic get_data_type_from_urn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentity_type (str)\n\nReturn type\nform (str)\n\nReturn type\nstructured_property (str)\n\nReturn type\nDataHubIngestionSourceKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.DataHubOpenAPISchemaUrn(id, , allowcoercion=True)\nBases\n\nid (Union[DataHubOpenAPISchemaUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (DataHubOpenAPISchemaKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['dataHubPersona']] = 'dataHubPersona'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nDataHubPersonaUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nDataHubPersonaKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.DataHubPolicyUrn(id, , _allow_coercion=True)\nBases\n\nid (Union[DataHubPolicyUrn, str])\n_allow_coercion (bool)\n\n\n\n\n\nENTITY_TYPE\nurn_str (str)\n\nReturn type List[str]\n\n\n\nproperty entity_type\nkey_aspect (DataHubPolicyKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurn_str (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic make_data_type_urn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_entity_type_urn(entity_type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_form_urn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic make_structured_property_urn(structured_property)\n\nParameters\nstr\n\n\n\n\n\nto_key_aspect()\n\nReturn type\nstr\n\n\n\n\n\nurn_url_encoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['dataHubRetention']] = 'dataHubRetention'\n\n\n\nproperty aspectname\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entityname str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nDataHubRetentionUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['dataHubRole']] = 'dataHubRole'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nDataHubRoleUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nDataHubRoleKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.DataHubSecretUrn(id, , _allow_coercion=True)\nBases\n\nid (Union[DataHubSecretUrn, str])\n_allow_coercion (bool)\n\n\n\n\n\nENTITY_TYPE\nurn_str (str)\n\nReturn type List[str]\n\n\n\nproperty entity_type\nkey_aspect (DataHubSecretKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurn_str (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic make_data_type_urn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_entity_type_urn(entity_type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_form_urn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic make_structured_property_urn(structured_property)\n\nParameters\nstr\n\n\n\n\n\nto_key_aspect()\n\nReturn type\nstr\n\n\n\n\n\nurn_url_encoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['dataHubStepState']] = 'dataHubStepState'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nDataHubStepStateUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nDataHubStepStateKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.DataHubUpgradeUrn(id, *, allowcoercion=True)\nBases\n\nid (Union[DataHubUpgradeUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (DataHubUpgradeKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type _SpecificUrn\n\nParameters ClassVar[Literal['dataHubView']] = 'dataHubView'\n\n\n\nclassmethod create_from_string(urn_str)\n\nParameters\nSelf\n\n\n\n\n\nproperty entity_ids str\n\n\n\nclassmethod from_key_aspect(key_aspect)\n\nParameters\nDataHubViewUrn\n\n\n\n\n\nclassmethod from_string(urn_str, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; urn = Urn.from_string(urn_str)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.from_string), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.from_string(urn_str)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic get_data_type_from_urn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentity_type (str)\n\nReturn type\nform (str)\n\nReturn type\nstructured_property (str)\n\nReturn type\nDataHubViewKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.DataJobUrn(flow, job_id, , allowcoercion=True)\nBases\n\nflow (Union[DataFlowUrn, str])\njobid (str)\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\n\ndataflowurn (str)\njobid (str)\n\n\nReturn type\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nDataJobUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\ngetdataflowurn()\n\nReturn type\nurn (str)\n\nReturn type Use .jobid instead\n\n\nReturn type str\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['dataPlatformInstance']] = 'dataPlatformInstance'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nDataPlatformInstanceUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty instance\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type str\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['dataPlatform']] = 'dataPlatform'\n\n\n\nclassmethod createfromid(id)\n\nDeprecated since version 0.12.0.2\nid (str)\n\nReturn type\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (DataPlatformKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type str\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type _SpecificUrn\n\nParameters ClassVar[Literal['dataProcessInstance']] = 'dataProcessInstance'\n\n\n\nclassmethod create_from_id(id)\n\nDeprecated since version 0.12.0.2\nid (str)\n\nReturn type\nurn_str (str)\n\nReturn type List[str]\n\n\n\nproperty entity_type\nkey_aspect (DataProcessInstanceKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurn_str (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type Use .id instead\n\n\nReturn type str\n\n\n\nstatic make_data_type_urn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_entity_type_urn(entity_type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_form_urn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic make_structured_property_urn(structured_property)\n\nParameters\nstr\n\n\n\n\n\nto_key_aspect()\n\nReturn type\nstr\n\n\n\n\n\nurn_url_encoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['dataProcess']] = 'dataProcess'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nproperty env\nkeyaspect (DataProcessKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type str\n\n\n\nproperty orchestrator\nDataProcessKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.DataProductUrn(id, *, allowcoercion=True)\nBases\n\nid (Union[DataProductUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (DataProductKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type _SpecificUrn\n\nParameters ClassVar[Literal['dataType']] = 'dataType'\n\n\n\nclassmethod create_from_string(urn_str)\n\nParameters\nSelf\n\n\n\n\n\nproperty entity_ids str\n\n\n\nclassmethod from_key_aspect(key_aspect)\n\nParameters\nDataTypeUrn\n\n\n\n\n\nclassmethod from_string(urn_str, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; urn = Urn.from_string(urn_str)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.from_string), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.from_string(urn_str)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic get_data_type_from_urn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentity_type (str)\n\nReturn type\nform (str)\n\nReturn type\nstructured_property (str)\n\nReturn type\nDataTypeKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.DatasetUrn(platform, name, env='PROD', , allowcoercion=True)\nBases\n\nplatform (Union[DataPlatformUrn, str])\nname (str)\nenv (str)\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\n\nplatformid (str)\ntablename (str)\nenv (str)\nplatforminstance (Optional[str])\n\n\nReturn type\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nDatasetUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\ngetdataplatformurn()\n\nReturn type\nurn (str)\n\nReturn type Use .name instead\n\n\nReturn type Use .env instead\n\n\nReturn type Use the function from the fieldpaths module instead\n\n\nParameters\nstr\n\n\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\nproperty name str\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type _SpecificUrn\n\nParameters ClassVar[Literal['domain']] = 'domain'\n\n\n\nclassmethod create_from_id(id)\n\nDeprecated since version 0.12.0.2\nid (str)\n\nReturn type\nurn_str (str)\n\nReturn type List[str]\n\n\n\nproperty entity_type\nkey_aspect (DomainKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurn_str (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic make_data_type_urn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_entity_type_urn(entity_type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_form_urn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic make_structured_property_urn(structured_property)\n\nParameters\nstr\n\n\n\n\n\nto_key_aspect()\n\nReturn type\nstr\n\n\n\n\n\nurn_url_encoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['entityType']] = 'entityType'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nEntityTypeUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nEntityTypeKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.ErModelRelationshipUrn(id, *, allowcoercion=True)\nBases\n\nid (Union[ErModelRelationshipUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (ERModelRelationshipKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type _SpecificUrn\n\nParameters ClassVar[Literal['form']] = 'form'\n\n\n\nclassmethod create_from_string(urn_str)\n\nParameters\nSelf\n\n\n\n\n\nproperty entity_ids str\n\n\n\nclassmethod from_key_aspect(key_aspect)\n\nParameters\nFormUrn\n\n\n\n\n\nclassmethod from_string(urn_str, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; urn = Urn.from_string(urn_str)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.from_string), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.from_string(urn_str)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic get_data_type_from_urn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentity_type (str)\n\nReturn type\nform (str)\n\nReturn type\nstructured_property (str)\n\nReturn type\nFormKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.GlobalSettingsUrn(id, , allowcoercion=True)\nBases\n\nid (Union[GlobalSettingsUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (GlobalSettingsKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['glossaryNode']] = 'glossaryNode'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nGlossaryNodeUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\nproperty name\nGlossaryNodeKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.GlossaryTermUrn(name, , _allow_coercion=True)\nBases\n\nname (Union[GlossaryTermUrn, str])\n_allow_coercion (bool)\n\n\n\n\n\nENTITY_TYPE\nurn_str (str)\n\nReturn type List[str]\n\n\n\nproperty entity_type\nkey_aspect (GlossaryTermKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurn_str (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentity_type (str)\n\nReturn type\nform (str)\n\nReturn type\nstructured_property (str)\n\nReturn type str\n\n\n\nto_key_aspect()\n\nReturn type\nstr\n\n\n\n\n\nurn_url_encoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['incident']] = 'incident'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nIncidentUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nIncidentKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.InviteTokenUrn(id, *, allowcoercion=True)\nBases\n\nid (Union[InviteTokenUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (InviteTokenKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type _SpecificUrn\n\nParameters ClassVar[Literal['mlFeatureTable']] = 'mlFeatureTable'\n\n\n\nclassmethod create_from_string(urn_str)\n\nParameters\nSelf\n\n\n\n\n\nproperty entity_ids str\n\n\n\nclassmethod from_key_aspect(key_aspect)\n\nParameters\nMlFeatureTableUrn\n\n\n\n\n\nclassmethod from_string(urn_str, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; urn = Urn.from_string(urn_str)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.from_string), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.from_string(urn_str)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic get_data_type_from_urn(urn)\n\nParameters\nstr\n\n\n\n\n\nstatic make_data_type_urn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_entity_type_urn(entity_type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_form_urn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic make_structured_property_urn(structured_property)\n\nParameters\nstr\n\n\n\n\n\nproperty name str\n\n\n\nto_key_aspect()\n\nReturn type\nstr\n\n\n\n\n\nurn_url_encoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['mlFeature']] = 'mlFeature'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nproperty featurenamespace\nkeyaspect (MLFeatureKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type str\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['mlModelDeployment']] = 'mlModelDeployment'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nproperty env\nkeyaspect (MLModelDeploymentKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type str\n\n\n\nproperty platform\nMLModelDeploymentKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.MlModelGroupUrn(platform, name, env='PROD', , _allow_coercion=True)\nBases\n\nplatform (Union[DataPlatformUrn, str])\nname (str)\nenv (str)\n_allow_coercion (bool)\n\n\n\n\n\nENTITY_TYPE\nurn_str (str)\n\nReturn type List[str]\n\n\n\nproperty entity_type str\n\n\n\nclassmethod from_key_aspect(key_aspect)\n\nParameters\nMlModelGroupUrn\n\n\n\n\n\nclassmethod from_string(urn_str, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; urn = Urn.from_string(urn_str)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.from_string), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.from_string(urn_str)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic get_data_type_from_urn(urn)\n\nParameters\nstr\n\n\n\n\n\nstatic make_data_type_urn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_entity_type_urn(entity_type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_form_urn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic make_structured_property_urn(structured_property)\n\nParameters\nstr\n\n\n\n\n\nproperty name str\n\n\n\nto_key_aspect()\n\nReturn type\nstr\n\n\n\n\n\nurn_url_encoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['mlModel']] = 'mlModel'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nproperty env\nkeyaspect (MLModelKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type str\n\n\n\nproperty platform\nMLModelKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.MlPrimaryKeyUrn(featurenamespace, name, , _allow_coercion=True)\nBases\n\nfeature_namespace (str)\nname (str)\n_allow_coercion (bool)\n\n\n\n\n\nENTITY_TYPE\nurn_str (str)\n\nReturn type List[str]\n\n\n\nproperty entity_type str\n\n\n\nclassmethod from_key_aspect(key_aspect)\n\nParameters\nMlPrimaryKeyUrn\n\n\n\n\n\nclassmethod from_string(urn_str, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; urn = Urn.from_string(urn_str)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.from_string), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.from_string(urn_str)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic get_data_type_from_urn(urn)\n\nParameters\nstr\n\n\n\n\n\nstatic make_data_type_urn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_entity_type_urn(entity_type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_form_urn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic make_structured_property_urn(structured_property)\n\nParameters\nstr\n\n\n\n\n\nproperty name\nMLPrimaryKeyKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.NotebookUrn(notebook_tool, notebook_id, , allowcoercion=True)\nBases\n\nnotebooktool (str)\nnotebookid (str)\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (NotebookKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type Use .notebookid instead\n\n\nReturn type Use .notebooktool instead\n\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type str\n\n\n\nproperty notebooktool\nNotebookKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.OwnershipTypeUrn(id, *, allowcoercion=True)\nBases\n\nid (Union[OwnershipTypeUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (OwnershipTypeKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type _SpecificUrn\n\nParameters ClassVar[Literal['platformResource']] = 'platformResource'\n\n\n\nclassmethod create_from_string(urn_str)\n\nParameters\nSelf\n\n\n\n\n\nproperty entity_ids str\n\n\n\nclassmethod from_key_aspect(key_aspect)\n\nParameters\nPlatformResourceUrn\n\n\n\n\n\nclassmethod from_string(urn_str, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; urn = Urn.from_string(urn_str)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.from_string), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.from_string(urn_str)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic get_data_type_from_urn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentity_type (str)\n\nReturn type\nform (str)\n\nReturn type\nstructured_property (str)\n\nReturn type\nPlatformResourceKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.PostUrn(id, , allowcoercion=True)\nBases\n\nid (Union[PostUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (PostKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic makedatatypeurn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic makeentitytypeurn(entitytype)\n\nParameters\nstr\n\n\n\n\n\nstatic makeformurn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic makestructuredpropertyurn(structuredproperty)\n\nParameters\nstr\n\n\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['query']] = 'query'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nQueryUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nQueryKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.RoleUrn(id, , _allow_coercion=True)\nBases\n\nid (Union[RoleUrn, str])\n_allow_coercion (bool)\n\n\n\n\n\nENTITY_TYPE\nurn_str (str)\n\nReturn type List[str]\n\n\n\nproperty entity_type\nkey_aspect (RoleKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurn_str (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type str\n\n\n\nstatic make_data_type_urn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_entity_type_urn(entity_type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_form_urn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic make_structured_property_urn(structured_property)\n\nParameters\nstr\n\n\n\n\n\nto_key_aspect()\n\nReturn type\nstr\n\n\n\n\n\nurn_url_encoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['schemaField']] = 'schemaField'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nproperty fieldpath\nkeyaspect (SchemaFieldKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type str\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['structuredProperty']] = 'structuredProperty'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nStructuredPropertyUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nStructuredPropertyKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.TagUrn(name, , _allow_coercion=True)\nBases\n\nname (Union[TagUrn, str])\n_allow_coercion (bool)\n\n\n\n\n\nENTITY_TYPE Use the constructor instead\n\n\nParameters\nTagUrn\n\n\n\n\n\nclassmethod create_from_string(urn_str)\n\nParameters\nSelf\n\n\n\n\n\nproperty entity_ids str\n\n\n\nclassmethod from_key_aspect(key_aspect)\n\nParameters\nTagUrn\n\n\n\n\n\nclassmethod from_string(urn_str, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; urn = Urn.from_string(urn_str)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.from_string), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urn_str = 'urndatasetlisnowflake,my_db.my_schema.my_table,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.from_string(urn_str)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic get_data_type_from_urn(urn)\n\nParameters\nstr\n\n\n\n\n\nstatic make_data_type_urn(type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_entity_type_urn(entity_type)\n\nParameters\nstr\n\n\n\n\n\nstatic make_form_urn(form)\n\nParameters\nstr\n\n\n\n\n\nstatic make_structured_property_urn(structured_property)\n\nParameters\nstr\n\n\n\n\n\nproperty name\nTagKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.TelemetryUrn(name, , allowcoercion=True)\nBases\n\nname (Union[TelemetryUrn, str])\nallowcoercion (bool)\n\n\n\n\n\nENTITYTYPE\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytype\nkeyaspect (TelemetryKeyClass)\n\nReturn typeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type str\n\n\n\ntokeyaspect()\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['test']] = 'test'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nTestUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nTestKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n\nclass datahub.metadata.urns.Urn(entitytype, entityid)\nBasesli&lt;id&gt; or urn&lt;type&gt; certain characters, particularly commas and parentheses, are\nnot allowed in string portions of the URN. However, these are allowed when the urn\nhas another urn embedded within it. The main URN class ignores this possibility,\nand assumes that the user provides a valid URN string. However, the specific URN\nclasses, such as DatasetUrn, will automatically encode these characters using\nurl-encoding when the URN is created and allowcoercion is enabled (the default).\nHowever, all fromstring methods will try to preserve the string as-is, and will\nraise an error if the string is invalid.\n\nParameters\nurnstr (str)\n\nReturn type List[str]\n\n\n\nproperty entitytypeli(urndataPlatformli(urndataPlatform\nurnstr (Union[str, Urn]) \u2013 The string representation of the urn. Also accepts an existing Urn instance.\n\nReturn type\nUrn of the given string representation.\n\nRaises\nurn (str)\n\nReturn type\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nstr\n\n\n\n\n\nurnurlencoded()\n\nReturn type SpecificUrn\n\nParameters ClassVar[Literal['versionSet']] = 'versionSet'\n\n\n\nclassmethod createfromstring(urnstr)\n\nParameters\nSelf\n\n\n\n\n\nproperty entityids str\n\n\n\nclassmethod fromkeyaspect(keyaspect)\n\nParameters\nVersionSetUrn\n\n\n\n\n\nclassmethod fromstring(urnstr, /)\nCreate an Urn from its string representation.\nWhen called against the base Urn class, this method will return a more specific Urn type where possible.\n&gt;&gt;&gt; from datahub.metadata.urns import DatasetUrn, Urn\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; urn = Urn.fromstring(urnstr)\n&gt;&gt;&gt; assert isinstance(urn, DatasetUrn)\n\n\nWhen called against a specific Urn type (e.g. DatasetUrn.fromstring), this method can\nalso be used for type narrowing.\n&gt;&gt;&gt; urnstr = 'urndatasetlisnowflake,mydb.myschema.mytable,PROD)'\n&gt;&gt;&gt; assert DatasetUrn.fromstring(urnstr)\n\n\n\nParameters\nSelf\n\nReturns\nInvalidUrnError \u2013 If the string representation is in invalid format.\n\n\n\n\n\nstatic getdatatypefromurn(urn)\n\nParameters\nstr\n\n\n\n\n\nproperty id\ntype (str)\n\nReturn type\nentitytype (str)\n\nReturn type\nform (str)\n\nReturn type\nstructuredproperty (str)\n\nReturn type\nVersionSetKeyClass\n\n\n\n\n\nurn()\nGet the string representation of the urn.\n\nReturn type\nstr\n\n\n\n\n\n"}}>"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.datahub.com/docs/1.1.0/python-sdk/urns"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/1.1.0/python-sdk/urns" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/1.1.0/python-sdk/urns" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://RK0UG797F3-dsn.algolia.net" crossorigin="anonymous"><link rel="alternate" type="application/rss+xml" href="/learn/rss.xml" title="DataHub RSS Feed">
|
||
<link rel="alternate" type="application/atom+xml" href="/learn/atom.xml" title="DataHub Atom Feed">
|
||
|
||
<link rel="preconnect" href="https://www.google-analytics.com">
|
||
<link rel="preconnect" href="https://www.googletagmanager.com">
|
||
<script async src="https://www.googletagmanager.com/gtag/js?id=G-PKGVLETT4C"></script>
|
||
<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-PKGVLETT4C",{})</script>
|
||
<link rel="preconnect" href="https://www.googletagmanager.com">
|
||
<script>window.dataLayer=window.dataLayer||[]</script>
|
||
<script>!function(e,t,a,n,g){e[n]=e[n]||[],e[n].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var m=t.getElementsByTagName(a)[0],r=t.createElement(a);r.async=!0,r.src="https://www.googletagmanager.com/gtm.js?id=GTM-5M8T9HNN",m.parentNode.insertBefore(r,m)}(window,document,"script","dataLayer")</script>
|
||
|
||
|
||
<link rel="search" type="application/opensearchdescription+xml" title="DataHub" href="/opensearch.xml">
|
||
|
||
|
||
|
||
|
||
<meta httpequiv="Content-Security-Policy" content="frame-ancestors 'self' https://*.acryl.io https://acryldata.io http://localhost:*">
|
||
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Manrope:wght@400;500;700&display=swap">
|
||
<script src="https://tools.luckyorange.com/core/lo.js?site-id=28ea8a38" async defer="defer"></script>
|
||
<script src="/scripts/rb2b.js" async defer="defer"></script>
|
||
<script src="https://app.revenuehero.io/scheduler.min.js"></script>
|
||
<script src="https://tag.clearbitscripts.com/v1/pk_2e321cabe30432a5c44c0424781aa35f/tags.js" referrerpolicy="strict-origin-when-cross-origin"></script>
|
||
<script src="/scripts/reo.js"></script>
|
||
<script id="runllm-widget-script" type="module" src="https://widget.runllm.com" crossorigin="true" runllm-name="DataHub" runllm-assistant-id="81" runllm-position="BOTTOM_RIGHT" runllm-keyboard-shortcut="Mod+j" runllm-preset="docusaurus" runllm-theme-color="#1890FF" runllm-brand-logo="https://docs.datahub.com/img/datahub-logo-color-mark.svg" runllm-community-url="https://datahub.com/slack" runllm-community-type="slack" runllm-disable-ask-a-person="true" async></script><link rel="stylesheet" href="/assets/css/styles.d8fe2eb8.css">
|
||
<link rel="preload" href="/assets/js/runtime~main.6a0c26ba.js" as="script">
|
||
<link rel="preload" href="/assets/js/main.ea5b2459.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">1.1.0</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/python-sdk/urns">Next</a></li><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/docs/1.1.0/python-sdk/urns">1.1.0</a></li><li><hr class="dropdown-separator" style="margin: 0.4rem;"></li><li><div class="dropdown__link"><b>Archived versions</b></div></li><li>
|
||
<a class="dropdown__link" href="https://docs-website-t9sv4w3gr-acryldata.vercel.app/docs/features">1.0.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-t9sv4w3gr-acryldata.vercel.app/docs/0.15.0/features">0.15.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-8jkm4uler-acryldata.vercel.app/docs/0.14.1/features">0.14.1
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-eue2qafvn-acryldata.vercel.app/docs/features">0.14.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-psat3nzgi-acryldata.vercel.app/docs/features">0.13.1
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-lzxh86531-acryldata.vercel.app/docs/features">0.13.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-2uuxmgza2-acryldata.vercel.app/docs/features">0.12.1
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-irpoe2osc-acryldata.vercel.app/docs/features">0.11.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-1gv2yzn9d-acryldata.vercel.app/docs/features">0.10.5
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li></ul></div></div><div class="navbar__items navbar__items--right"><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs">Docs</a><a class="navbar__item navbar__link" href="/integrations">Integrations</a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Learn</a><ul class="dropdown__menu dropdown__menu_Z8FC"><div class="wrapper_kp81"><div><a href="https://datahub.com/weekly-demo" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-join-slack.png" alt="Weekly Demo"></div><div class="title_c7DP">Weekly Demo</div></a></div><div><a href="https://datahub.com/use-cases" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-forum.png" alt="Use Cases"></div><div class="title_c7DP">Use Cases</div></a></div><div><a href="httpps://datahub.com/adoption-stories" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-events.png" alt="Adoption Stories"></div><div class="title_c7DP">Adoption Stories</div></a></div><div><a href="https://medium.com/datahub-project" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-champions.png" alt="Blog"></div><div class="title_c7DP">Blog</div></a></div><div><a href="https://www.youtube.com/channel/UC3qFQC5IiwR5fvWEqi_tJ5w" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-share-your-journey.png" alt="Youtube"></div><div class="title_c7DP">Youtube</div></a></div></div></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Community</a><ul class="dropdown__menu dropdown__menu_Z8FC"><div class="wrapper_kp81"><div><a href="https://datahub.com/slack/" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-join-slack.png" alt="Join Slack"></div><div class="title_c7DP">Join Slack</div></a></div><div><a href="https://datahub.com/events" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-events.png" alt="Events"></div><div class="title_c7DP">Events</div></a></div><div><a href="https://datahub.com/champions/" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-champions.png" alt="Champions"></div><div class="title_c7DP">Champions</div></a></div><div><a href="https://datahub.com/share-your-journey/" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-share-your-journey.png" alt="Share Your Journey"></div><div class="title_c7DP">Share Your Journey</div></a></div></div></ul></div><a href="https://datahub.com/products/why-datahub-cloud/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">
|
||
<style>
|
||
.cloud-cta {
|
||
color: var(--ifm-menu-color-active);
|
||
font-weight: 600;
|
||
background: linear-gradient(40deg, var(--ifm-menu-color-active), var(--ifm-menu-color-active));
|
||
background-size: 200% 100%;
|
||
-webkit-background-clip: text;
|
||
background-clip: text;
|
||
transition: background-image 0.3s ease;
|
||
}
|
||
.cloud-cta:hover {
|
||
color: transparent;
|
||
background: linear-gradient(40deg, var(--ifm-menu-color-active), #ff1493);
|
||
background-size: 200% 100%;
|
||
-webkit-background-clip: text;
|
||
background-clip: text;
|
||
animation: gradientShift 3s ease infinite;
|
||
}
|
||
@keyframes gradientShift {
|
||
0%, 100% { background-position: 0% 50%; }
|
||
50% { background-position: 100% 50%; }
|
||
}
|
||
</style>
|
||
<div class="cloud-cta">Get Cloud</div>
|
||
</a><a href="https://datahub.com/slack?utm_source=docs&utm_medium=header&utm_campaign=docs_header" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">
|
||
<style>
|
||
.slack-logo:hover {
|
||
opacity: 0.8;
|
||
}
|
||
</style>
|
||
<img class="slack-logo" src="https://upload.wikimedia.org/wikipedia/commons/d/d5/Slack_icon_2019.svg" , alt="slack" , height="20px" style="margin: 10px 0 0 0;">
|
||
</a><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG menuWithAnnouncementBar_GW3s"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Getting Started</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/1.1.0/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/1.1.0/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/1.1.0/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/1.1.0/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/1.1.0/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/1.1.0/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/1.1.0/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/1.1.0/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/1.1.0/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/1.1.0/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/1.1.0/api/datahub-apis">APIs</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/1.1.0/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/1.1.0/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/1.1.0/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/1.1.0/python-sdk/builder">Python SDK Reference</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.1.0/python-sdk/builder">Builder</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/1.1.0/python-sdk/clients">Client</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/1.1.0/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 menu__link--active" aria-current="page" tabindex="0" href="/docs/1.1.0/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/1.1.0/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/1.1.0/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/1.1.0/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/1.1.0/api/tutorials/datasets">API & SDK 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/1.1.0/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/1.1.0/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/1.1.0/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/1.1.0/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/1.1.0/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/1.1.0/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/1.1.0/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/1.1.0/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/1.1.0/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/1.1.0/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="theme-doc-version-banner alert alert--warning margin-bottom--md" role="alert"><div>This is documentation for <!-- -->DataHub<!-- --> <b>1.1.0</b>, which is no longer actively maintained.</div><div class="margin-top--md">For up-to-date documentation, see the <b><a href="/docs/python-sdk/urns">latest version</a></b> (<!-- -->Next<!-- -->).</div></div><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">Python SDK Reference</span><meta itemprop="position" content="2"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">URNs</span><meta itemprop="position" content="3"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: 1.1.0</span><div class="theme-doc-markdown markdown"><header><h1>URNs</h1></header><div><article class="bd-article" role="main">
|
||
<section id="module-datahub.metadata.urns">
|
||
<span id="urns"></span>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.AssertionUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">AssertionUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">assertion_id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>assertion_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.AssertionUrn" title="datahub.metadata.urns.AssertionUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.AssertionUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'assertion'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'assertion'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.AssertionUrn.assertion_id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">assertion_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.AssertionUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.AssertionUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.AssertionUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.AssertionUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.AssertionKeyClass" title="datahub.metadata.schema_classes.AssertionKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.AssertionUrn" title="datahub.metadata.urns.AssertionUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.AssertionUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.AssertionUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.AssertionUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.AssertionUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.AssertionUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.AssertionUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.AssertionUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.AssertionKeyClass" title="datahub.metadata.schema_classes.AssertionKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.AssertionUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.AssertionUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.BusinessAttributeUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">BusinessAttributeUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.BusinessAttributeUrn" title="datahub.metadata.urns.BusinessAttributeUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusinessAttributeUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.BusinessAttributeUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'businessAttribute'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'businessAttribute'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.BusinessAttributeUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.BusinessAttributeUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.BusinessAttributeUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.BusinessAttributeUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.BusinessAttributeKeyClass" title="datahub.metadata.schema_classes.BusinessAttributeKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusinessAttributeKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.BusinessAttributeUrn" title="datahub.metadata.urns.BusinessAttributeUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusinessAttributeUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.BusinessAttributeUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.BusinessAttributeUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.BusinessAttributeUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.BusinessAttributeUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.BusinessAttributeUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.BusinessAttributeUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.BusinessAttributeUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.BusinessAttributeUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.BusinessAttributeKeyClass" title="datahub.metadata.schema_classes.BusinessAttributeKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusinessAttributeKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.BusinessAttributeUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.BusinessAttributeUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ChartUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">ChartUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dashboard_tool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">chart_id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>dashboard_tool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>chart_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ChartUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'chart'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'chart'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ChartUrn.chart_id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">chart_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ChartUrn.create_from_ids">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_ids</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">platform</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">platform_instance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>platform</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>platform_instance</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.ChartUrn" title="datahub.metadata.urns.ChartUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChartUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ChartUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ChartUrn.dashboard_tool">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dashboard_tool</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ChartUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ChartUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ChartUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.ChartKeyClass" title="datahub.metadata.schema_classes.ChartKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChartKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.ChartUrn" title="datahub.metadata.urns.ChartUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChartUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ChartUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ChartUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ChartUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ChartUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ChartUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ChartUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ChartUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.ChartKeyClass" title="datahub.metadata.schema_classes.ChartKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChartKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ChartUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ChartUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ContainerUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">ContainerUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guid</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>guid</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.ContainerUrn" title="datahub.metadata.urns.ContainerUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">ContainerUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ContainerUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'container'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'container'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ContainerUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ContainerUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ContainerUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ContainerUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.ContainerKeyClass" title="datahub.metadata.schema_classes.ContainerKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ContainerKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.ContainerUrn" title="datahub.metadata.urns.ContainerUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">ContainerUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ContainerUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ContainerUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ContainerUrn.guid">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">guid</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ContainerUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ContainerUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ContainerUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ContainerUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ContainerUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.ContainerKeyClass" title="datahub.metadata.schema_classes.ContainerKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ContainerKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ContainerUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ContainerUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpGroupUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">CorpGroupUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.CorpGroupUrn" title="datahub.metadata.urns.CorpGroupUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpGroupUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpGroupUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'corpGroup'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'corpGroup'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpGroupUrn.create_from_id">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_id</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><div class="deprecated">
|
||
<p><span class="versionmodified deprecated">Deprecated since version 0.12.0.2: </span>Use the constructor instead</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.CorpGroupUrn" title="datahub.metadata.urns.CorpGroupUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpGroupUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpGroupUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpGroupUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpGroupUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpGroupUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.CorpGroupKeyClass" title="datahub.metadata.schema_classes.CorpGroupKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpGroupKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.CorpGroupUrn" title="datahub.metadata.urns.CorpGroupUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpGroupUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpGroupUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpGroupUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpGroupUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpGroupUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpGroupUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpGroupUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpGroupUrn.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpGroupUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.CorpGroupKeyClass" title="datahub.metadata.schema_classes.CorpGroupKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpGroupKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpGroupUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpGroupUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpUserUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">CorpUserUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">username</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>username</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.CorpUserUrn" title="datahub.metadata.urns.CorpUserUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpUserUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpUserUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'corpuser'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'corpuser'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpUserUrn.create_from_id">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_id</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><div class="deprecated">
|
||
<p><span class="versionmodified deprecated">Deprecated since version 0.12.0.2: </span>Use the constructor instead</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.CorpUserUrn" title="datahub.metadata.urns.CorpUserUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpUserUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpUserUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpUserUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpUserUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpUserUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.CorpUserKeyClass" title="datahub.metadata.schema_classes.CorpUserKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpUserKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.CorpUserUrn" title="datahub.metadata.urns.CorpUserUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpUserUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpUserUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpUserUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpUserUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpUserUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpUserUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpUserUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpUserUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.CorpUserKeyClass" title="datahub.metadata.schema_classes.CorpUserKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpUserKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpUserUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpUserUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.CorpUserUrn.username">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">username</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DashboardUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DashboardUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dashboard_tool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dashboard_id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>dashboard_tool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>dashboard_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DashboardUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dashboard'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dashboard'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DashboardUrn.create_from_ids">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_ids</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">platform</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">platform_instance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>platform</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>platform_instance</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DashboardUrn" title="datahub.metadata.urns.DashboardUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DashboardUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DashboardUrn.dashboard_id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dashboard_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DashboardUrn.dashboard_tool">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dashboard_tool</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DashboardUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DashboardUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DashboardUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DashboardKeyClass" title="datahub.metadata.schema_classes.DashboardKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DashboardUrn" title="datahub.metadata.urns.DashboardUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DashboardUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DashboardUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DashboardUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DashboardUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DashboardUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DashboardUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DashboardUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DashboardKeyClass" title="datahub.metadata.schema_classes.DashboardKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DashboardUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DashboardUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataContractUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataContractUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataContractUrn" title="datahub.metadata.urns.DataContractUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataContractUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataContractUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataContract'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataContract'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataContractUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataContractUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataContractUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataContractUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataContractKeyClass" title="datahub.metadata.schema_classes.DataContractKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataContractKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataContractUrn" title="datahub.metadata.urns.DataContractUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataContractUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataContractUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataContractUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataContractUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataContractUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataContractUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataContractUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataContractUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataContractUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataContractKeyClass" title="datahub.metadata.schema_classes.DataContractKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataContractKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataContractUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataContractUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataFlowUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataFlowUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">orchestrator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">flow_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>orchestrator</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>flow_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataFlowUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataFlow'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataFlow'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataFlowUrn.cluster">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cluster</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataFlowUrn.create_from_ids">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_ids</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">orchestrator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">flow_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">platform_instance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>orchestrator</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>flow_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>env</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>platform_instance</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataFlowUrn" title="datahub.metadata.urns.DataFlowUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFlowUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataFlowUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataFlowUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataFlowUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataFlowUrn.flow_id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">flow_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataFlowUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataFlowKeyClass" title="datahub.metadata.schema_classes.DataFlowKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFlowKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataFlowUrn" title="datahub.metadata.urns.DataFlowUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFlowUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataFlowUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataFlowUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataFlowUrn.get_env">
|
||
<span class="sig-name descname"><span class="pre">get_env</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><div class="deprecated">
|
||
<p><span class="versionmodified deprecated">Deprecated since version 0.12.0.2: </span>Use .cluster instead</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataFlowUrn.get_flow_id">
|
||
<span class="sig-name descname"><span class="pre">get_flow_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><div class="deprecated">
|
||
<p><span class="versionmodified deprecated">Deprecated since version 0.12.0.2: </span>Use .flow_id instead</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataFlowUrn.get_orchestrator_name">
|
||
<span class="sig-name descname"><span class="pre">get_orchestrator_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><div class="deprecated">
|
||
<p><span class="versionmodified deprecated">Deprecated since version 0.12.0.2: </span>Use .orchestrator instead</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataFlowUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataFlowUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataFlowUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataFlowUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataFlowUrn.orchestrator">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">orchestrator</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataFlowUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataFlowKeyClass" title="datahub.metadata.schema_classes.DataFlowKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFlowKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataFlowUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataFlowUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubAccessTokenUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataHubAccessTokenUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataHubAccessTokenUrn" title="datahub.metadata.urns.DataHubAccessTokenUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubAccessTokenUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubAccessTokenUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataHubAccessToken'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataHubAccessToken'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubAccessTokenUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubAccessTokenUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubAccessTokenUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubAccessTokenUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubAccessTokenKeyClass" title="datahub.metadata.schema_classes.DataHubAccessTokenKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubAccessTokenKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataHubAccessTokenUrn" title="datahub.metadata.urns.DataHubAccessTokenUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubAccessTokenUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubAccessTokenUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubAccessTokenUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubAccessTokenUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubAccessTokenUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubAccessTokenUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubAccessTokenUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubAccessTokenUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubAccessTokenUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubAccessTokenKeyClass" title="datahub.metadata.schema_classes.DataHubAccessTokenKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubAccessTokenKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubAccessTokenUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubAccessTokenUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubActionUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataHubActionUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataHubActionUrn" title="datahub.metadata.urns.DataHubActionUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubActionUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubActionUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataHubAction'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataHubAction'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubActionUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubActionUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubActionUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubActionUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubActionKeyClass" title="datahub.metadata.schema_classes.DataHubActionKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubActionKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataHubActionUrn" title="datahub.metadata.urns.DataHubActionUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubActionUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubActionUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubActionUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubActionUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubActionUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubActionUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubActionUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubActionUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubActionUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubActionKeyClass" title="datahub.metadata.schema_classes.DataHubActionKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubActionKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubActionUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubActionUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubConnectionUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataHubConnectionUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataHubConnectionUrn" title="datahub.metadata.urns.DataHubConnectionUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubConnectionUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubConnectionUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataHubConnection'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataHubConnection'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubConnectionUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubConnectionUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubConnectionUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubConnectionUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubConnectionKeyClass" title="datahub.metadata.schema_classes.DataHubConnectionKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubConnectionKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataHubConnectionUrn" title="datahub.metadata.urns.DataHubConnectionUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubConnectionUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubConnectionUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubConnectionUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubConnectionUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubConnectionUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubConnectionUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubConnectionUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubConnectionUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubConnectionUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubConnectionKeyClass" title="datahub.metadata.schema_classes.DataHubConnectionKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubConnectionKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubConnectionUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubConnectionUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubExecutionRequestUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataHubExecutionRequestUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataHubExecutionRequestUrn" title="datahub.metadata.urns.DataHubExecutionRequestUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubExecutionRequestUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubExecutionRequestUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataHubExecutionRequest'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataHubExecutionRequest'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubExecutionRequestUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubExecutionRequestUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubExecutionRequestUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubExecutionRequestUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.ExecutionRequestKeyClass" title="datahub.metadata.schema_classes.ExecutionRequestKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExecutionRequestKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataHubExecutionRequestUrn" title="datahub.metadata.urns.DataHubExecutionRequestUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubExecutionRequestUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubExecutionRequestUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubExecutionRequestUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubExecutionRequestUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubExecutionRequestUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubExecutionRequestUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubExecutionRequestUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubExecutionRequestUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubExecutionRequestUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.ExecutionRequestKeyClass" title="datahub.metadata.schema_classes.ExecutionRequestKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExecutionRequestKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubExecutionRequestUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubExecutionRequestUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubIngestionSourceUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataHubIngestionSourceUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataHubIngestionSourceUrn" title="datahub.metadata.urns.DataHubIngestionSourceUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubIngestionSourceUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubIngestionSourceUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataHubIngestionSource'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataHubIngestionSource'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubIngestionSourceUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubIngestionSourceUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubIngestionSourceUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubIngestionSourceUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubIngestionSourceKeyClass" title="datahub.metadata.schema_classes.DataHubIngestionSourceKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubIngestionSourceKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataHubIngestionSourceUrn" title="datahub.metadata.urns.DataHubIngestionSourceUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubIngestionSourceUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubIngestionSourceUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubIngestionSourceUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubIngestionSourceUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubIngestionSourceUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubIngestionSourceUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubIngestionSourceUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubIngestionSourceUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubIngestionSourceUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubIngestionSourceKeyClass" title="datahub.metadata.schema_classes.DataHubIngestionSourceKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubIngestionSourceKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubIngestionSourceUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubIngestionSourceUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubOpenAPISchemaUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataHubOpenAPISchemaUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataHubOpenAPISchemaUrn" title="datahub.metadata.urns.DataHubOpenAPISchemaUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubOpenAPISchemaUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubOpenAPISchemaUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataHubOpenAPISchema'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataHubOpenAPISchema'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubOpenAPISchemaUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubOpenAPISchemaUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubOpenAPISchemaUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubOpenAPISchemaUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubOpenAPISchemaKeyClass" title="datahub.metadata.schema_classes.DataHubOpenAPISchemaKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubOpenAPISchemaKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataHubOpenAPISchemaUrn" title="datahub.metadata.urns.DataHubOpenAPISchemaUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubOpenAPISchemaUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubOpenAPISchemaUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubOpenAPISchemaUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubOpenAPISchemaUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubOpenAPISchemaUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubOpenAPISchemaUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubOpenAPISchemaUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubOpenAPISchemaUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubOpenAPISchemaUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubOpenAPISchemaKeyClass" title="datahub.metadata.schema_classes.DataHubOpenAPISchemaKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubOpenAPISchemaKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubOpenAPISchemaUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubOpenAPISchemaUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPersonaUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataHubPersonaUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataHubPersonaUrn" title="datahub.metadata.urns.DataHubPersonaUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubPersonaUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPersonaUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataHubPersona'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataHubPersona'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPersonaUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPersonaUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPersonaUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPersonaUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubPersonaKeyClass" title="datahub.metadata.schema_classes.DataHubPersonaKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubPersonaKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataHubPersonaUrn" title="datahub.metadata.urns.DataHubPersonaUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubPersonaUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPersonaUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPersonaUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPersonaUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPersonaUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPersonaUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPersonaUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPersonaUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPersonaUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubPersonaKeyClass" title="datahub.metadata.schema_classes.DataHubPersonaKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubPersonaKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPersonaUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPersonaUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPolicyUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataHubPolicyUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataHubPolicyUrn" title="datahub.metadata.urns.DataHubPolicyUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubPolicyUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPolicyUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataHubPolicy'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataHubPolicy'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPolicyUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPolicyUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPolicyUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPolicyUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubPolicyKeyClass" title="datahub.metadata.schema_classes.DataHubPolicyKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubPolicyKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataHubPolicyUrn" title="datahub.metadata.urns.DataHubPolicyUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubPolicyUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPolicyUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPolicyUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPolicyUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPolicyUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPolicyUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPolicyUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPolicyUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPolicyUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubPolicyKeyClass" title="datahub.metadata.schema_classes.DataHubPolicyKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubPolicyKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPolicyUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubPolicyUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRetentionUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataHubRetentionUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspect_name</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>entity_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspect_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRetentionUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataHubRetention'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataHubRetention'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRetentionUrn.aspect_name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspect_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRetentionUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRetentionUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRetentionUrn.entity_name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRetentionUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRetentionUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubRetentionKeyClass" title="datahub.metadata.schema_classes.DataHubRetentionKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubRetentionKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataHubRetentionUrn" title="datahub.metadata.urns.DataHubRetentionUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubRetentionUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRetentionUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRetentionUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRetentionUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRetentionUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRetentionUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRetentionUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRetentionUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubRetentionKeyClass" title="datahub.metadata.schema_classes.DataHubRetentionKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubRetentionKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRetentionUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRetentionUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRoleUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataHubRoleUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataHubRoleUrn" title="datahub.metadata.urns.DataHubRoleUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubRoleUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRoleUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataHubRole'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataHubRole'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRoleUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRoleUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRoleUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRoleUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubRoleKeyClass" title="datahub.metadata.schema_classes.DataHubRoleKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubRoleKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataHubRoleUrn" title="datahub.metadata.urns.DataHubRoleUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubRoleUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRoleUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRoleUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRoleUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRoleUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRoleUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRoleUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRoleUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRoleUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubRoleKeyClass" title="datahub.metadata.schema_classes.DataHubRoleKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubRoleKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRoleUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubRoleUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubSecretUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataHubSecretUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataHubSecretUrn" title="datahub.metadata.urns.DataHubSecretUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubSecretUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubSecretUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataHubSecret'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataHubSecret'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubSecretUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubSecretUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubSecretUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubSecretUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubSecretKeyClass" title="datahub.metadata.schema_classes.DataHubSecretKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubSecretKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataHubSecretUrn" title="datahub.metadata.urns.DataHubSecretUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubSecretUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubSecretUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubSecretUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubSecretUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubSecretUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubSecretUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubSecretUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubSecretUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubSecretUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubSecretKeyClass" title="datahub.metadata.schema_classes.DataHubSecretKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubSecretKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubSecretUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubSecretUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubStepStateUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataHubStepStateUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataHubStepStateUrn" title="datahub.metadata.urns.DataHubStepStateUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubStepStateUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubStepStateUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataHubStepState'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataHubStepState'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubStepStateUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubStepStateUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubStepStateUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubStepStateUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubStepStateKeyClass" title="datahub.metadata.schema_classes.DataHubStepStateKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubStepStateKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataHubStepStateUrn" title="datahub.metadata.urns.DataHubStepStateUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubStepStateUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubStepStateUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubStepStateUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubStepStateUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubStepStateUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubStepStateUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubStepStateUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubStepStateUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubStepStateUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubStepStateKeyClass" title="datahub.metadata.schema_classes.DataHubStepStateKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubStepStateKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubStepStateUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubStepStateUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubUpgradeUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataHubUpgradeUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataHubUpgradeUrn" title="datahub.metadata.urns.DataHubUpgradeUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubUpgradeUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubUpgradeUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataHubUpgrade'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataHubUpgrade'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubUpgradeUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubUpgradeUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubUpgradeUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubUpgradeUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubUpgradeKeyClass" title="datahub.metadata.schema_classes.DataHubUpgradeKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubUpgradeKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataHubUpgradeUrn" title="datahub.metadata.urns.DataHubUpgradeUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubUpgradeUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubUpgradeUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubUpgradeUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubUpgradeUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubUpgradeUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubUpgradeUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubUpgradeUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubUpgradeUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubUpgradeUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubUpgradeKeyClass" title="datahub.metadata.schema_classes.DataHubUpgradeKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubUpgradeKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubUpgradeUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubUpgradeUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubViewUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataHubViewUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataHubViewUrn" title="datahub.metadata.urns.DataHubViewUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubViewUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubViewUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataHubView'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataHubView'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubViewUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubViewUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubViewUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubViewUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubViewKeyClass" title="datahub.metadata.schema_classes.DataHubViewKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubViewKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataHubViewUrn" title="datahub.metadata.urns.DataHubViewUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubViewUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubViewUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubViewUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubViewUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubViewUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubViewUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubViewUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubViewUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubViewUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataHubViewKeyClass" title="datahub.metadata.schema_classes.DataHubViewKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubViewKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubViewUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataHubViewUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataJobUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataJobUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flow</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">job_id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>flow</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataFlowUrn" title="datahub.metadata.urns.DataFlowUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFlowUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>job_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataJobUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataJob'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataJob'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataJobUrn.create_from_ids">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_ids</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data_flow_urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">job_id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>data_flow_urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>job_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataJobUrn" title="datahub.metadata.urns.DataJobUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataJobUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataJobUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataJobUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataJobUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataJobUrn.flow">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">flow</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataJobUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataJobKeyClass" title="datahub.metadata.schema_classes.DataJobKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataJobKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataJobUrn" title="datahub.metadata.urns.DataJobUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataJobUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataJobUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataJobUrn.get_data_flow_urn">
|
||
<span class="sig-name descname"><span class="pre">get_data_flow_urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#datahub.metadata.urns.DataFlowUrn" title="datahub.metadata.urns.DataFlowUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFlowUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataJobUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataJobUrn.get_job_id">
|
||
<span class="sig-name descname"><span class="pre">get_job_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><div class="deprecated">
|
||
<p><span class="versionmodified deprecated">Deprecated since version 0.12.0.2: </span>Use .job_id instead</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataJobUrn.job_id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">job_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataJobUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataJobUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataJobUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataJobUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataJobUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataJobKeyClass" title="datahub.metadata.schema_classes.DataJobKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataJobKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataJobUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataJobUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformInstanceUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataPlatformInstanceUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">platform</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instance</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>platform</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataPlatformUrn" title="datahub.metadata.urns.DataPlatformUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>instance</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformInstanceUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataPlatformInstance'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataPlatformInstance'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformInstanceUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformInstanceUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformInstanceUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformInstanceUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataPlatformInstanceKeyClass" title="datahub.metadata.schema_classes.DataPlatformInstanceKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformInstanceKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataPlatformInstanceUrn" title="datahub.metadata.urns.DataPlatformInstanceUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformInstanceUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformInstanceUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformInstanceUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformInstanceUrn.instance">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">instance</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformInstanceUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformInstanceUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformInstanceUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformInstanceUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformInstanceUrn.platform">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">platform</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformInstanceUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataPlatformInstanceKeyClass" title="datahub.metadata.schema_classes.DataPlatformInstanceKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformInstanceKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformInstanceUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformInstanceUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataPlatformUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">platform_name</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>platform_name</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataPlatformUrn" title="datahub.metadata.urns.DataPlatformUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataPlatform'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataPlatform'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformUrn.create_from_id">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_id</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><div class="deprecated">
|
||
<p><span class="versionmodified deprecated">Deprecated since version 0.12.0.2: </span>Use the constructor instead</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataPlatformUrn" title="datahub.metadata.urns.DataPlatformUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataPlatformKeyClass" title="datahub.metadata.schema_classes.DataPlatformKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataPlatformUrn" title="datahub.metadata.urns.DataPlatformUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformUrn.platform_name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">platform_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataPlatformKeyClass" title="datahub.metadata.schema_classes.DataPlatformKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataPlatformUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessInstanceUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataProcessInstanceUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataProcessInstanceUrn" title="datahub.metadata.urns.DataProcessInstanceUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcessInstanceUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessInstanceUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataProcessInstance'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataProcessInstance'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessInstanceUrn.create_from_id">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_id</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><div class="deprecated">
|
||
<p><span class="versionmodified deprecated">Deprecated since version 0.12.0.2: </span>Use the constructor instead</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataProcessInstanceUrn" title="datahub.metadata.urns.DataProcessInstanceUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcessInstanceUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessInstanceUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessInstanceUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessInstanceUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessInstanceUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataProcessInstanceKeyClass" title="datahub.metadata.schema_classes.DataProcessInstanceKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcessInstanceKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataProcessInstanceUrn" title="datahub.metadata.urns.DataProcessInstanceUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcessInstanceUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessInstanceUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessInstanceUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessInstanceUrn.get_dataprocessinstance_id">
|
||
<span class="sig-name descname"><span class="pre">get_dataprocessinstance_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><div class="deprecated">
|
||
<p><span class="versionmodified deprecated">Deprecated since version 0.12.0.2: </span>Use .id instead</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessInstanceUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessInstanceUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessInstanceUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessInstanceUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessInstanceUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessInstanceUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataProcessInstanceKeyClass" title="datahub.metadata.schema_classes.DataProcessInstanceKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcessInstanceKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessInstanceUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessInstanceUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataProcessUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">orchestrator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'PROD'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>orchestrator</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>env</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataProcess'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataProcess'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessUrn.env">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">env</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataProcessKeyClass" title="datahub.metadata.schema_classes.DataProcessKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcessKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataProcessUrn" title="datahub.metadata.urns.DataProcessUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcessUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessUrn.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessUrn.orchestrator">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">orchestrator</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataProcessKeyClass" title="datahub.metadata.schema_classes.DataProcessKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcessKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProcessUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProductUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataProductUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataProductUrn" title="datahub.metadata.urns.DataProductUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProductUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProductUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataProduct'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataProduct'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProductUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProductUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProductUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProductUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataProductKeyClass" title="datahub.metadata.schema_classes.DataProductKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProductKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataProductUrn" title="datahub.metadata.urns.DataProductUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProductUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProductUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProductUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProductUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProductUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProductUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProductUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProductUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProductUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataProductKeyClass" title="datahub.metadata.schema_classes.DataProductKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProductKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProductUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataProductUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataTypeUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DataTypeUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataTypeUrn" title="datahub.metadata.urns.DataTypeUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataTypeUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataTypeUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataType'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataType'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataTypeUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataTypeUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataTypeUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataTypeUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataTypeKeyClass" title="datahub.metadata.schema_classes.DataTypeKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataTypeKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DataTypeUrn" title="datahub.metadata.urns.DataTypeUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataTypeUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataTypeUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataTypeUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataTypeUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataTypeUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataTypeUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataTypeUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataTypeUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataTypeUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DataTypeKeyClass" title="datahub.metadata.schema_classes.DataTypeKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataTypeKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataTypeUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DataTypeUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DatasetUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">platform</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'PROD'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>platform</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataPlatformUrn" title="datahub.metadata.urns.DataPlatformUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>env</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'dataset'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dataset'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn.create_from_ids">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_ids</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">platform_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">table_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">platform_instance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>platform_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>table_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>env</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>platform_instance</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DatasetUrn" title="datahub.metadata.urns.DatasetUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn.env">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">env</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DatasetKeyClass" title="datahub.metadata.schema_classes.DatasetKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DatasetUrn" title="datahub.metadata.urns.DatasetUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn.get_data_platform_urn">
|
||
<span class="sig-name descname"><span class="pre">get_data_platform_urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#datahub.metadata.urns.DataPlatformUrn" title="datahub.metadata.urns.DataPlatformUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn.get_dataset_name">
|
||
<span class="sig-name descname"><span class="pre">get_dataset_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><div class="deprecated">
|
||
<p><span class="versionmodified deprecated">Deprecated since version 0.12.0.2: </span>Use .name instead</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn.get_env">
|
||
<span class="sig-name descname"><span class="pre">get_env</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><div class="deprecated">
|
||
<p><span class="versionmodified deprecated">Deprecated since version 0.12.0.2: </span>Use .env instead</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn.get_simple_field_path_from_v2_field_path">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_simple_field_path_from_v2_field_path</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>A helper function to extract simple . path notation from the v2 field path</p>
|
||
<div class="deprecated">
|
||
<p><span class="versionmodified deprecated">Deprecated since version 0.12.0.2: </span>Use the function from the field_paths module instead</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>field_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn.platform">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">platform</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DatasetKeyClass" title="datahub.metadata.schema_classes.DatasetKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DatasetUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DomainUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">DomainUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DomainUrn" title="datahub.metadata.urns.DomainUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DomainUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DomainUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'domain'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'domain'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DomainUrn.create_from_id">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_id</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><div class="deprecated">
|
||
<p><span class="versionmodified deprecated">Deprecated since version 0.12.0.2: </span>Use the constructor instead</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DomainUrn" title="datahub.metadata.urns.DomainUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DomainUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DomainUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DomainUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DomainUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DomainUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.DomainKeyClass" title="datahub.metadata.schema_classes.DomainKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DomainKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.DomainUrn" title="datahub.metadata.urns.DomainUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DomainUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DomainUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DomainUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DomainUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DomainUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DomainUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DomainUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DomainUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DomainUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.DomainKeyClass" title="datahub.metadata.schema_classes.DomainKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DomainKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DomainUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.DomainUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.EntityTypeUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">EntityTypeUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.EntityTypeUrn" title="datahub.metadata.urns.EntityTypeUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">EntityTypeUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.EntityTypeUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'entityType'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'entityType'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.EntityTypeUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.EntityTypeUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.EntityTypeUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.EntityTypeUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.EntityTypeKeyClass" title="datahub.metadata.schema_classes.EntityTypeKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EntityTypeKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.EntityTypeUrn" title="datahub.metadata.urns.EntityTypeUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">EntityTypeUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.EntityTypeUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.EntityTypeUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.EntityTypeUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.EntityTypeUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.EntityTypeUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.EntityTypeUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.EntityTypeUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.EntityTypeUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.EntityTypeKeyClass" title="datahub.metadata.schema_classes.EntityTypeKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EntityTypeKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.EntityTypeUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.EntityTypeUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ErModelRelationshipUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">ErModelRelationshipUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.ErModelRelationshipUrn" title="datahub.metadata.urns.ErModelRelationshipUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">ErModelRelationshipUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ErModelRelationshipUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'erModelRelationship'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'erModelRelationship'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ErModelRelationshipUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ErModelRelationshipUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ErModelRelationshipUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ErModelRelationshipUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.ERModelRelationshipKeyClass" title="datahub.metadata.schema_classes.ERModelRelationshipKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ERModelRelationshipKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.ErModelRelationshipUrn" title="datahub.metadata.urns.ErModelRelationshipUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">ErModelRelationshipUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ErModelRelationshipUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ErModelRelationshipUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ErModelRelationshipUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ErModelRelationshipUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ErModelRelationshipUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ErModelRelationshipUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ErModelRelationshipUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ErModelRelationshipUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.ERModelRelationshipKeyClass" title="datahub.metadata.schema_classes.ERModelRelationshipKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ERModelRelationshipKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ErModelRelationshipUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.ErModelRelationshipUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.FormUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">FormUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.FormUrn" title="datahub.metadata.urns.FormUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">FormUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.FormUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'form'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'form'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.FormUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.FormUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.FormUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.FormUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.FormKeyClass" title="datahub.metadata.schema_classes.FormKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FormKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.FormUrn" title="datahub.metadata.urns.FormUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">FormUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.FormUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.FormUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.FormUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.FormUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.FormUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.FormUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.FormUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.FormUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.FormKeyClass" title="datahub.metadata.schema_classes.FormKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FormKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.FormUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.FormUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlobalSettingsUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">GlobalSettingsUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.GlobalSettingsUrn" title="datahub.metadata.urns.GlobalSettingsUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalSettingsUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlobalSettingsUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'globalSettings'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'globalSettings'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlobalSettingsUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlobalSettingsUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlobalSettingsUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlobalSettingsUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.GlobalSettingsKeyClass" title="datahub.metadata.schema_classes.GlobalSettingsKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalSettingsKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.GlobalSettingsUrn" title="datahub.metadata.urns.GlobalSettingsUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalSettingsUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlobalSettingsUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlobalSettingsUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlobalSettingsUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlobalSettingsUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlobalSettingsUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlobalSettingsUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlobalSettingsUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlobalSettingsUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.GlobalSettingsKeyClass" title="datahub.metadata.schema_classes.GlobalSettingsKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalSettingsKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlobalSettingsUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlobalSettingsUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryNodeUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">GlossaryNodeUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.GlossaryNodeUrn" title="datahub.metadata.urns.GlossaryNodeUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryNodeUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryNodeUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'glossaryNode'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'glossaryNode'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryNodeUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryNodeUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryNodeUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryNodeUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.GlossaryNodeKeyClass" title="datahub.metadata.schema_classes.GlossaryNodeKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryNodeKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.GlossaryNodeUrn" title="datahub.metadata.urns.GlossaryNodeUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryNodeUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryNodeUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryNodeUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryNodeUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryNodeUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryNodeUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryNodeUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryNodeUrn.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryNodeUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.GlossaryNodeKeyClass" title="datahub.metadata.schema_classes.GlossaryNodeKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryNodeKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryNodeUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryNodeUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryTermUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">GlossaryTermUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.GlossaryTermUrn" title="datahub.metadata.urns.GlossaryTermUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryTermUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryTermUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'glossaryTerm'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'glossaryTerm'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryTermUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryTermUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryTermUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryTermUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.GlossaryTermKeyClass" title="datahub.metadata.schema_classes.GlossaryTermKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryTermKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.GlossaryTermUrn" title="datahub.metadata.urns.GlossaryTermUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryTermUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryTermUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryTermUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryTermUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryTermUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryTermUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryTermUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryTermUrn.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryTermUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.GlossaryTermKeyClass" title="datahub.metadata.schema_classes.GlossaryTermKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryTermKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryTermUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.GlossaryTermUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.IncidentUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">IncidentUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.IncidentUrn" title="datahub.metadata.urns.IncidentUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncidentUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.IncidentUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'incident'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'incident'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.IncidentUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.IncidentUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.IncidentUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.IncidentUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.IncidentKeyClass" title="datahub.metadata.schema_classes.IncidentKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncidentKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.IncidentUrn" title="datahub.metadata.urns.IncidentUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncidentUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.IncidentUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.IncidentUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.IncidentUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.IncidentUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.IncidentUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.IncidentUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.IncidentUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.IncidentUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.IncidentKeyClass" title="datahub.metadata.schema_classes.IncidentKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncidentKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.IncidentUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.IncidentUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.InviteTokenUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">InviteTokenUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.InviteTokenUrn" title="datahub.metadata.urns.InviteTokenUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">InviteTokenUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.InviteTokenUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'inviteToken'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'inviteToken'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.InviteTokenUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.InviteTokenUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.InviteTokenUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.InviteTokenUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.InviteTokenKeyClass" title="datahub.metadata.schema_classes.InviteTokenKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">InviteTokenKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.InviteTokenUrn" title="datahub.metadata.urns.InviteTokenUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">InviteTokenUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.InviteTokenUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.InviteTokenUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.InviteTokenUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.InviteTokenUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.InviteTokenUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.InviteTokenUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.InviteTokenUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.InviteTokenUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.InviteTokenKeyClass" title="datahub.metadata.schema_classes.InviteTokenKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">InviteTokenKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.InviteTokenUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.InviteTokenUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureTableUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">MlFeatureTableUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">platform</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>platform</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataPlatformUrn" title="datahub.metadata.urns.DataPlatformUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureTableUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'mlFeatureTable'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'mlFeatureTable'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureTableUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureTableUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureTableUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureTableUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.MLFeatureTableKeyClass" title="datahub.metadata.schema_classes.MLFeatureTableKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLFeatureTableKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.MlFeatureTableUrn" title="datahub.metadata.urns.MlFeatureTableUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">MlFeatureTableUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureTableUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureTableUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureTableUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureTableUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureTableUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureTableUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureTableUrn.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureTableUrn.platform">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">platform</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureTableUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.MLFeatureTableKeyClass" title="datahub.metadata.schema_classes.MLFeatureTableKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLFeatureTableKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureTableUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureTableUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">MlFeatureUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feature_namespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>feature_namespace</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'mlFeature'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'mlFeature'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureUrn.feature_namespace">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">feature_namespace</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.MLFeatureKeyClass" title="datahub.metadata.schema_classes.MLFeatureKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLFeatureKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.MlFeatureUrn" title="datahub.metadata.urns.MlFeatureUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">MlFeatureUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureUrn.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.MLFeatureKeyClass" title="datahub.metadata.schema_classes.MLFeatureKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLFeatureKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlFeatureUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelDeploymentUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">MlModelDeploymentUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">platform</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'PROD'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>platform</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataPlatformUrn" title="datahub.metadata.urns.DataPlatformUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>env</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelDeploymentUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'mlModelDeployment'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'mlModelDeployment'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelDeploymentUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelDeploymentUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelDeploymentUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelDeploymentUrn.env">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">env</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelDeploymentUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.MLModelDeploymentKeyClass" title="datahub.metadata.schema_classes.MLModelDeploymentKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelDeploymentKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.MlModelDeploymentUrn" title="datahub.metadata.urns.MlModelDeploymentUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">MlModelDeploymentUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelDeploymentUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelDeploymentUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelDeploymentUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelDeploymentUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelDeploymentUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelDeploymentUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelDeploymentUrn.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelDeploymentUrn.platform">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">platform</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelDeploymentUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.MLModelDeploymentKeyClass" title="datahub.metadata.schema_classes.MLModelDeploymentKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelDeploymentKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelDeploymentUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelDeploymentUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelGroupUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">MlModelGroupUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">platform</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'PROD'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>platform</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataPlatformUrn" title="datahub.metadata.urns.DataPlatformUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>env</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelGroupUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'mlModelGroup'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'mlModelGroup'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelGroupUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelGroupUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelGroupUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelGroupUrn.env">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">env</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelGroupUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.MLModelGroupKeyClass" title="datahub.metadata.schema_classes.MLModelGroupKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelGroupKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.MlModelGroupUrn" title="datahub.metadata.urns.MlModelGroupUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">MlModelGroupUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelGroupUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelGroupUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelGroupUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelGroupUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelGroupUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelGroupUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelGroupUrn.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelGroupUrn.platform">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">platform</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelGroupUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.MLModelGroupKeyClass" title="datahub.metadata.schema_classes.MLModelGroupKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelGroupKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelGroupUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelGroupUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">MlModelUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">platform</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'PROD'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>platform</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.DataPlatformUrn" title="datahub.metadata.urns.DataPlatformUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>env</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'mlModel'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'mlModel'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelUrn.env">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">env</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.MLModelKeyClass" title="datahub.metadata.schema_classes.MLModelKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.MlModelUrn" title="datahub.metadata.urns.MlModelUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">MlModelUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelUrn.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelUrn.platform">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">platform</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.MLModelKeyClass" title="datahub.metadata.schema_classes.MLModelKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlModelUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlPrimaryKeyUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">MlPrimaryKeyUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feature_namespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>feature_namespace</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlPrimaryKeyUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'mlPrimaryKey'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'mlPrimaryKey'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlPrimaryKeyUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlPrimaryKeyUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlPrimaryKeyUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlPrimaryKeyUrn.feature_namespace">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">feature_namespace</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlPrimaryKeyUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.MLPrimaryKeyKeyClass" title="datahub.metadata.schema_classes.MLPrimaryKeyKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLPrimaryKeyKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.MlPrimaryKeyUrn" title="datahub.metadata.urns.MlPrimaryKeyUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">MlPrimaryKeyUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlPrimaryKeyUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlPrimaryKeyUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlPrimaryKeyUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlPrimaryKeyUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlPrimaryKeyUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlPrimaryKeyUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlPrimaryKeyUrn.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlPrimaryKeyUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.MLPrimaryKeyKeyClass" title="datahub.metadata.schema_classes.MLPrimaryKeyKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLPrimaryKeyKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlPrimaryKeyUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.MlPrimaryKeyUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.NotebookUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">NotebookUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">notebook_tool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notebook_id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>notebook_tool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>notebook_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.NotebookUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'notebook'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'notebook'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.NotebookUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.NotebookUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.NotebookUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.NotebookUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.NotebookKeyClass" title="datahub.metadata.schema_classes.NotebookKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">NotebookKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.NotebookUrn" title="datahub.metadata.urns.NotebookUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">NotebookUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.NotebookUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.NotebookUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.NotebookUrn.get_notebook_id">
|
||
<span class="sig-name descname"><span class="pre">get_notebook_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><div class="deprecated">
|
||
<p><span class="versionmodified deprecated">Deprecated since version 0.12.0.2: </span>Use .notebook_id instead</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.NotebookUrn.get_platform_id">
|
||
<span class="sig-name descname"><span class="pre">get_platform_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><div class="deprecated">
|
||
<p><span class="versionmodified deprecated">Deprecated since version 0.12.0.2: </span>Use .notebook_tool instead</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.NotebookUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.NotebookUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.NotebookUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.NotebookUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.NotebookUrn.notebook_id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">notebook_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.NotebookUrn.notebook_tool">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">notebook_tool</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.NotebookUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.NotebookKeyClass" title="datahub.metadata.schema_classes.NotebookKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">NotebookKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.NotebookUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.NotebookUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.OwnershipTypeUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">OwnershipTypeUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.OwnershipTypeUrn" title="datahub.metadata.urns.OwnershipTypeUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipTypeUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.OwnershipTypeUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'ownershipType'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ownershipType'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.OwnershipTypeUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.OwnershipTypeUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.OwnershipTypeUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.OwnershipTypeUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.OwnershipTypeKeyClass" title="datahub.metadata.schema_classes.OwnershipTypeKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipTypeKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.OwnershipTypeUrn" title="datahub.metadata.urns.OwnershipTypeUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipTypeUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.OwnershipTypeUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.OwnershipTypeUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.OwnershipTypeUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.OwnershipTypeUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.OwnershipTypeUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.OwnershipTypeUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.OwnershipTypeUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.OwnershipTypeUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.OwnershipTypeKeyClass" title="datahub.metadata.schema_classes.OwnershipTypeKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipTypeKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.OwnershipTypeUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.OwnershipTypeUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PlatformResourceUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">PlatformResourceUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.PlatformResourceUrn" title="datahub.metadata.urns.PlatformResourceUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlatformResourceUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PlatformResourceUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'platformResource'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'platformResource'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PlatformResourceUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PlatformResourceUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PlatformResourceUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PlatformResourceUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.PlatformResourceKeyClass" title="datahub.metadata.schema_classes.PlatformResourceKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlatformResourceKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.PlatformResourceUrn" title="datahub.metadata.urns.PlatformResourceUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlatformResourceUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PlatformResourceUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PlatformResourceUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PlatformResourceUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PlatformResourceUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PlatformResourceUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PlatformResourceUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PlatformResourceUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PlatformResourceUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.PlatformResourceKeyClass" title="datahub.metadata.schema_classes.PlatformResourceKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlatformResourceKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PlatformResourceUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PlatformResourceUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PostUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">PostUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.PostUrn" title="datahub.metadata.urns.PostUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">PostUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PostUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'post'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'post'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PostUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PostUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PostUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PostUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.PostKeyClass" title="datahub.metadata.schema_classes.PostKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PostKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.PostUrn" title="datahub.metadata.urns.PostUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">PostUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PostUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PostUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PostUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PostUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PostUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PostUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PostUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PostUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.PostKeyClass" title="datahub.metadata.schema_classes.PostKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PostKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PostUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.PostUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.QueryUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">QueryUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.QueryUrn" title="datahub.metadata.urns.QueryUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.QueryUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'query'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'query'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.QueryUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.QueryUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.QueryUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.QueryUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.QueryKeyClass" title="datahub.metadata.schema_classes.QueryKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.QueryUrn" title="datahub.metadata.urns.QueryUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.QueryUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.QueryUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.QueryUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.QueryUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.QueryUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.QueryUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.QueryUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.QueryUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.QueryKeyClass" title="datahub.metadata.schema_classes.QueryKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.QueryUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.QueryUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.RoleUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">RoleUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.RoleUrn" title="datahub.metadata.urns.RoleUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">RoleUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.RoleUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'role'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'role'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.RoleUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.RoleUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.RoleUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.RoleUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.RoleKeyClass" title="datahub.metadata.schema_classes.RoleKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">RoleKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.RoleUrn" title="datahub.metadata.urns.RoleUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">RoleUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.RoleUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.RoleUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.RoleUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.RoleUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.RoleUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.RoleUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.RoleUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.RoleUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.RoleKeyClass" title="datahub.metadata.schema_classes.RoleKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">RoleKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.RoleUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.RoleUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.SchemaFieldUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">SchemaFieldUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">field_path</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>parent</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>field_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.SchemaFieldUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'schemaField'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'schemaField'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.SchemaFieldUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.SchemaFieldUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.SchemaFieldUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.SchemaFieldUrn.field_path">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">field_path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.SchemaFieldUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.SchemaFieldKeyClass" title="datahub.metadata.schema_classes.SchemaFieldKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaFieldKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.SchemaFieldUrn" title="datahub.metadata.urns.SchemaFieldUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaFieldUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.SchemaFieldUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.SchemaFieldUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.SchemaFieldUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.SchemaFieldUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.SchemaFieldUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.SchemaFieldUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.SchemaFieldUrn.parent">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parent</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.SchemaFieldUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.SchemaFieldKeyClass" title="datahub.metadata.schema_classes.SchemaFieldKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaFieldKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.SchemaFieldUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.SchemaFieldUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.StructuredPropertyUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">StructuredPropertyUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.StructuredPropertyUrn" title="datahub.metadata.urns.StructuredPropertyUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">StructuredPropertyUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.StructuredPropertyUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'structuredProperty'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'structuredProperty'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.StructuredPropertyUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.StructuredPropertyUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.StructuredPropertyUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.StructuredPropertyUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.StructuredPropertyKeyClass" title="datahub.metadata.schema_classes.StructuredPropertyKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StructuredPropertyKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.StructuredPropertyUrn" title="datahub.metadata.urns.StructuredPropertyUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">StructuredPropertyUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.StructuredPropertyUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.StructuredPropertyUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.StructuredPropertyUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.StructuredPropertyUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.StructuredPropertyUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.StructuredPropertyUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.StructuredPropertyUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.StructuredPropertyUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.StructuredPropertyKeyClass" title="datahub.metadata.schema_classes.StructuredPropertyKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StructuredPropertyKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.StructuredPropertyUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.StructuredPropertyUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TagUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">TagUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.TagUrn" title="datahub.metadata.urns.TagUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TagUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'tag'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tag'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TagUrn.create_from_id">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_id</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><div class="deprecated">
|
||
<p><span class="versionmodified deprecated">Deprecated since version 0.12.0.2: </span>Use the constructor instead</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.TagUrn" title="datahub.metadata.urns.TagUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TagUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TagUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TagUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TagUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.TagKeyClass" title="datahub.metadata.schema_classes.TagKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.TagUrn" title="datahub.metadata.urns.TagUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TagUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TagUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TagUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TagUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TagUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TagUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TagUrn.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TagUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.TagKeyClass" title="datahub.metadata.schema_classes.TagKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TagUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TagUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TelemetryUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">TelemetryUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.TelemetryUrn" title="datahub.metadata.urns.TelemetryUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">TelemetryUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TelemetryUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'telemetry'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'telemetry'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TelemetryUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TelemetryUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TelemetryUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TelemetryUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.TelemetryKeyClass" title="datahub.metadata.schema_classes.TelemetryKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TelemetryKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.TelemetryUrn" title="datahub.metadata.urns.TelemetryUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">TelemetryUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TelemetryUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TelemetryUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TelemetryUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TelemetryUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TelemetryUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TelemetryUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TelemetryUrn.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TelemetryUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.TelemetryKeyClass" title="datahub.metadata.schema_classes.TelemetryKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TelemetryKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TelemetryUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TelemetryUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TestUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">TestUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.urns.TestUrn" title="datahub.metadata.urns.TestUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">TestUrn</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TestUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'test'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'test'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TestUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TestUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TestUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TestUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.TestKeyClass" title="datahub.metadata.schema_classes.TestKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TestKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.TestUrn" title="datahub.metadata.urns.TestUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">TestUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TestUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TestUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TestUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TestUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TestUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TestUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TestUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TestUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.TestKeyClass" title="datahub.metadata.schema_classes.TestKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TestKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TestUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.TestUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.Urn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">Urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entity_id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>URNs are globally unique identifiers used to refer to entities.</p>
|
||
<p>It will be in format of <a class="reference external" href="urn:li">urn:li</a>:<type>:<id> or <a class="reference external" href="urn:li">urn:li</a>:<type>:(<id1>,<id2>,…)</p>
|
||
<p>A note on encoding: certain characters, particularly commas and parentheses, are
|
||
not allowed in string portions of the URN. However, these are allowed when the urn
|
||
has another urn embedded within it. The main URN class ignores this possibility,
|
||
and assumes that the user provides a valid URN string. However, the specific URN
|
||
classes, such as DatasetUrn, will automatically encode these characters using
|
||
url-encoding when the URN is created and _allow_coercion is enabled (the default).
|
||
However, all from_string methods will try to preserve the string as-is, and will
|
||
raise an error if the string is invalid.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>entity_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.Urn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.Urn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.Urn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.Urn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.Urn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.Urn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.Urn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.Urn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.Urn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.Urn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.Urn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.VersionSetUrn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.urns.</span></span><span class="sig-name descname"><span class="pre">VersionSetUrn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_allow_coercion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_SpecificUrn</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>_allow_coercion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.VersionSetUrn.ENTITY_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'versionSet'</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'versionSet'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.VersionSetUrn.create_from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.VersionSetUrn.entity_ids">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.VersionSetUrn.entity_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.VersionSetUrn.from_key_aspect">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_key_aspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_aspect</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key_aspect</strong> (<a class="reference internal" href="models.html#datahub.metadata.schema_classes.VersionSetKeyClass" title="datahub.metadata.schema_classes.VersionSetKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionSetKeyClass</span></code></a>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#datahub.metadata.urns.VersionSetUrn" title="datahub.metadata.urns.VersionSetUrn"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionSetUrn</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.VersionSetUrn.from_string">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn_str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Create an Urn from its string representation.</p>
|
||
<p>When called against the base Urn class, this method will return a more specific Urn type where possible.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datahub.metadata.urns</span><span class="w"> </span><span class="kn">import</span> <span class="n">DatasetUrn</span><span class="p">,</span> <span class="n">Urn</span>
|
||
<span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="n">urn</span> <span class="o">=</span> <span class="n">Urn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">DatasetUrn</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When called against a specific Urn type (e.g. DatasetUrn.from_string), this method can
|
||
also be used for type narrowing.</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">urn_str</span> <span class="o">=</span> <span class="s1">'urn:li:dataset:(urn:li:dataPlatform:snowflake,my_db.my_schema.my_table,PROD)'</span>
|
||
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">DatasetUrn</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">urn_str</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn_str</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.urns.Urn" title="datahub.metadata.urns.Urn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Urn</span></code></a>]) – The string representation of the urn. Also accepts an existing Urn instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Urn of the given string representation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>InvalidUrnError</strong> – If the string representation is in invalid format.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.VersionSetUrn.get_data_type_from_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_data_type_from_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.VersionSetUrn.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.VersionSetUrn.make_data_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_data_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.VersionSetUrn.make_entity_type_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_entity_type_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity_type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.VersionSetUrn.make_form_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_form_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.VersionSetUrn.make_structured_property_urn">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_structured_property_urn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structured_property</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>structured_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.VersionSetUrn.to_key_aspect">
|
||
<span class="sig-name descname"><span class="pre">to_key_aspect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="models.html#datahub.metadata.schema_classes.VersionSetKeyClass" title="datahub.metadata.schema_classes.VersionSetKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionSetKeyClass</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.VersionSetUrn.urn">
|
||
<span class="sig-name descname"><span class="pre">urn</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><p>Get the string representation of the urn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="datahub.metadata.urns.VersionSetUrn.urn_url_encoded">
|
||
<span class="sig-name descname"><span class="pre">urn_url_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
</section>
|
||
</article></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/urns">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/versioned_docs/version-1.1.0/python-sdk/urns.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_VsjB"></div></div></footer><div class="feedbackWrapper_mUHF"><div class="feedbackWidget_PX4d"><div class="feedbackButtons_wn3V"><strong>Is this page helpful?</strong><div><button class="feedbackButton_UgQs"><span role="img" aria-label="like" class="anticon anticon-like"><svg viewBox="64 64 896 896" focusable="false" data-icon="like" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M885.9 533.7c16.8-22.2 26.1-49.4 26.1-77.7 0-44.9-25.1-87.4-65.5-111.1a67.67 67.67 0 00-34.3-9.3H572.4l6-122.9c1.4-29.7-9.1-57.9-29.5-79.4A106.62 106.62 0 00471 99.9c-52 0-98 35-111.8 85.1l-85.9 311H144c-17.7 0-32 14.3-32 32v364c0 17.7 14.3 32 32 32h601.3c9.2 0 18.2-1.8 26.5-5.4 47.6-20.3 78.3-66.8 78.3-118.4 0-12.6-1.8-25-5.4-37 16.8-22.2 26.1-49.4 26.1-77.7 0-12.6-1.8-25-5.4-37 16.8-22.2 26.1-49.4 26.1-77.7-.2-12.6-2-25.1-5.6-37.1zM184 852V568h81v284h-81zm636.4-353l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 16.5-7.2 32.2-19.6 43l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 16.5-7.2 32.2-19.6 43l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 22.4-13.2 42.6-33.6 51.8H329V564.8l99.5-360.5a44.1 44.1 0 0142.2-32.3c7.6 0 15.1 2.2 21.1 6.7 9.9 7.4 15.2 18.6 14.6 30.5l-9.6 198.4h314.4C829 418.5 840 436.9 840 456c0 16.5-7.2 32.1-19.6 43z"></path></svg></span></button><button class="feedbackButton_UgQs"><span role="img" aria-label="dislike" class="anticon anticon-dislike"><svg viewBox="64 64 896 896" focusable="false" data-icon="dislike" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M885.9 490.3c3.6-12 5.4-24.4 5.4-37 0-28.3-9.3-55.5-26.1-77.7 3.6-12 5.4-24.4 5.4-37 0-28.3-9.3-55.5-26.1-77.7 3.6-12 5.4-24.4 5.4-37 0-51.6-30.7-98.1-78.3-118.4a66.1 66.1 0 00-26.5-5.4H144c-17.7 0-32 14.3-32 32v364c0 17.7 14.3 32 32 32h129.3l85.8 310.8C372.9 889 418.9 924 470.9 924c29.7 0 57.4-11.8 77.9-33.4 20.5-21.5 31-49.7 29.5-79.4l-6-122.9h239.9c12.1 0 23.9-3.2 34.3-9.3 40.4-23.5 65.5-66.1 65.5-111 0-28.3-9.3-55.5-26.1-77.7zM184 456V172h81v284h-81zm627.2 160.4H496.8l9.6 198.4c.6 11.9-4.7 23.1-14.6 30.5-6.1 4.5-13.6 6.8-21.1 6.7a44.28 44.28 0 01-42.2-32.3L329 459.2V172h415.4a56.85 56.85 0 0133.6 51.8c0 9.7-2.3 18.9-6.9 27.3l-13.9 25.4 21.9 19a56.76 56.76 0 0119.6 43c0 9.7-2.3 18.9-6.9 27.3l-13.9 25.4 21.9 19a56.76 56.76 0 0119.6 43c0 9.7-2.3 18.9-6.9 27.3l-14 25.5 21.9 19a56.76 56.76 0 0119.6 43c0 19.1-11 37.5-28.8 48.4z"></path></svg></span></button></div></div></div></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.1.0/python-sdk/models"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Models</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.1.0/metadata-integration/java/as-a-library"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Java Emitter</div></a></nav></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.6a0c26ba.js"></script>
|
||
<script src="/assets/js/main.ea5b2459.js"></script>
|
||
</body>
|
||
</html> |