class datahub.metadata.urns.AssertionUrn(assertion_id, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • assertion_id (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'assertion'
URN_PARTS: ClassVar[int] = 1
property assertion_id: str
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (AssertionKeyClass)

Return type:

AssertionUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

to_key_aspect()
Return type:

AssertionKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.ChartUrn(dashboard_tool, chart_id, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • dashboard_tool (str)

  • chart_id (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'chart'
URN_PARTS: ClassVar[int] = 2
property chart_id: str
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property dashboard_tool: str
property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (ChartKeyClass)

Return type:

ChartUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

to_key_aspect()
Return type:

ChartKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.ContainerUrn(guid, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • guid (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'container'
URN_PARTS: ClassVar[int] = 1
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (ContainerKeyClass)

Return type:

ContainerUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property guid: str
to_key_aspect()
Return type:

ContainerKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.CorpGroupUrn(name, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • name (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'corpGroup'
URN_PARTS: ClassVar[int] = 1
classmethod create_from_id(id)

Deprecated since version 0.12.0.2: Use the constructor instead

Parameters:

id (str)

Return type:

CorpGroupUrn

classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (CorpGroupKeyClass)

Return type:

CorpGroupUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property name: str
to_key_aspect()
Return type:

CorpGroupKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.CorpUserUrn(username, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • username (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'corpuser'
URN_PARTS: ClassVar[int] = 1
classmethod create_from_id(id)

Deprecated since version 0.12.0.2: Use the constructor instead

Parameters:

id (str)

Return type:

CorpUserUrn

classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (CorpUserKeyClass)

Return type:

CorpUserUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

to_key_aspect()
Return type:

CorpUserKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

property username: str
class datahub.metadata.urns.DashboardUrn(dashboard_tool, dashboard_id, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • dashboard_tool (str)

  • dashboard_id (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'dashboard'
URN_PARTS: ClassVar[int] = 2
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property dashboard_id: str
property dashboard_tool: str
property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (DashboardKeyClass)

Return type:

DashboardUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

to_key_aspect()
Return type:

DashboardKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.DataContractUrn(id, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • id (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'dataContract'
URN_PARTS: ClassVar[int] = 1
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (DataContractKeyClass)

Return type:

DataContractUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property id: str
to_key_aspect()
Return type:

DataContractKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.DataFlowUrn(orchestrator, flow_id, cluster, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • orchestrator (str)

  • flow_id (str)

  • cluster (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'dataFlow'
URN_PARTS: ClassVar[int] = 3
property cluster: str
classmethod create_from_ids(orchestrator, flow_id, env, platform_instance=None)
Parameters:

  • orchestrator (str)

  • flow_id (str)

  • env (str)

  • platform_instance (Optional[str])

Return type:

DataFlowUrn

classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
property flow_id: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (DataFlowKeyClass)

Return type:

DataFlowUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

get_env()

Deprecated since version 0.12.0.2: Use .cluster instead

Return type:

str

get_flow_id()

Deprecated since version 0.12.0.2: Use .flow_id instead

Return type:

str

get_orchestrator_name()

Deprecated since version 0.12.0.2: Use .orchestrator instead

Return type:

str

property orchestrator: str
to_key_aspect()
Return type:

DataFlowKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.DataHubRoleUrn(id, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • id (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'dataHubRole'
URN_PARTS: ClassVar[int] = 1
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (DataHubRoleKeyClass)

Return type:

DataHubRoleUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property id: str
to_key_aspect()
Return type:

DataHubRoleKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.DataHubViewUrn(id, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • id (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'dataHubView'
URN_PARTS: ClassVar[int] = 1
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (DataHubViewKeyClass)

Return type:

DataHubViewUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property id: str
to_key_aspect()
Return type:

DataHubViewKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.DataJobUrn(flow, job_id, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • flow (str)

  • job_id (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'dataJob'
URN_PARTS: ClassVar[int] = 2
classmethod create_from_ids(data_flow_urn, job_id)
Parameters:

  • data_flow_urn (str)

  • job_id (str)

Return type:

DataJobUrn

classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
property flow: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (DataJobKeyClass)

Return type:

DataJobUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

get_data_flow_urn()
Return type:

DataFlowUrn

get_job_id()

Deprecated since version 0.12.0.2: Use .job_id instead

Return type:

str

property job_id: str
to_key_aspect()
Return type:

DataJobKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.DataPlatformUrn(platform_name, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • platform_name (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'dataPlatform'
URN_PARTS: ClassVar[int] = 1
classmethod create_from_id(id)

Deprecated since version 0.12.0.2: Use the constructor instead

Parameters:

id (str)

Return type:

DataPlatformUrn

classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (DataPlatformKeyClass)

Return type:

DataPlatformUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property platform_name: str
to_key_aspect()
Return type:

DataPlatformKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.DataProcessInstanceUrn(id, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • id (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'dataProcessInstance'
URN_PARTS: ClassVar[int] = 1
classmethod create_from_id(id)

Deprecated since version 0.12.0.2: Use the constructor instead

Parameters:

id (str)

Return type:

DataProcessInstanceUrn

classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (DataProcessInstanceKeyClass)

Return type:

DataProcessInstanceUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

get_dataprocessinstance_id()

Deprecated since version 0.12.0.2: Use .id instead

Return type:

str

property id: str
to_key_aspect()
Return type:

DataProcessInstanceKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.DataProcessUrn(name, orchestrator, env='PROD', *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • name (str)

  • orchestrator (str)

  • env (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'dataProcess'
URN_PARTS: ClassVar[int] = 3
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
property env: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (DataProcessKeyClass)

Return type:

DataProcessUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property name: str
property orchestrator: str
to_key_aspect()
Return type:

DataProcessKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.DataProductUrn(id, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • id (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'dataProduct'
URN_PARTS: ClassVar[int] = 1
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (DataProductKeyClass)

Return type:

DataProductUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property id: str
to_key_aspect()
Return type:

DataProductKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.DatasetUrn(platform, name, env='PROD', *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • platform (str)

  • name (str)

  • env (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'dataset'
URN_PARTS: ClassVar[int] = 3
classmethod create_from_ids(platform_id, table_name, env, platform_instance=None)
Parameters:

  • platform_id (str)

  • table_name (str)

  • env (str)

  • platform_instance (Optional[str])

Return type:

DatasetUrn

classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
property env: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (DatasetKeyClass)

Return type:

DatasetUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

get_data_platform_urn()
Return type:

DataPlatformUrn

get_dataset_name()

Deprecated since version 0.12.0.2: Use .name instead

Return type:

str

get_env()

Deprecated since version 0.12.0.2: Use .env instead

Return type:

str

static get_simple_field_path_from_v2_field_path()

A helper function to extract simple . path notation from the v2 field path

Deprecated since version 0.12.0.2: Use the function from the field_paths module instead

Parameters:

field_path (str)

Return type:

str

property name: str
property platform: str
to_key_aspect()
Return type:

DatasetKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.DomainUrn(id, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • id (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'domain'
URN_PARTS: ClassVar[int] = 1
classmethod create_from_id(id)

Deprecated since version 0.12.0.2: Use the constructor instead

Parameters:

id (str)

Return type:

DomainUrn

classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (DomainKeyClass)

Return type:

DomainUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property id: str
to_key_aspect()
Return type:

DomainKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.GlossaryNodeUrn(name, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • name (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'glossaryNode'
URN_PARTS: ClassVar[int] = 1
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (GlossaryNodeKeyClass)

Return type:

GlossaryNodeUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property name: str
to_key_aspect()
Return type:

GlossaryNodeKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.GlossaryTermUrn(name, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • name (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'glossaryTerm'
URN_PARTS: ClassVar[int] = 1
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (GlossaryTermKeyClass)

Return type:

GlossaryTermUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property name: str
to_key_aspect()
Return type:

GlossaryTermKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.MlFeatureTableUrn(platform, name, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • platform (str)

  • name (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'mlFeatureTable'
URN_PARTS: ClassVar[int] = 2
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (MLFeatureTableKeyClass)

Return type:

MlFeatureTableUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property name: str
property platform: str
to_key_aspect()
Return type:

MLFeatureTableKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.MlFeatureUrn(feature_namespace, name, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • feature_namespace (str)

  • name (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'mlFeature'
URN_PARTS: ClassVar[int] = 2
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
property feature_namespace: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (MLFeatureKeyClass)

Return type:

MlFeatureUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property name: str
to_key_aspect()
Return type:

MLFeatureKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.MlModelDeploymentUrn(platform, name, env='PROD', *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • platform (str)

  • name (str)

  • env (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'mlModelDeployment'
URN_PARTS: ClassVar[int] = 3
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
property env: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (MLModelDeploymentKeyClass)

Return type:

MlModelDeploymentUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property name: str
property platform: str
to_key_aspect()
Return type:

MLModelDeploymentKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.MlModelGroupUrn(platform, name, env='PROD', *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • platform (str)

  • name (str)

  • env (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'mlModelGroup'
URN_PARTS: ClassVar[int] = 3
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
property env: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (MLModelGroupKeyClass)

Return type:

MlModelGroupUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property name: str
property platform: str
to_key_aspect()
Return type:

MLModelGroupKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.MlModelUrn(platform, name, env='PROD', *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • platform (str)

  • name (str)

  • env (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'mlModel'
URN_PARTS: ClassVar[int] = 3
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
property env: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (MLModelKeyClass)

Return type:

MlModelUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property name: str
property platform: str
to_key_aspect()
Return type:

MLModelKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.MlPrimaryKeyUrn(feature_namespace, name, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • feature_namespace (str)

  • name (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'mlPrimaryKey'
URN_PARTS: ClassVar[int] = 2
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
property feature_namespace: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (MLPrimaryKeyKeyClass)

Return type:

MlPrimaryKeyUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property name: str
to_key_aspect()
Return type:

MLPrimaryKeyKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.NotebookUrn(notebook_tool, notebook_id, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • notebook_tool (str)

  • notebook_id (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'notebook'
URN_PARTS: ClassVar[int] = 2
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (NotebookKeyClass)

Return type:

NotebookUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

get_notebook_id()

Deprecated since version 0.12.0.2: Use .notebook_id instead

Return type:

str

get_platform_id()

Deprecated since version 0.12.0.2: Use .notebook_tool instead

Return type:

str

property notebook_id: str
property notebook_tool: str
to_key_aspect()
Return type:

NotebookKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.OwnershipTypeUrn(id, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • id (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'ownershipType'
URN_PARTS: ClassVar[int] = 1
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (OwnershipTypeKeyClass)

Return type:

OwnershipTypeUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property id: str
to_key_aspect()
Return type:

OwnershipTypeKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.PostUrn(id, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • id (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'post'
URN_PARTS: ClassVar[int] = 1
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (PostKeyClass)

Return type:

PostUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property id: str
to_key_aspect()
Return type:

PostKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.QueryUrn(id, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • id (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'query'
URN_PARTS: ClassVar[int] = 1
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (QueryKeyClass)

Return type:

QueryUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property id: str
to_key_aspect()
Return type:

QueryKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.RoleUrn(id, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • id (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'role'
URN_PARTS: ClassVar[int] = 1
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (RoleKeyClass)

Return type:

RoleUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property id: str
to_key_aspect()
Return type:

RoleKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.SchemaFieldUrn(parent, field_path, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • parent (str)

  • field_path (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'schemaField'
URN_PARTS: ClassVar[int] = 2
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
property field_path: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (SchemaFieldKeyClass)

Return type:

SchemaFieldUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property parent: str
to_key_aspect()
Return type:

SchemaFieldKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.TagUrn(name, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • name (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'tag'
URN_PARTS: ClassVar[int] = 1
classmethod create_from_id(id)

Deprecated since version 0.12.0.2: Use the constructor instead

Parameters:

id (str)

Return type:

TagUrn

classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (TagKeyClass)

Return type:

TagUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property name: str
to_key_aspect()
Return type:

TagKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.TestUrn(id, *, _allow_coercion=True)

Bases: _SpecificUrn

Parameters:

  • id (str)

  • _allow_coercion (bool)

ENTITY_TYPE: ClassVar[str] = 'test'
URN_PARTS: ClassVar[int] = 1
classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
classmethod from_key_aspect(key_aspect)
Parameters:

key_aspect (TestKeyClass)

Return type:

TestUrn

classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

property id: str
to_key_aspect()
Return type:

TestKeyClass

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str

class datahub.metadata.urns.Urn(entity_type, entity_id)

Bases: object

URNs are globally unique identifiers used to refer to entities.

It will be in format of urn:li:<type>:<id> or urn:li:<type>:(<id1>,<id2>,…)

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.

Parameters:

  • entity_type (str)

  • entity_id (List[str])

classmethod create_from_string(urn_str)
Parameters:

urn_str (str)

Return type:

TypeVar(_UrnSelf, bound= Urn)

property entity_ids: List[str]
property entity_type: str
classmethod from_string(urn_str)

Creates an Urn from its string representation.

Parameters:

urn_str (str) – The string representation of the Urn.

Return type:

TypeVar(_UrnSelf, bound= Urn)

Returns:

Urn of the given string representation.

Raises:

InvalidUrnError – If the string representation is in invalid format.

urn()

Get the string representation of the urn.

Return type:

str

urn_url_encoded()
Return type:

str