Project¶
-
class
tamr_client.
UnknownProject
(url, name, description=None)[source]¶ A Tamr project of an unrecognized type
-
tamr_client.project.
by_resource_id
(session, instance, id)[source]¶ Get project by resource ID. Fetches project from Tamr server.
- Parameters
instance (
Instance
) – Tamr instance containing this datasetid (
str
) – Project ID
- Raises
project.NotFound – If no project could be found at the specified URL. Corresponds to a 404 HTTP error.
requests.HTTPError – If any other HTTP error is encountered.
- Return type
Union
[CategorizationProject
,MasteringProject
,SchemaMappingProject
,GoldenRecordsProject
,UnknownProject
]
-
tamr_client.project.
by_name
(session, instance, name)[source]¶ Get project by name Fetches project from Tamr server.
- Parameters
instance (
Instance
) – Tamr instance containing this projectname (
str
) – Project name
- Raises
project.NotFound – If no project could be found with that name.
project.Ambiguous – If multiple targets match project name.
requests.HTTPError – If any other HTTP error is encountered.
- Return type
Union
[CategorizationProject
,MasteringProject
,SchemaMappingProject
,GoldenRecordsProject
,UnknownProject
]
-
tamr_client.project.
get_all
(session, instance, *, filter=None)[source]¶ Get all projects from an instance
- Parameters
- Return type
Tuple
[Union
[CategorizationProject
,MasteringProject
,SchemaMappingProject
,GoldenRecordsProject
,UnknownProject
], …]- Returns
The projects retrieved from the instance
- Raises
requests.HTTPError – If an HTTP error is encountered.
-
tamr_client.project.
attributes
(session, project)[source]¶ Get all attributes from a project
- Parameters
project (
Union
[CategorizationProject
,MasteringProject
,SchemaMappingProject
,GoldenRecordsProject
,UnknownProject
]) – Project containing the desired attributes- Return type
Tuple
[Attribute
, …]- Returns
The attributes for the specified project
- Raises
requests.HTTPError – If an HTTP error is encountered.