org.odpi.openmetadata.accessservices.assetmanager.api

Interface DataAssetExchangeInterface

All Superinterfaces:

SchemaExchangeInterface

public interface DataAssetExchangeInterface
extends SchemaExchangeInterface

DataAssetExchangeInterface provides methods to define data assets, their schemas and connections, along with supporting objects, and lineage. The interface supports the following types of objects

• Assets -
• • Data Stores
  • Data Sets
  • APIs
• ConnectorTypes - the types of open connectors that can be used to access the asset.
• Connections - the connections used to create connector instances that can access the asset.
• Endpoints - the network information needed to access the asset.
• Schema - description of structure of data
• • Schema Types
  • Schema Attributes

Method Summary

Modifier and Type	Method and Description
void	clearDataAssetAsReferenceData(String userId, String assetManagerGUID, String assetManagerName, String assetGUID, String assetExternalIdentifier) Remove the reference data designation from the asset.
String	createDataAsset(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String assetExternalIdentifier, String assetExternalIdentifierName, String assetExternalIdentifierUsage, String assetExternalIdentifierSource, KeyPattern assetExternalIdentifierKeyPattern, Map<String,String> mappingProperties, DataAssetProperties assetProperties) Create a new metadata element to represent the root of an asset.
String	createDataAssetFromTemplate(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String templateGUID, String assetExternalIdentifier, String assetExternalIdentifierName, String assetExternalIdentifierUsage, String assetExternalIdentifierSource, KeyPattern assetExternalIdentifierKeyPattern, Map<String,String> mappingProperties, TemplateProperties templateProperties) Create a new metadata element to represent an asset using an existing metadata element as a template.
List<DataAssetElement>	findDataAssets(String userId, String assetManagerGUID, String assetManagerName, String searchString, int startFrom, int pageSize) Retrieve the list of asset metadata elements that contain the search string.
DataAssetElement	getDataAssetByGUID(String userId, String assetManagerGUID, String assetManagerName, String openMetadataGUID) Retrieve the asset metadata element with the supplied unique identifier.
List<DataAssetElement>	getDataAssetsByName(String userId, String assetManagerGUID, String assetManagerName, String name, int startFrom, int pageSize) Retrieve the list of asset metadata elements with a matching qualified or display name.
List<DataAssetElement>	getDataAssetsForAssetManager(String userId, String assetManagerGUID, String assetManagerName, int startFrom, int pageSize) Retrieve the list of assets created on behalf of the named asset manager.
void	publishDataAsset(String userId, String assetManagerGUID, String assetManagerName, String assetGUID) Update the zones for the asset so that it becomes visible to consumers.
void	removeDataAsset(String userId, String assetManagerGUID, String assetManagerName, String assetGUID, String assetExternalIdentifier) Remove the metadata element representing an asset.
List<DataAssetElement>	scanDataAssets(String userId, String assetManagerGUID, String assetManagerName, int startFrom, int pageSize) Step through the assets visible to this caller.
void	setDataAssetAsReferenceData(String userId, String assetManagerGUID, String assetManagerName, String assetGUID, String assetExternalIdentifier) Classify the asset to indicate that it can be used as reference data.
void	updateDataAsset(String userId, String assetManagerGUID, String assetManagerName, String assetGUID, String assetExternalIdentifier, boolean isMergeUpdate, DataAssetProperties assetProperties) Update the metadata element representing an asset.
void	withdrawDataAsset(String userId, String assetManagerGUID, String assetManagerName, String assetGUID) Update the zones for the asset so that it is no longer visible to consumers.

Methods inherited from interface org.odpi.openmetadata.accessservices.assetmanager.api.SchemaExchangeInterface

clearColumnAsPrimaryKey, clearForeignKeyRelationship, clearSchemaElementAsCalculatedValue, clearSchemaTypeParent, createSchemaAttribute, createSchemaAttributeFromTemplate, createSchemaType, createSchemaTypeFromTemplate, findSchemaAttributes, findSchemaType, getAttributesForSchemaType, getSchemaAttributeByGUID, getSchemaAttributesByName, getSchemaTypeByGUID, getSchemaTypeByName, getSchemaTypeForElement, getSchemaTypeParent, removeSchemaAttribute, removeSchemaType, setSchemaElementAsCalculatedValue, setupColumnAsPrimaryKey, setupForeignKeyRelationship, setupSchemaTypeParent, updateForeignKeyRelationship, updateSchemaAttribute, updateSchemaType

Method Detail

createDataAsset

String createDataAsset(String userId,
                       String assetManagerGUID,
                       String assetManagerName,
                       boolean assetManagerIsHome,
                       String assetExternalIdentifier,
                       String assetExternalIdentifierName,
                       String assetExternalIdentifierUsage,
                       String assetExternalIdentifierSource,
                       KeyPattern assetExternalIdentifierKeyPattern,
                       Map<String,String> mappingProperties,
                       DataAssetProperties assetProperties)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException

Create a new metadata element to represent the root of an asset.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetManagerIsHome - ensure that only the asset manager can update this asset

assetExternalIdentifier - unique identifier of the asset in the external asset manager

assetExternalIdentifierName - name of property for the external identifier in the external asset manager

assetExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager

assetExternalIdentifierSource - component that issuing this request.

assetExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY)

mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata

assetProperties - properties to store

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createDataAssetFromTemplate

String createDataAssetFromTemplate(String userId,
                                   String assetManagerGUID,
                                   String assetManagerName,
                                   boolean assetManagerIsHome,
                                   String templateGUID,
                                   String assetExternalIdentifier,
                                   String assetExternalIdentifierName,
                                   String assetExternalIdentifierUsage,
                                   String assetExternalIdentifierSource,
                                   KeyPattern assetExternalIdentifierKeyPattern,
                                   Map<String,String> mappingProperties,
                                   TemplateProperties templateProperties)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Create a new metadata element to represent an asset using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new asset.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetManagerIsHome - ensure that only the asset manager can update this asset

assetExternalIdentifier - unique identifier of the asset in the external asset manager

assetExternalIdentifierName - name of property for the external identifier in the external asset manager

assetExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager

assetExternalIdentifierSource - component that issuing this request.

assetExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY)

mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateDataAsset

void updateDataAsset(String userId,
                     String assetManagerGUID,
                     String assetManagerName,
                     String assetGUID,
                     String assetExternalIdentifier,
                     boolean isMergeUpdate,
                     DataAssetProperties assetProperties)
              throws InvalidParameterException,
                     UserNotAuthorizedException,
                     PropertyServerException

Update the metadata element representing an asset.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetGUID - unique identifier of the metadata element to update

assetExternalIdentifier - unique identifier of the asset in the external asset manager

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

assetProperties - new properties for this element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

publishDataAsset

void publishDataAsset(String userId,
                      String assetManagerGUID,
                      String assetManagerName,
                      String assetGUID)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException

Update the zones for the asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Asset Manager OMAS).

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetGUID - unique identifier of the metadata element to publish

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

withdrawDataAsset

void withdrawDataAsset(String userId,
                       String assetManagerGUID,
                       String assetManagerName,
                       String assetGUID)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException

Update the zones for the asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Asset Manager OMAS. This is the setting when the database is first created).

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetGUID - unique identifier of the metadata element to withdraw

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeDataAsset

void removeDataAsset(String userId,
                     String assetManagerGUID,
                     String assetManagerName,
                     String assetGUID,
                     String assetExternalIdentifier)
              throws InvalidParameterException,
                     UserNotAuthorizedException,
                     PropertyServerException

Remove the metadata element representing an asset. This will delete the asset and all anchored elements such as schema and comments.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetGUID - unique identifier of the metadata element to remove

assetExternalIdentifier - unique identifier of the asset in the external asset manager

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setDataAssetAsReferenceData

void setDataAssetAsReferenceData(String userId,
                                 String assetManagerGUID,
                                 String assetManagerName,
                                 String assetGUID,
                                 String assetExternalIdentifier)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Classify the asset to indicate that it can be used as reference data.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetGUID - unique identifier of the metadata element to update

assetExternalIdentifier - unique identifier of the asset in the external asset manager

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearDataAssetAsReferenceData

void clearDataAssetAsReferenceData(String userId,
                                   String assetManagerGUID,
                                   String assetManagerName,
                                   String assetGUID,
                                   String assetExternalIdentifier)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Remove the reference data designation from the asset.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetGUID - unique identifier of the metadata element to update

assetExternalIdentifier - unique identifier of the asset in the external asset manager

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findDataAssets

List<DataAssetElement> findDataAssets(String userId,
                                      String assetManagerGUID,
                                      String assetManagerName,
                                      String searchString,
                                      int startFrom,
                                      int pageSize)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Retrieve the list of asset metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

scanDataAssets

List<DataAssetElement> scanDataAssets(String userId,
                                      String assetManagerGUID,
                                      String assetManagerName,
                                      int startFrom,
                                      int pageSize)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Step through the assets visible to this caller.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDataAssetsByName

List<DataAssetElement> getDataAssetsByName(String userId,
                                           String assetManagerGUID,
                                           String assetManagerName,
                                           String name,
                                           int startFrom,
                                           int pageSize)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Retrieve the list of asset metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDataAssetsForAssetManager

List<DataAssetElement> getDataAssetsForAssetManager(String userId,
                                                    String assetManagerGUID,
                                                    String assetManagerName,
                                                    int startFrom,
                                                    int pageSize)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException

Retrieve the list of assets created on behalf of the named asset manager.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDataAssetByGUID

DataAssetElement getDataAssetByGUID(String userId,
                                    String assetManagerGUID,
                                    String assetManagerName,
                                    String openMetadataGUID)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Retrieve the asset metadata element with the supplied unique identifier.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

openMetadataGUID - unique identifier of the requested metadata element

Returns:

matching metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)