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 TypeMethodDescriptionorg.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetResponse
getAssetContext
(String userId, String assetGUID, String assetType) Return the full context of an asset/glossary term based on its identifier.org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetCatalogResponse
getAssetDetails
(String userId, String assetGUID, String assetType) Fetch asset's header, classification and propertiesorg.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.RelationshipListResponse
getAssetRelationships
(String userId, String assetGUID, String assetType, String relationshipType, Integer from, Integer pageSize) Fetch the relationships for a specific assetorg.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetCatalogResponse
getAssetUniverse
(String userId, String assetGUID, String assetType) Fetch asset's header, classification, properties and relationshipsorg.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.ClassificationListResponse
getClassificationsForAsset
(String userId, String assetGUID, String assetType, String classificationName) Fetch the classification for a specific assetorg.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.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 supportedorg.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetCatalogSupportedTypes
getSupportedTypes
(String userId, String type) Returns the list with supported types for search, including the sub-types supportedorg.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetListResponse
searchByType
(String userId, String searchCriteria, org.odpi.openmetadata.accessservices.assetcatalog.model.rest.body.SearchParameters searchParameters) Return a list of assets matching the search criteria without the full contextorg.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetListResponse
searchByTypeGUID
(String userId, String typeGUID) Return a list of assets matching the type GUID without the full context The list includes also subtypesorg.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.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
org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetCatalogResponse getAssetDetails(String userId, String assetGUID, String assetType) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
- if a problem occurs while serving the requestorg.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
- if parameter validation fails
-
getAssetUniverse
org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetCatalogResponse getAssetUniverse(String userId, String assetGUID, String assetType) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
- if a problem occurs while serving the requestorg.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
- if parameter validation fails
-
getAssetRelationships
org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.RelationshipListResponse getAssetRelationships(String userId, String assetGUID, String assetType, String relationshipType, Integer from, Integer pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
- if a problem occurs while serving the requestorg.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
- if parameter validation fails
-
getClassificationsForAsset
org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.ClassificationListResponse getClassificationsForAsset(String userId, String assetGUID, String assetType, String classificationName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
- if a problem occurs while serving the requestorg.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
- if parameter validation fails
-
searchByType
org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetListResponse searchByType(String userId, String searchCriteria, org.odpi.openmetadata.accessservices.assetcatalog.model.rest.body.SearchParameters searchParameters) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
- if a problem occurs while serving the requestorg.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
- if parameter validation fails
-
searchByTypeName
org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetListResponse searchByTypeName(String userId, String typeName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
- if a problem occurs while serving the requestorg.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
- if parameter validation fails
-
searchByTypeGUID
org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetListResponse searchByTypeGUID(String userId, String typeGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
- if a problem occurs while serving the requestorg.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
- if parameter validation fails
-
getAssetContext
org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetResponse getAssetContext(String userId, String assetGUID, String assetType) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
- if a problem occurs while serving the requestorg.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
- if parameter validation fails
-
getRelationshipBetweenEntities
org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.RelationshipResponse getRelationshipBetweenEntities(String userId, String entity1GUID, String entity2GUID, String relationshipType) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
- if a problem occurs while serving the requestorg.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
- if parameter validation fails
-
getSupportedTypes
org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetCatalogSupportedTypes getSupportedTypes(String userId, String type) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
- if a problem occurs while serving the requestorg.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
- if parameter validation fails
-