Package org.odpi.openmetadata.accessservices.assetcatalog

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 Type	Method	Description
AssetResponse	getAssetContext(String userId, String assetGUID, String assetType)	Return the full context of an asset/glossary term based on its identifier.
AssetCatalogResponse	getAssetDetails(String userId, String assetGUID, String assetType)	Fetch asset's header, classification and properties
RelationshipListResponse	getAssetRelationships(String userId, String assetGUID, String assetType, String relationshipType, Integer from, Integer pageSize)	Fetch the relationships for a specific asset
AssetCatalogResponse	getAssetUniverse(String userId, String assetGUID, String assetType)	Fetch asset's header, classification, properties and relationships
ClassificationListResponse	getClassificationsForAsset(String userId, String assetGUID, String assetType, String classificationName)	Fetch the classification for a specific asset
RelationshipResponse	getRelationshipBetweenEntities(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 supported
AssetCatalogSupportedTypes	getSupportedTypes(String userId, String type)	Returns the list with supported types for search, including the sub-types supported
AssetListResponse	searchByType(String userId, String searchCriteria, SearchParameters searchParameters)	Return a list of assets matching the search criteria without the full context
AssetListResponse	searchByTypeGUID(String userId, String typeGUID)	Return a list of assets matching the type GUID without the full context The list includes also subtypes
AssetListResponse	searchByTypeName(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 user

assetGUID - the unique identifier for the asset

assetType - 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 request

InvalidParameterException - 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 user

assetGUID - the unique identifier for the asset

assetType - 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 request

InvalidParameterException - 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 user

assetGUID - the unique identifier for the asset

assetType - the type of the asset

relationshipType - the type of the relationship

from - offset

pageSize - limit the number of the assets returned

Returns:

list of relationships for the given asset

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - 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 user

assetGUID - the unique identifier for the asset

assetType - the type of the asset

classificationName - the name of the classification

Returns:

ClassificationsResponse the classification for the asset

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - 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 user

searchCriteria - a string expression of the characteristics of the required assets

searchParameters - 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 request

InvalidParameterException - 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 user

typeName - 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 request

InvalidParameterException - 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 user

typeGUID - 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 request

InvalidParameterException - 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 user

assetGUID - the global unique identifier of the asset

assetType - the type of the asset

Returns:

list of properties used to narrow the search

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - 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 user

entity1GUID - Entity guid of the first end of the relationship

entity2GUID - Entity guid of the second end of the relationship

relationshipType - Type of the relationship

Returns:

relationships between entities

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - 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 user

type - the type

Returns:

list of types and sub-types supported for search

Throws:

InvalidParameterException - if parameter validation fails

PropertyServerException - if a problem occurs while serving the request