org.odpi.openmetadata.accessservice.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 and Description
AssetDescriptionResponse	getAssetDetails(String userId, String assetId) Fetch asset's header, classification and properties
RelationshipsResponse	getAssetRelationships(String userId, String assetId) Fetch the relationships for a specific asset
AssetDescriptionResponse	getAssetsByClassificationName(String userId, String classificationName) Fetch the assets that match the classification name
AssetDescriptionResponse	getAssetsByProperty(String userId, String propertyValue) Fetch the assets that match the properties
AssetDescriptionResponse	getAssetsFromNeighborhood(String userId, String assetId) Returns the sub-graph that represents the returned linked relationships.
AssetDescriptionResponse	getAssetSummary(String userId, String assetId) Fetch asset's header and classification
AssetDescriptionResponse	getAssetUniverse(String userId, String assetId) Fetch asset's header, classification, properties and relationships
ClassificationsResponse	getClassificationForAsset(String userId, String assetId) Fetch the classification for a specific asset
AssetDescriptionResponse	getLastCreatedAssets(String userId) Returns the last created assets
AssetDescriptionResponse	getLastUpdatedAssets(String userId) Returns the last updated assets
AssetDescriptionResponse	getLinkingAssets(String userId, String startAssetId, String endAssetId) Returns a sub-graph of intermediate assets that connected two assets
RelationshipsResponse	getLinkingRelationships(String userId, String startAssetId, String endAssetId) Return a sub-graph of relationships that connect two assets
AssetDescriptionResponse	getRelatedAssets(String userId, String assetId) Return the list of assets that are of the types listed in instanceTypes and are connected, either directly or indirectly to the asset identified by assetId.
RelationshipsResponse	getRelationship(String userId, String relationshipId) Fetch relationship details based on its unique identifier
RelationshipsResponse	getRelationshipByLabel(String userId, String propertyName) Fetch relationship details based on property name
RelationshipsResponse	getRelationshipsFromNeighborhood(String userId, String assetId) Returns the sub-graph that represents the returned linked assets
AssetDescriptionResponse	searchAssets(String userId, String searchCriteria) Return a list of assets (details and connections) matching the search criteria
RelationshipsResponse	searchForRelationships(String userId, String relationshipTypeId, String criteria) Return a list of relationships that match the search criteria.

Method Detail

getAssetSummary

AssetDescriptionResponse getAssetSummary(String userId,
                                         String assetId)
                                  throws PropertyServerException,
                                         InvalidParameterException

Fetch asset's header and classification

Parameters:

userId - the unique identifier for the user

assetId - the unique identifier for the asset

Returns:

the asset with its header and the list of associated classifications

Throws:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - one of the parameters is null or invalid

getAssetDetails

AssetDescriptionResponse getAssetDetails(String userId,
                                         String assetId)
                                  throws PropertyServerException,
                                         InvalidParameterException

Fetch asset's header, classification and properties

Parameters:

userId - the unique identifier for the user

assetId - the unique identifier for the asset

Returns:

the asset with its header and the list of associated classifications and specific properties

Throws:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - one of the parameters is null or invalid

getAssetUniverse

AssetDescriptionResponse getAssetUniverse(String userId,
                                          String assetId)
                                   throws PropertyServerException,
                                          InvalidParameterException

Fetch asset's header, classification, properties and relationships

Parameters:

userId - the unique identifier for the user

assetId - the unique identifier for the asset

Returns:

the asset with its header and the list of associated classifications

Throws:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - one of the parameters is null or invalid

getAssetRelationships

RelationshipsResponse getAssetRelationships(String userId,
                                            String assetId)
                                     throws PropertyServerException,
                                            InvalidParameterException

Fetch the relationships for a specific asset

Parameters:

userId - the unique identifier for the user

assetId - the unique identifier for the asset

Returns:

list of relationships for the given asset

Throws:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - one of the parameters is null or invalid

getClassificationForAsset

ClassificationsResponse getClassificationForAsset(String userId,
                                                  String assetId)
                                           throws PropertyServerException,
                                                  InvalidParameterException

Fetch the classification for a specific asset

Parameters:

userId - the unique identifier for the user

assetId - the unique identifier for the asset

Returns:

the classification for the asset

Throws:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - one of the parameters is null or invalid

getAssetsByProperty

AssetDescriptionResponse getAssetsByProperty(String userId,
                                             String propertyValue)
                                      throws PropertyServerException,
                                             InvalidParameterException

Fetch the assets that match the properties

Parameters:

userId - the unique identifier for the user

propertyValue - the property value searched

Returns:

a list of assets that match the properties

Throws:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - one of the parameters is null or invalid

getAssetsByClassificationName

AssetDescriptionResponse getAssetsByClassificationName(String userId,
                                                       String classificationName)
                                                throws PropertyServerException,
                                                       InvalidParameterException

Fetch the assets that match the classification name

Parameters:

userId - the unique identifier for the user

classificationName - the name of the classification

Returns:

a list of assets that match the classification name

Throws:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - one of the parameters is null or invalid

getLinkingRelationships

RelationshipsResponse getLinkingRelationships(String userId,
                                              String startAssetId,
                                              String endAssetId)
                                       throws PropertyServerException,
                                              InvalidParameterException

Return a sub-graph of relationships that connect two assets

Parameters:

userId - the unique identifier for the user

startAssetId - the starting asset identifier of the query

endAssetId - the ending asset identifier of the query

Returns:

a list of relationships that connects the assets

Throws:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - one of the parameters is null or invalid

getLinkingAssets

AssetDescriptionResponse getLinkingAssets(String userId,
                                          String startAssetId,
                                          String endAssetId)
                                   throws PropertyServerException,
                                          InvalidParameterException

Returns a sub-graph of intermediate assets that connected two assets

Parameters:

userId - the unique identifier for the user

startAssetId - the starting asset identifier of the query

endAssetId - the ending asset identifier of the query

Returns:

a list of assets between the given assets

Throws:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - one of the parameters is null or invalid

getRelatedAssets

AssetDescriptionResponse getRelatedAssets(String userId,
                                          String assetId)
                                   throws PropertyServerException,
                                          InvalidParameterException

Return the list of assets that are of the types listed in instanceTypes and are connected, either directly or indirectly to the asset identified by assetId.

Parameters:

userId - the unique identifier for the user

assetId - the starting asset identifier of the query

Returns:

list of assets either directly or indirectly connected to the start asset

Throws:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - one of the parameters is null or invalid

getAssetsFromNeighborhood

AssetDescriptionResponse getAssetsFromNeighborhood(String userId,
                                                   String assetId)
                                            throws PropertyServerException,
                                                   InvalidParameterException

Returns the sub-graph that represents the returned linked relationships.

Parameters:

userId - the unique identifier for the user

assetId - the starting asset identifier of the query

Returns:

a list of assets that in neighborhood of the given asset

Throws:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - one of the parameters is null or invalid

getRelationshipsFromNeighborhood

RelationshipsResponse getRelationshipsFromNeighborhood(String userId,
                                                       String assetId)
                                                throws PropertyServerException,
                                                       InvalidParameterException

Returns the sub-graph that represents the returned linked assets

Parameters:

userId - the unique identifier for the user

assetId - the starting asset identifier of the query

Returns:

a list of relationships that are linked between the assets

Throws:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - one of the parameters is null or invalid

getLastCreatedAssets

AssetDescriptionResponse getLastCreatedAssets(String userId)
                                       throws InvalidParameterException,
                                              PropertyServerException

Returns the last created assets

Parameters:

userId - the unique identifier for the user

Returns:

a list of the last created assets

Throws:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - one of the parameters is null or invalid

getLastUpdatedAssets

AssetDescriptionResponse getLastUpdatedAssets(String userId)
                                       throws PropertyServerException,
                                              InvalidParameterException

Returns the last updated assets

Parameters:

userId - the unique identifier for the user

Returns:

a list of the last updated assets

Throws:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - one of the parameters is null or invalid

getRelationship

RelationshipsResponse getRelationship(String userId,
                                      String relationshipId)
                               throws InvalidParameterException,
                                      PropertyServerException

Fetch relationship details based on its unique identifier

Parameters:

userId - String unique identifier for the user

relationshipId - String unique identifier for the relationship

Returns:

relationship details

Throws:

InvalidParameterException

PropertyServerException

getRelationshipByLabel

RelationshipsResponse getRelationshipByLabel(String userId,
                                             String propertyName)
                                      throws InvalidParameterException,
                                             PropertyServerException

Fetch relationship details based on property name

Parameters:

userId - String unique identifier for the user

propertyName - String that it is used to identify the relationship label

Returns:

a list of relationships that have the property specified

Throws:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - one of the parameters is null or invalid

searchForRelationships

RelationshipsResponse searchForRelationships(String userId,
                                             String relationshipTypeId,
                                             String criteria)
                                      throws PropertyServerException,
                                             InvalidParameterException

Return a list of relationships that match the search criteria.

Parameters:

userId - String unique identifier for the user

relationshipTypeId - limit the result set to only include the specified types for relationships

criteria - String for searching the relationship

Returns:

a list of relationships that match the search criteria

Throws:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - one of the parameters is null or invalid

searchAssets

AssetDescriptionResponse searchAssets(String userId,
                                      String searchCriteria)
                               throws PropertyServerException,
                                      InvalidParameterException

Return a list of assets (details and connections) matching the search criteria

Parameters:

userId - the unique identifier for the user

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

Returns:

list of properties used to narrow the search

Throws:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - one of the parameters is null or invalid