Interface DataAssetExchangeInterface

  • All Superinterfaces:
    SchemaExchangeInterface
    All Known Implementing Classes:
    DataAssetExchangeClient

    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
    • Schema - description of structure of data
      • Schema Types
      • Schema Attributes
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clearAssetRelationship​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String relationshipTypeName, java.lang.String relationshipGUID, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Remove the relationship between two elements.
      void clearDataAssetAsReferenceData​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String assetGUID, java.lang.String assetExternalIdentifier, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Remove the reference data designation from the asset.
      java.lang.String createDataAsset​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, boolean assetManagerIsHome, ExternalIdentifierProperties externalIdentifierProperties, DataAssetProperties assetProperties)
      Create a new metadata element to represent the root of an asset.
      java.lang.String createDataAssetFromTemplate​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, boolean assetManagerIsHome, java.lang.String templateGUID, ExternalIdentifierProperties externalIdentifierProperties, TemplateProperties templateProperties)
      Create a new metadata element to represent an asset using an existing metadata element as a template.
      java.util.List<DataAssetElement> findDataAssets​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String searchString, int startFrom, int pageSize, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Retrieve the list of asset metadata elements that contain the search string.
      RelationshipElement getAssetRelationship​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String relationshipTypeName, java.lang.String fromAssetGUID, java.lang.String toAssetGUID, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Retrieve the relationship between two elements.
      DataAssetElement getDataAssetByGUID​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String openMetadataGUID, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Retrieve the asset metadata element with the supplied unique identifier.
      java.util.List<DataAssetElement> getDataAssetsByName​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String name, int startFrom, int pageSize, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Retrieve the list of asset metadata elements with a matching qualified or display name.
      java.util.List<DataAssetElement> getDataAssetsForAssetManager​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, int startFrom, int pageSize, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Retrieve the list of assets created on behalf of the named asset manager.
      java.util.List<RelationshipElement> getRelatedAssetsAtEnd1​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String relationshipTypeName, java.lang.String toAssetGUID, int startingFrom, int pageSize, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Retrieve the relationships linked from a specific element at end 2 of the relationship.
      java.util.List<RelationshipElement> getRelatedAssetsAtEnd2​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String relationshipTypeName, java.lang.String fromAssetGUID, int startingFrom, int pageSize, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Retrieve the requested relationships linked from a specific element at end 2.
      void publishDataAsset​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String assetGUID, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Update the zones for the asset so that it becomes visible to consumers.
      void removeDataAsset​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String assetGUID, java.lang.String assetExternalIdentifier, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Remove the metadata element representing an asset.
      java.util.List<DataAssetElement> scanDataAssets​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, int startFrom, int pageSize, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Step through the assets visible to this caller.
      void setDataAssetAsReferenceData​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String assetGUID, java.lang.String assetExternalIdentifier, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Classify the asset to indicate that it can be used as reference data.
      java.lang.String setupRelatedDataAsset​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, boolean assetManagerIsHome, java.lang.String relationshipTypeName, java.lang.String fromAssetGUID, java.lang.String toAssetGUID, RelationshipProperties relationshipProperties, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Link two asset together.
      void updateAssetRelationship​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String relationshipTypeName, java.lang.String relationshipGUID, boolean isMergeUpdate, RelationshipProperties relationshipProperties, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Update relationship between two elements.
      void updateDataAsset​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String assetGUID, java.lang.String assetExternalIdentifier, boolean isMergeUpdate, DataAssetProperties assetProperties, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Update the metadata element representing an asset.
      void withdrawDataAsset​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String assetGUID, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Update the zones for the asset so that it is no longer visible to consumers.
    • Method Detail

      • createDataAsset

        java.lang.String createDataAsset​(java.lang.String userId,
                                         java.lang.String assetManagerGUID,
                                         java.lang.String assetManagerName,
                                         boolean assetManagerIsHome,
                                         ExternalIdentifierProperties externalIdentifierProperties,
                                         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 capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        assetManagerIsHome - ensure that only the asset manager can update this asset
        externalIdentifierProperties - optional properties used to define an external identifier
        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

        java.lang.String createDataAssetFromTemplate​(java.lang.String userId,
                                                     java.lang.String assetManagerGUID,
                                                     java.lang.String assetManagerName,
                                                     boolean assetManagerIsHome,
                                                     java.lang.String templateGUID,
                                                     ExternalIdentifierProperties externalIdentifierProperties,
                                                     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 capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        assetManagerIsHome - ensure that only the asset manager can update this asset
        externalIdentifierProperties - optional properties used to define an external identifier
        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​(java.lang.String userId,
                             java.lang.String assetManagerGUID,
                             java.lang.String assetManagerName,
                             java.lang.String assetGUID,
                             java.lang.String assetExternalIdentifier,
                             boolean isMergeUpdate,
                             DataAssetProperties assetProperties,
                             java.util.Date effectiveTime,
                             boolean forLineage,
                             boolean forDuplicateProcessing)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
        Update the metadata element representing an asset.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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
        effectiveTime - optional date for effective time of the query. Null means any effective time
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        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​(java.lang.String userId,
                              java.lang.String assetManagerGUID,
                              java.lang.String assetManagerName,
                              java.lang.String assetGUID,
                              java.util.Date effectiveTime,
                              boolean forLineage,
                              boolean forDuplicateProcessing)
                       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 capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        assetGUID - unique identifier of the metadata element to publish
        effectiveTime - optional date for effective time of the query. Null means any effective time
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        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​(java.lang.String userId,
                               java.lang.String assetManagerGUID,
                               java.lang.String assetManagerName,
                               java.lang.String assetGUID,
                               java.util.Date effectiveTime,
                               boolean forLineage,
                               boolean forDuplicateProcessing)
                        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 capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        assetGUID - unique identifier of the metadata element to withdraw
        effectiveTime - optional date for effective time of the query. Null means any effective time
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        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​(java.lang.String userId,
                             java.lang.String assetManagerGUID,
                             java.lang.String assetManagerName,
                             java.lang.String assetGUID,
                             java.lang.String assetExternalIdentifier,
                             java.util.Date effectiveTime,
                             boolean forLineage,
                             boolean forDuplicateProcessing)
                      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 capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        assetGUID - unique identifier of the metadata element to remove
        assetExternalIdentifier - unique identifier of the asset in the external asset manager
        effectiveTime - optional date for effective time of the query. Null means any effective time
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        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​(java.lang.String userId,
                                         java.lang.String assetManagerGUID,
                                         java.lang.String assetManagerName,
                                         java.lang.String assetGUID,
                                         java.lang.String assetExternalIdentifier,
                                         java.util.Date effectiveTime,
                                         boolean forLineage,
                                         boolean forDuplicateProcessing)
                                  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 capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        assetGUID - unique identifier of the metadata element to update
        assetExternalIdentifier - unique identifier of the asset in the external asset manager
        effectiveTime - optional date for effective time of the query. Null means any effective time
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        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​(java.lang.String userId,
                                           java.lang.String assetManagerGUID,
                                           java.lang.String assetManagerName,
                                           java.lang.String assetGUID,
                                           java.lang.String assetExternalIdentifier,
                                           java.util.Date effectiveTime,
                                           boolean forLineage,
                                           boolean forDuplicateProcessing)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
        Remove the reference data designation from the asset.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        assetGUID - unique identifier of the metadata element to update
        assetExternalIdentifier - unique identifier of the asset in the external asset manager
        effectiveTime - optional date for effective time of the query. Null means any effective time
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        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)
      • setupRelatedDataAsset

        java.lang.String setupRelatedDataAsset​(java.lang.String userId,
                                               java.lang.String assetManagerGUID,
                                               java.lang.String assetManagerName,
                                               boolean assetManagerIsHome,
                                               java.lang.String relationshipTypeName,
                                               java.lang.String fromAssetGUID,
                                               java.lang.String toAssetGUID,
                                               RelationshipProperties relationshipProperties,
                                               java.util.Date effectiveTime,
                                               boolean forLineage,
                                               boolean forDuplicateProcessing)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException
        Link two asset together. Use information from the relationship type definition to ensure the fromAssetGUID and toAssetGUID are the right way around.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        assetManagerIsHome - ensure that only the process manager can update this process
        relationshipTypeName - type name of relationship to create
        fromAssetGUID - unique identifier of the asset at end 1 of the relationship
        toAssetGUID - unique identifier of the asset at end 2 of the relationship
        relationshipProperties - unique identifier for this relationship
        effectiveTime - optional date for effective time of the query. Null means any effective time
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Returns:
        unique identifier of the relationship
        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)
      • getAssetRelationship

        RelationshipElement getAssetRelationship​(java.lang.String userId,
                                                 java.lang.String assetManagerGUID,
                                                 java.lang.String assetManagerName,
                                                 java.lang.String relationshipTypeName,
                                                 java.lang.String fromAssetGUID,
                                                 java.lang.String toAssetGUID,
                                                 java.util.Date effectiveTime,
                                                 boolean forLineage,
                                                 boolean forDuplicateProcessing)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException
        Retrieve the relationship between two elements.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        relationshipTypeName - type name of relationship to create
        fromAssetGUID - unique identifier of the asset at end 1 of the relationship
        toAssetGUID - unique identifier of the asset at end 2 of the relationship
        effectiveTime - optional date for effective time of the query. Null means any effective time
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Returns:
        unique identifier and properties of the relationship
        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)
      • updateAssetRelationship

        void updateAssetRelationship​(java.lang.String userId,
                                     java.lang.String assetManagerGUID,
                                     java.lang.String assetManagerName,
                                     java.lang.String relationshipTypeName,
                                     java.lang.String relationshipGUID,
                                     boolean isMergeUpdate,
                                     RelationshipProperties relationshipProperties,
                                     java.util.Date effectiveTime,
                                     boolean forLineage,
                                     boolean forDuplicateProcessing)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
        Update relationship between two elements.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        relationshipTypeName - type name of relationship to update
        relationshipGUID - unique identifier of the relationship
        relationshipProperties - description and/or purpose of the relationship
        isMergeUpdate - should the new properties be merged with the existing properties, or replace them entirely
        effectiveTime - optional date for effective time of the query. Null means any effective time
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        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)
      • clearAssetRelationship

        void clearAssetRelationship​(java.lang.String userId,
                                    java.lang.String assetManagerGUID,
                                    java.lang.String assetManagerName,
                                    java.lang.String relationshipTypeName,
                                    java.lang.String relationshipGUID,
                                    java.util.Date effectiveTime,
                                    boolean forLineage,
                                    boolean forDuplicateProcessing)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException
        Remove the relationship between two elements.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        relationshipTypeName - type name of relationship to delete
        relationshipGUID - unique identifier of the relationship
        effectiveTime - optional date for effective time of the query. Null means any effective time
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        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)
      • getRelatedAssetsAtEnd2

        java.util.List<RelationshipElement> getRelatedAssetsAtEnd2​(java.lang.String userId,
                                                                   java.lang.String assetManagerGUID,
                                                                   java.lang.String assetManagerName,
                                                                   java.lang.String relationshipTypeName,
                                                                   java.lang.String fromAssetGUID,
                                                                   int startingFrom,
                                                                   int pageSize,
                                                                   java.util.Date effectiveTime,
                                                                   boolean forLineage,
                                                                   boolean forDuplicateProcessing)
                                                            throws InvalidParameterException,
                                                                   UserNotAuthorizedException,
                                                                   PropertyServerException
        Retrieve the requested relationships linked from a specific element at end 2.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        relationshipTypeName - type name of relationship to delete
        fromAssetGUID - unique identifier of the asset at end 1 of the relationship
        startingFrom - start position for results
        pageSize - maximum number of results
        effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Returns:
        unique identifier and properties of the relationship
        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)
      • getRelatedAssetsAtEnd1

        java.util.List<RelationshipElement> getRelatedAssetsAtEnd1​(java.lang.String userId,
                                                                   java.lang.String assetManagerGUID,
                                                                   java.lang.String assetManagerName,
                                                                   java.lang.String relationshipTypeName,
                                                                   java.lang.String toAssetGUID,
                                                                   int startingFrom,
                                                                   int pageSize,
                                                                   java.util.Date effectiveTime,
                                                                   boolean forLineage,
                                                                   boolean forDuplicateProcessing)
                                                            throws InvalidParameterException,
                                                                   UserNotAuthorizedException,
                                                                   PropertyServerException
        Retrieve the relationships linked from a specific element at end 2 of the relationship.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        relationshipTypeName - type name of relationship to delete
        toAssetGUID - unique identifier of the asset at end 2 of the relationship
        startingFrom - start position for results
        pageSize - maximum number of results
        effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Returns:
        unique identifier and properties of the relationship
        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

        java.util.List<DataAssetElement> findDataAssets​(java.lang.String userId,
                                                        java.lang.String assetManagerGUID,
                                                        java.lang.String assetManagerName,
                                                        java.lang.String searchString,
                                                        int startFrom,
                                                        int pageSize,
                                                        java.util.Date effectiveTime,
                                                        boolean forLineage,
                                                        boolean forDuplicateProcessing)
                                                 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 capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        searchString - string to find in the properties
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        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

        java.util.List<DataAssetElement> scanDataAssets​(java.lang.String userId,
                                                        java.lang.String assetManagerGUID,
                                                        java.lang.String assetManagerName,
                                                        int startFrom,
                                                        int pageSize,
                                                        java.util.Date effectiveTime,
                                                        boolean forLineage,
                                                        boolean forDuplicateProcessing)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException
        Step through the assets visible to this caller.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        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

        java.util.List<DataAssetElement> getDataAssetsByName​(java.lang.String userId,
                                                             java.lang.String assetManagerGUID,
                                                             java.lang.String assetManagerName,
                                                             java.lang.String name,
                                                             int startFrom,
                                                             int pageSize,
                                                             java.util.Date effectiveTime,
                                                             boolean forLineage,
                                                             boolean forDuplicateProcessing)
                                                      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 capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        name - name to search for
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        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

        java.util.List<DataAssetElement> getDataAssetsForAssetManager​(java.lang.String userId,
                                                                      java.lang.String assetManagerGUID,
                                                                      java.lang.String assetManagerName,
                                                                      int startFrom,
                                                                      int pageSize,
                                                                      java.util.Date effectiveTime,
                                                                      boolean forLineage,
                                                                      boolean forDuplicateProcessing)
                                                               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 capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        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​(java.lang.String userId,
                                            java.lang.String assetManagerGUID,
                                            java.lang.String assetManagerName,
                                            java.lang.String openMetadataGUID,
                                            java.util.Date effectiveTime,
                                            boolean forLineage,
                                            boolean forDuplicateProcessing)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException
        Retrieve the asset metadata element with the supplied unique identifier.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        openMetadataGUID - unique identifier of the requested metadata element
        effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        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)