from tamr_unify_client.base_collection import BaseCollection
from tamr_unify_client.project.attribute_configuration.resource import (
AttributeConfiguration,
)
[docs]class AttributeConfigurationCollection(BaseCollection):
"""Collection of :class:`~tamr_unify_client.project.attribute_configuration.resource.AttributeConfiguration`
:param client: Client for API call delegation.
:type client: :class:`~tamr_unify_client.Client`
:param api_path: API path used to access this collection.
E.g. ``"projects/1/attributeConfigurations"``
:type api_path: str
"""
[docs] def by_resource_id(self, resource_id):
"""Retrieve an attribute configuration by resource ID.
:param resource_id: The resource ID.
:type resource_id: str
:returns: The specified attribute configuration.
:rtype: :class:`~tamr_unify_client.project.attribute_configuration.resource.AttributeConfiguration`
"""
return super().by_resource_id(self.api_path, resource_id)
[docs] def by_relative_id(self, relative_id):
"""Retrieve an attribute configuration by relative ID.
:param relative_id: The relative ID.
:type relative_id: str
:returns: The specified attribute configuration.
:rtype: :class:`~tamr_unify_client.project.attribute_configuration.resource.AttributeConfiguration`
"""
return super().by_relative_id(AttributeConfiguration, relative_id)
[docs] def by_external_id(self, external_id):
"""Retrieve an attribute configuration by external ID.
Since attributes do not have external IDs, this method is not supported and will
raise a :class:`NotImplementedError` .
:param external_id: The external ID.
:type external_id: str
:returns: The specified attribute, if found.
:rtype: :class:`~tamr_unify_client.project.attribute_configuration.resource.AttributeConfiguration`
:raises KeyError: If no attribute with the specified external_id is found
:raises LookupError: If multiple attributes with the specified external_id are found
:raises NotImplementedError: AttributeConfiguration does not support external_id
"""
raise NotImplementedError("AttributeConfiguration does not support external_id")
[docs] def stream(self):
"""Stream attribute configurations in this collection. Implicitly called when iterating
over this collection.
:returns: Stream of attribute configurations.
:rtype: Python generator yielding :class:`~tamr_unify_client.project.attribute_configuration.resource.AttributeConfiguration`
Usage:
>>> for attributeConfiguration in collection.stream(): # explicit
>>> do_stuff(attributeConfiguration)
>>> for attributeConfiguration in collection: # implicit
>>> do_stuff(attributeConfiguration)
"""
return super().stream(AttributeConfiguration)
[docs] def create(self, creation_spec):
"""Create an Attribute configuration in this collection
:param creation_spec: Attribute configuration creation specification should be formatted as specified in the
`Public Docs for adding an AttributeConfiguration <https://docs.tamr.com/reference#create-attribute-configurations>`_.
:type creation_spec: dict[str, str]
:returns: The created Attribute configuration
:rtype: :class:`~tamr_unify_client.project.attribute_configuration.resource.AttributeConfiguration`
"""
data = self.client.post(self.api_path, json=creation_spec).successful().json()
return AttributeConfiguration.from_json(self.client, data)