Package org.odpi.openmetadata.accessservices.assetlineage

Interface AssetLineageInterface

All Known Implementing Classes:
AssetLineage
public interface AssetLineageInterface
The Asset Lineage OMAS provides services to query the lineage of business terms and data assets.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    publishAssetContext(String userId, String guid, String entityType)
    Publishes the asset context of an entity - used for data files and relational tables.
    List<String>
    publishEntities(String serverName, String userId, String entityType, Optional<Date> updatedAfterDate)
    Scan the cohort based on the given entity type and publish the contexts for the found entities to the out topic Returns a list that contains entities GUID that were published out.

  • Method Details

    • publishEntities

      List<String> publishEntities(String serverName, String userId, String entityType, Optional<Date> updatedAfterDate) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Scan the cohort based on the given entity type and publish the contexts for the found entities to the out topic Returns a list that contains entities GUID that were published out.
      Parameters:
      serverName - the server name
      userId - the user id
      entityType - the entity type
      updatedAfterDate - take into account just the entities updated after the specified date, if any (otherwise it loads everything)
      Returns:
      the list of entities GUIDs that were published out
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • publishAssetContext

      List<String> publishAssetContext(String userId, String guid, String entityType) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Publishes the asset context of an entity - used for data files and relational tables.
      Parameters:
      userId - the caller user Id
      guid - the guid of the entity
      entityType - the entity type
      Returns:
      list of the entities' guids in the asset context
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the invalid parameter exception
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the property server exception
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user not authorized exception