Interface AssetCatalogInterface
- All Known Implementing Classes:
AssetCatalog
public interface AssetCatalogInterface
The Asset Catalog Open Metadata Access Service (OMAS) provides services to search for data assets including
data stores, event feeds, APIs and data sets. The search will locate assets based on the content of the Asset
metadata itself and the metadata that links to it. This includes:
- Glossary terms
- Schema elements
- Classifications
-
Method Summary
Modifier and TypeMethodDescriptiongetAssetContext
(String userId, String assetGUID, String assetType) Return the full context of an asset/glossary term based on its identifier.getAssetDetails
(String userId, String assetGUID, String assetType) Fetch asset's header, classification and propertiesgetAssetRelationships
(String userId, String assetGUID, String assetType, String relationshipType, Integer from, Integer pageSize) Fetch the relationships for a specific assetgetAssetUniverse
(String userId, String assetGUID, String assetType) Fetch asset's header, classification, properties and relationshipsgetClassificationsForAsset
(String userId, String assetGUID, String assetType, String classificationName) Fetch the classification for a specific assetgetRelationshipBetweenEntities
(String userId, String entity1GUID, String entity2GUID, String relationshipType) Fetch relationship between entities details based on its unique identifier of the ends Filtering based on the relationship type is supportedgetSupportedTypes
(String userId, String type) Returns the list with supported types for search, including the sub-types supportedsearchByType
(String userId, String searchCriteria, SearchParameters searchParameters) Return a list of assets matching the search criteria without the full contextsearchByTypeGUID
(String userId, String typeGUID) Return a list of assets matching the type GUID without the full context The list includes also subtypessearchByTypeName
(String userId, String typeName) Return a list of assets matching the type name without the full context The list includes also subtypes
-
Method Details
-
getAssetDetails
AssetCatalogResponse getAssetDetails(String userId, String assetGUID, String assetType) throws InvalidParameterException, PropertyServerException Fetch asset's header, classification and properties- Parameters:
userId
- the unique identifier for the userassetGUID
- the unique identifier for the assetassetType
- the type of the asset- Returns:
- the asset with its header and the list of associated classifications and specific properties
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation fails
-
getAssetUniverse
AssetCatalogResponse getAssetUniverse(String userId, String assetGUID, String assetType) throws InvalidParameterException, PropertyServerException Fetch asset's header, classification, properties and relationships- Parameters:
userId
- the unique identifier for the userassetGUID
- the unique identifier for the assetassetType
- the asset type- Returns:
- the asset with its header and the list of associated classifications and relationship
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation fails
-
getAssetRelationships
RelationshipListResponse getAssetRelationships(String userId, String assetGUID, String assetType, String relationshipType, Integer from, Integer pageSize) throws InvalidParameterException, PropertyServerException Fetch the relationships for a specific asset- Parameters:
userId
- the unique identifier for the userassetGUID
- the unique identifier for the assetassetType
- the type of the assetrelationshipType
- the type of the relationshipfrom
- offsetpageSize
- limit the number of the assets returned- Returns:
- list of relationships for the given asset
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation fails
-
getClassificationsForAsset
ClassificationListResponse getClassificationsForAsset(String userId, String assetGUID, String assetType, String classificationName) throws InvalidParameterException, PropertyServerException Fetch the classification for a specific asset- Parameters:
userId
- the unique identifier for the userassetGUID
- the unique identifier for the assetassetType
- the type of the assetclassificationName
- the name of the classification- Returns:
- ClassificationsResponse the classification for the asset
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation fails
-
searchByType
AssetListResponse searchByType(String userId, String searchCriteria, SearchParameters searchParameters) throws InvalidParameterException, PropertyServerException Return a list of assets matching the search criteria without the full context- Parameters:
userId
- the unique identifier for the usersearchCriteria
- a string expression of the characteristics of the required assetssearchParameters
- constrains to make the assets's search results more precise- Returns:
- list of properties used to narrow the search
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation fails
-
searchByTypeName
AssetListResponse searchByTypeName(String userId, String typeName) throws InvalidParameterException, PropertyServerException Return a list of assets matching the type name without the full context The list includes also subtypes- Parameters:
userId
- the unique identifier for the usertypeName
- the assets type name to search for- Returns:
- list of assets by type name or GUID
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation fails
-
searchByTypeGUID
AssetListResponse searchByTypeGUID(String userId, String typeGUID) throws InvalidParameterException, PropertyServerException Return a list of assets matching the type GUID without the full context The list includes also subtypes- Parameters:
userId
- the unique identifier for the usertypeGUID
- the assets type GUID to search for- Returns:
- list of assets by type name or GUID
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation fails
-
getAssetContext
AssetResponse getAssetContext(String userId, String assetGUID, String assetType) throws InvalidParameterException, PropertyServerException Return the full context of an asset/glossary term based on its identifier. The response contains the list of the connections assigned to the asset.- Parameters:
userId
- the unique identifier for the userassetGUID
- the global unique identifier of the assetassetType
- the type of the asset- Returns:
- list of properties used to narrow the search
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation fails
-
getRelationshipBetweenEntities
RelationshipResponse getRelationshipBetweenEntities(String userId, String entity1GUID, String entity2GUID, String relationshipType) throws InvalidParameterException, PropertyServerException Fetch relationship between entities details based on its unique identifier of the ends Filtering based on the relationship type is supported- Parameters:
userId
- the unique identifier for the userentity1GUID
- Entity guid of the first end of the relationshipentity2GUID
- Entity guid of the second end of the relationshiprelationshipType
- Type of the relationship- Returns:
- relationships between entities
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation fails
-
getSupportedTypes
AssetCatalogSupportedTypes getSupportedTypes(String userId, String type) throws InvalidParameterException, PropertyServerException Returns the list with supported types for search, including the sub-types supported- Parameters:
userId
- the unique identifier for the usertype
- the type- Returns:
- list of types and sub-types supported for search
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation fails
-