Class LineageIntegratorContext

  • All Implemented Interfaces:
    OpenLineageListenerManager

    public class LineageIntegratorContext
    extends java.lang.Object
    implements OpenLineageListenerManager
    LineageIntegratorContext provides a wrapper around the Asset Manager OMAS client. It provides the simplified interface to open metadata needed by the LineageIntegratorConnector.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addIncompleteClassification​(java.lang.String elementGUID, java.lang.String elementExternalIdentifier, java.util.Date effectiveTime)
      Classify the element with the Incomplete classification to indicate that it has more details to come.
      void addMementoClassification​(java.lang.String elementGUID, java.lang.String elementExternalIdentifier, java.util.Date effectiveTime)
      Classify the element with the Memento classification to indicate that it has been logically deleted for by lineage requests.
      void clearBusinessSignificant​(java.lang.String elementGUID, java.util.Date effectiveTime)
      Remove the "BusinessSignificant" designation from the element.
      void clearColumnAsPrimaryKey​(java.lang.String schemaAttributeGUID, java.util.Date effectiveTime)
      Remove the primary key designation from the schema attribute.
      void clearControlFlow​(java.lang.String controlFlowGUID, java.util.Date effectiveTime)
      Remove the control flow relationship between two elements.
      void clearDataAssetAsReferenceData​(java.lang.String assetGUID, java.util.Date effectiveTime)
      Remove the reference data designation from the asset.
      void clearDataFlow​(java.lang.String dataFlowGUID, java.util.Date effectiveTime)
      Remove the data flow relationship between two elements.
      void clearForeignKeyRelationship​(java.lang.String primaryKeyGUID, java.lang.String foreignKeyGUID, java.util.Date effectiveTime)
      Remove the foreign key relationship between two schema elements.
      void clearIncompleteClassification​(java.lang.String elementGUID, java.lang.String elementExternalIdentifier, java.util.Date effectiveTime)
      Remove the Incomplete designation from the element.
      void clearLineageMapping​(java.lang.String lineageMappingGUID, java.util.Date effectiveTime)
      Remove the lineage mapping between two elements.
      void clearMementoClassification​(java.lang.String elementGUID, java.lang.String elementExternalIdentifier, java.util.Date effectiveTime)
      Remove the memento designation from the element.
      void clearPortDelegation​(java.lang.String portOneGUID, java.lang.String portTwoGUID, java.util.Date effectiveTime)
      Remove the port delegation relationship between two ports.
      void clearPortSchemaType​(java.lang.String portGUID, java.lang.String schemaTypeGUID, java.util.Date effectiveTime)
      Remove the schema type from a port.
      void clearProcessCall​(java.lang.String processCallGUID, java.util.Date effectiveTime)
      Remove the process call relationship.
      void clearProcessParent​(java.lang.String parentProcessGUID, java.lang.String childProcessGUID, java.util.Date effectiveTime)
      Remove a parent-child relationship between two processes.
      void clearProcessPort​(java.lang.String processGUID, java.lang.String portGUID, java.util.Date effectiveTime)
      Unlink a port from a process.
      void clearSchemaElementAsCalculatedValue​(java.lang.String schemaElementGUID, java.util.Date effectiveTime)
      Remove the calculated value designation from the schema element.
      void clearSchemaTypeParent​(java.lang.String schemaTypeGUID, java.lang.String parentElementGUID, java.lang.String parentElementTypeName, java.util.Date effectiveTime)
      Remove the relationship between a schema type and its parent data asset, process or port.
      java.lang.String createDataAsset​(boolean assetManagerIsHome, DataAssetProperties assetProperties)
      Create a new metadata element to represent the root of a data asset.
      java.lang.String createDataAssetFromTemplate​(boolean assetManagerIsHome, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent an asset using an existing metadata element as a template.
      java.lang.String createPort​(boolean assetManagerIsHome, java.lang.String processGUID, PortProperties portProperties, java.util.Date effectiveTime)
      Create a new metadata element to represent a port.
      java.lang.String createProcess​(boolean assetManagerIsHome, ProcessStatus processStatus, ProcessProperties processProperties)
      Create a new metadata element to represent a process.
      java.lang.String createProcessFromTemplate​(boolean assetManagerIsHome, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a process using an existing metadata element as a template.
      java.lang.String createSchemaAttribute​(boolean assetManagerIsHome, java.lang.String schemaElementGUID, SchemaAttributeProperties schemaAttributeProperties, java.util.Date effectiveTime)
      Create a new metadata element to represent a schema attribute.
      java.lang.String createSchemaAttributeFromTemplate​(boolean assetManagerIsHome, java.lang.String schemaElementGUID, java.lang.String templateGUID, TemplateProperties templateProperties, java.util.Date effectiveTime)
      Create a new metadata element to represent a schema attribute using an existing metadata element as a template.
      java.lang.String createSchemaType​(boolean assetManagerIsHome, SchemaTypeProperties schemaTypeProperties)
      Create a new metadata element to represent a schema type.
      java.lang.String createSchemaTypeFromTemplate​(boolean assetManagerIsHome, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a schema type using an existing metadata element as a template.
      java.util.List<DataAssetElement> findDataAssets​(java.lang.String searchString, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of data asset metadata elements that contain the search string.
      java.util.List<GovernanceActionProcessElement> findGovernanceActionProcesses​(java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of governance action process metadata elements that contain the search string.
      java.util.List<GovernanceActionTypeElement> findGovernanceActionTypes​(java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of governance action type metadata elements that contain the search string.
      java.util.List<PortElement> findPorts​(java.lang.String searchString, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of port metadata elements that contain the search string.
      java.util.List<ProcessElement> findProcesses​(java.lang.String searchString, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of process metadata elements that contain the search string.
      java.util.List<SchemaAttributeElement> findSchemaAttributes​(java.lang.String searchString, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of schema attribute metadata elements that contain the search string.
      java.util.List<SchemaTypeElement> findSchemaType​(java.lang.String searchString, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of schema type metadata elements that contain the search string.
      java.util.List<GovernanceActionElement> getActiveGovernanceActions​(int startFrom, int pageSize)
      Retrieve the governance actions that are still in process.
      ControlFlowElement getControlFlow​(java.lang.String currentStepGUID, java.lang.String nextStepGUID, java.lang.String qualifiedName, java.util.Date effectiveTime)
      Retrieve the control flow relationship between two elements.
      java.util.List<ControlFlowElement> getControlFlowNextSteps​(java.lang.String currentStepGUID, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the control relationships linked from a specific element to the possible next elements in the process.
      java.util.List<ControlFlowElement> getControlFlowPreviousSteps​(java.lang.String currentStepGUID, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the control relationships linked from a specific element to the possible previous elements in the process.
      DataAssetElement getDataAssetByGUID​(java.lang.String openMetadataGUID, java.util.Date effectiveTime)
      Retrieve the asset metadata element with the supplied unique identifier.
      java.util.List<DataAssetElement> getDataAssetsByName​(java.lang.String name, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of data asset metadata elements with a matching qualified or display name.
      java.util.List<DataAssetElement> getDataAssetsForAssetManager​(int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of assets created on behalf of this asset manager.
      DataFlowElement getDataFlow​(java.lang.String dataSupplierGUID, java.lang.String dataConsumerGUID, java.lang.String qualifiedName, java.util.Date effectiveTime)
      Retrieve the data flow relationship between two elements.
      java.util.List<DataFlowElement> getDataFlowConsumers​(java.lang.String dataSupplierGUID, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the data flow relationships linked from a specific element to the downstream consumers.
      java.util.List<DataFlowElement> getDataFlowSuppliers​(java.lang.String dataConsumerGUID, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the data flow relationships linked from a specific element to the upstream suppliers.
      java.util.List<LineageMappingElement> getDestinationLineageMappings​(java.lang.String sourceElementGUID, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the lineage mapping relationships linked from a specific source element to its destinations.
      GovernanceActionTypeElement getFirstActionType​(java.lang.String processGUID)
      Return the governance action type that is the first step in a governance action process.
      GovernanceActionElement getGovernanceAction​(java.lang.String governanceActionGUID)
      Request the status of an executing governance action request.
      GovernanceActionProcessElement getGovernanceActionProcessByGUID​(java.lang.String processGUID)
      Retrieve the governance action process metadata element with the supplied unique identifier.
      java.util.List<GovernanceActionProcessElement> getGovernanceActionProcessesByName​(java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of governance action process metadata elements with a matching qualified or display name.
      java.util.List<GovernanceActionElement> getGovernanceActions​(int startFrom, int pageSize)
      Retrieve the governance actions known to the server.
      GovernanceActionTypeElement getGovernanceActionTypeByGUID​(java.lang.String actionTypeGUID)
      Retrieve the governance action type metadata element with the supplied unique identifier.
      java.util.List<GovernanceActionTypeElement> getGovernanceActionTypesByName​(java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of governance action type metadata elements with a matching qualified or display name.
      java.lang.String getIntegrationServiceName()
      Return the qualified name of the integration services that is supplied in the configuration document.
      java.util.List<SchemaAttributeElement> getNestedSchemaAttributes​(java.lang.String parentSchemaElementGUID, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of schema attributes associated with a schema element.
      java.util.List<NextGovernanceActionTypeElement> getNextGovernanceActionTypes​(java.lang.String actionTypeGUID, int startFrom, int pageSize)
      Return the lust of next action type defined for the governance action process.
      PortElement getPortByGUID​(java.lang.String portGUID, java.util.Date effectiveTime)
      Retrieve the port metadata element with the supplied unique identifier.
      PortElement getPortDelegation​(java.lang.String portGUID, java.util.Date effectiveTime)
      Retrieve the port that this port delegates to.
      java.util.List<PortElement> getPortsByName​(java.lang.String name, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of port metadata elements with a matching qualified or display name.
      java.util.List<PortElement> getPortsForProcess​(java.lang.String processGUID, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of ports associated with a process.
      java.util.List<PortElement> getPortUse​(java.lang.String portGUID, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of ports that delegate to this port.
      ProcessElement getProcessByGUID​(java.lang.String processGUID, java.util.Date effectiveTime)
      Retrieve the process metadata element with the supplied unique identifier.
      ProcessCallElement getProcessCall​(java.lang.String callerGUID, java.lang.String calledGUID, java.lang.String qualifiedName, java.util.Date effectiveTime)
      Retrieve the process call relationship between two elements.
      java.util.List<ProcessCallElement> getProcessCalled​(java.lang.String callerGUID, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the process call relationships linked from a specific element to the elements it calls.
      java.util.List<ProcessCallElement> getProcessCallers​(java.lang.String calledGUID, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the process call relationships linked from a specific element to its callers.
      java.util.List<ProcessElement> getProcessesByName​(java.lang.String name, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of process metadata elements with a matching qualified or display name.
      java.util.List<ProcessElement> getProcessesForAssetManager​(int startFrom, int pageSize, java.util.Date effectiveTime)
      Return the list of processes associated with the asset manager.
      ProcessElement getProcessParent​(java.lang.String processGUID, java.util.Date effectiveTime)
      Retrieve the process metadata element with the supplied unique identifier.
      SchemaAttributeElement getSchemaAttributeByGUID​(java.lang.String schemaAttributeGUID, java.util.Date effectiveTime)
      Retrieve the schema attribute metadata element with the supplied unique identifier.
      java.util.List<SchemaAttributeElement> getSchemaAttributesByName​(java.lang.String name, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of schema attribute metadata elements with a matching qualified or display name.
      SchemaTypeElement getSchemaTypeByGUID​(java.lang.String schemaTypeGUID, java.util.Date effectiveTime)
      Retrieve the schema type metadata element with the supplied unique identifier.
      java.util.List<SchemaTypeElement> getSchemaTypeByName​(java.lang.String name, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of schema type metadata elements with a matching qualified or display name.
      SchemaTypeElement getSchemaTypeForElement​(java.lang.String parentElementGUID, java.lang.String parentElementTypeName, java.util.Date effectiveTime)
      Return the schema type associated with a specific open metadata element (data asset, process or port).
      ElementHeader getSchemaTypeParent​(java.lang.String schemaTypeGUID, java.util.Date effectiveTime)
      Retrieve the header of the metadata element connected to a schema type.
      java.util.List<LineageMappingElement> getSourceLineageMappings​(java.lang.String destinationElementGUID, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the lineage mapping relationships linked from a specific destination element to its sources.
      java.util.List<ProcessElement> getSubProcesses​(java.lang.String processGUID, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the process metadata element with the supplied unique identifier.
      boolean isForLineage()
      Return whether retrieval requests from this service are to include elements with the Memento classification attached or not.
      void publishDataAsset​(java.lang.String assetGUID, java.util.Date effectiveTime)
      Update the zones for the data asset so that it becomes visible to consumers.
      void publishOpenLineageRunEvent​(java.lang.String rawEvent)
      Called each time an integration connector wishes to publish an open lineage run event.
      void publishOpenLineageRunEvent​(OpenLineageRunEvent event)
      Called each time an open lineage run event is published to the Lineage Integrator OMIS.
      void publishProcess​(java.lang.String processGUID, java.util.Date effectiveTime)
      Update the zones for the asset so that it becomes visible to consumers.
      void registerListener​(AssetManagerEventListener listener)
      Register a listener object that will be passed each of the events published by the Asset Manager OMAS.
      void registerListener​(OpenLineageEventListener listener)
      The listener is implemented by the integration connector.
      void removeDataAsset​(java.lang.String assetGUID, java.util.Date effectiveTime)
      Remove the metadata element representing a data asset.
      void removePort​(java.lang.String portGUID, java.util.Date effectiveTime)
      Remove the metadata element representing a port.
      void removeProcess​(java.lang.String processGUID, java.lang.String processExternalIdentifier, java.util.Date effectiveTime)
      Remove the metadata element representing a process.
      void removeSchemaAttribute​(java.lang.String schemaAttributeGUID, java.util.Date effectiveTime)
      Remove the metadata element representing a schema attribute.
      void removeSchemaType​(java.lang.String schemaTypeGUID, java.util.Date effectiveTime)
      Remove the metadata element representing a schema type.
      void setBusinessSignificant​(java.lang.String elementGUID, java.util.Date effectiveTime)
      Classify a port, process or asset as "BusinessSignificant" (this may affect the way that lineage is displayed).
      void setDataAssetAsReferenceData​(java.lang.String assetGUID, java.util.Date effectiveTime)
      Classify the data asset to indicate that it can be used as reference data.
      void setForLineage​(boolean forLineage)
      Set up whether retrieval requests from this service are to include elements with the Memento classification attached or not.
      void setSchemaElementAsCalculatedValue​(boolean assetManagerIsHome, java.lang.String schemaElementGUID, java.lang.String formula, java.util.Date effectiveTime)
      Classify the schema type (or attribute if type is embedded) to indicate that it is a calculated value.
      void setupColumnAsPrimaryKey​(boolean assetManagerIsHome, java.lang.String schemaAttributeGUID, java.lang.String schemaAttributeExternalIdentifier, java.lang.String primaryKeyName, KeyPattern primaryKeyPattern, java.util.Date effectiveTime)
      Classify the column schema attribute to indicate that it describes a primary key.
      java.lang.String setupControlFlow​(boolean assetManagerIsHome, java.lang.String currentStepGUID, java.lang.String nextStepGUID, ControlFlowProperties properties, java.util.Date effectiveTime)
      Link two elements to show that when one completes the next is started.
      java.lang.String setupDataFlow​(boolean assetManagerIsHome, java.lang.String dataSupplierGUID, java.lang.String dataConsumerGUID, DataFlowProperties properties, java.util.Date effectiveTime)
      Link two elements together to show that data flows from one to the other.
      void setupForeignKeyRelationship​(boolean assetManagerIsHome, java.lang.String primaryKeyGUID, java.lang.String foreignKeyGUID, ForeignKeyProperties foreignKeyProperties, java.util.Date effectiveTime)
      Link two schema attributes together to show a foreign key relationship.
      void setupLineageMapping​(java.lang.String sourceElementGUID, java.lang.String destinationElementGUID, LineageMappingProperties properties, java.util.Date effectiveTime)
      Link to elements together to show that they are part of the lineage of the data that is moving between the processes.
      void setupPortDelegation​(boolean assetManagerIsHome, java.lang.String portOneGUID, java.lang.String portTwoGUID, java.util.Date effectiveTime)
      Link two ports together to show that portTwo is an implementation of portOne.
      void setupPortSchemaType​(boolean assetManagerIsHome, java.lang.String portGUID, java.lang.String schemaTypeGUID, java.util.Date effectiveTime)
      Link a schema type to a port to show the structure of data it accepts.
      java.lang.String setupProcessCall​(boolean assetManagerIsHome, java.lang.String callerGUID, java.lang.String calledGUID, ProcessCallProperties properties, java.util.Date effectiveTime)
      Link two elements together to show a request-response call between them.
      void setupProcessParent​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, boolean assetManagerIsHome, java.lang.String parentProcessGUID, java.lang.String childProcessGUID, ProcessContainmentProperties containmentProperties, java.util.Date effectiveTime)
      Create a parent-child relationship between two processes.
      void setupProcessPort​(boolean assetManagerIsHome, java.lang.String processGUID, java.lang.String portGUID, java.util.Date effectiveTime)
      Link a port to a process.
      void setupSchemaTypeParent​(boolean assetManagerIsHome, java.lang.String schemaTypeGUID, java.lang.String parentElementGUID, java.lang.String parentElementTypeName, RelationshipProperties properties, java.util.Date effectiveTime)
      Connect a schema type to a data asset, process or port.
      void updateControlFlow​(java.lang.String controlFlowGUID, ControlFlowProperties properties, java.util.Date effectiveTime)
      Update the relationship between two elements that shows that when one completes the next is started.
      void updateDataAsset​(java.lang.String assetGUID, boolean isMergeUpdate, DataAssetProperties assetProperties, java.util.Date effectiveTime)
      Update the metadata element representing a data source.
      void updateDataFlow​(java.lang.String dataFlowGUID, DataFlowProperties properties, java.util.Date effectiveTime)
      Update relationship between two elements that shows that data flows from one to the other.
      void updateForeignKeyRelationship​(java.lang.String primaryKeyGUID, java.lang.String foreignKeyGUID, ForeignKeyProperties foreignKeyProperties, java.util.Date effectiveTime)
      Update the relationship properties for the query target.
      void updateLineageMapping​(java.lang.String lineageMappingGUID, LineageMappingProperties properties, java.util.Date effectiveTime)
      Update the lineage mapping relationship between two elements.
      void updatePort​(java.lang.String portGUID, PortProperties portProperties, java.util.Date effectiveTime)
      Update the properties of the metadata element representing a port.
      void updateProcess​(java.lang.String processGUID, boolean isMergeUpdate, ProcessProperties processProperties, java.util.Date effectiveTime)
      Update the metadata element representing a process.
      void updateProcessCall​(java.lang.String processCallGUID, ProcessCallProperties properties, java.util.Date effectiveTime)
      Update the relationship between two elements that shows a request-response call between them.
      void updateProcessStatus​(java.lang.String processGUID, ProcessStatus processStatus, java.util.Date effectiveTime)
      Update the status of the metadata element representing a process.
      void updateSchemaAttribute​(java.lang.String schemaAttributeGUID, boolean isMergeUpdate, SchemaAttributeProperties schemaAttributeProperties, java.util.Date effectiveTime)
      Update the properties of the metadata element representing a schema attribute.
      void updateSchemaType​(java.lang.String schemaTypeGUID, boolean isMergeUpdate, SchemaTypeProperties schemaTypeProperties, java.util.Date effectiveTime)
      Update the metadata element representing a schema type.
      void withdrawDataAsset​(java.lang.String assetGUID, java.util.Date effectiveTime)
      Update the zones for the data asset so that it is no longer visible to consumers.
      void withdrawProcess​(java.lang.String processGUID, java.util.Date effectiveTime)
      Update the zones for the asset so that it is no longer visible to consumers.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • LineageIntegratorContext

        public LineageIntegratorContext​(OpenLineageListenerManager openLineageListenerManager,
                                        DataAssetExchangeClient dataAssetExchangeClient,
                                        LineageExchangeClient lineageExchangeClient,
                                        GovernanceExchangeClient governanceExchangeClient,
                                        StewardshipExchangeClient stewardshipExchangeClient,
                                        AssetManagerEventClient eventClient,
                                        java.lang.String userId,
                                        java.lang.String assetManagerGUID,
                                        java.lang.String assetManagerName,
                                        java.lang.String connectorName,
                                        java.lang.String integrationServiceName,
                                        AuditLog auditLog)
        Create a new context for a connector.
        Parameters:
        openLineageListenerManager - object responsible for managing open lineage listeners
        dataAssetExchangeClient - client for data asset requests
        lineageExchangeClient - client for lineage requests
        governanceExchangeClient - client for governance actions and related elements
        stewardshipExchangeClient - client for attaching governance metadata
        eventClient - client managing listeners for the OMAS OutTopic
        userId - integration daemon's userId
        assetManagerGUID - unique identifier of the software server capability for the asset manager
        assetManagerName - unique name of the software server capability for the asset manager
        connectorName - name of the connector using this context
        integrationServiceName - name of this service
        auditLog - logging destination
    • Method Detail

      • getIntegrationServiceName

        public java.lang.String getIntegrationServiceName()
        Return the qualified name of the integration services that is supplied in the configuration document.
        Returns:
        string name
      • isForLineage

        public boolean isForLineage()
        Return whether retrieval requests from this service are to include elements with the Memento classification attached or not.
        Returns:
        boolean flag
      • setForLineage

        public void setForLineage​(boolean forLineage)
        Set up whether retrieval requests from this service are to include elements with the Memento classification attached or not.
        Parameters:
        forLineage - boolean flag
      • registerListener

        public void registerListener​(OpenLineageEventListener listener)
        The listener is implemented by the integration connector. Once it is registered with the context, its processOpenLineageRunEvent() method is called each time an open lineage event is published to the Lineage Integrator OMIS.
        Specified by:
        registerListener in interface OpenLineageListenerManager
        Parameters:
        listener - listener to call
      • publishOpenLineageRunEvent

        public void publishOpenLineageRunEvent​(java.lang.String rawEvent)
        Called each time an integration connector wishes to publish an open lineage run event. The event is formatted and passed to each of the registered open lineage event listeners.
        Specified by:
        publishOpenLineageRunEvent in interface OpenLineageListenerManager
        Parameters:
        rawEvent - json payload to send for the event
      • publishOpenLineageRunEvent

        public void publishOpenLineageRunEvent​(OpenLineageRunEvent event)
        Called each time an open lineage run event is published to the Lineage Integrator OMIS. The integration connector is able to work with the formatted event using the Egeria beans or reformat the open lineage run event using the supplied open lineage backend beans or another set of beans.
        Specified by:
        publishOpenLineageRunEvent in interface OpenLineageListenerManager
        Parameters:
        event - bean for the event
      • createDataAssetFromTemplate

        public java.lang.String createDataAssetFromTemplate​(boolean assetManagerIsHome,
                                                            java.lang.String templateGUID,
                                                            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:
        assetManagerIsHome - ensure that only the asset manager can update this asset
        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

        public void updateDataAsset​(java.lang.String assetGUID,
                                    boolean isMergeUpdate,
                                    DataAssetProperties assetProperties,
                                    java.util.Date effectiveTime)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException
        Update the metadata element representing a data source.
        Parameters:
        assetGUID - unique identifier of the metadata element to update
        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
        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

        public void publishDataAsset​(java.lang.String assetGUID,
                                     java.util.Date effectiveTime)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
        Update the zones for the data 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:
        assetGUID - unique identifier of the metadata element to publish
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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

        public void withdrawDataAsset​(java.lang.String assetGUID,
                                      java.util.Date effectiveTime)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException
        Update the zones for the data 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:
        assetGUID - unique identifier of the metadata element to withdraw
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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

        public java.util.List<DataAssetElement> findDataAssets​(java.lang.String searchString,
                                                               int startFrom,
                                                               int pageSize,
                                                               java.util.Date effectiveTime)
                                                        throws InvalidParameterException,
                                                               UserNotAuthorizedException,
                                                               PropertyServerException
        Retrieve the list of data asset metadata elements that contain the search string. The search string is treated as a regular expression.
        Parameters:
        searchString - string to find in the properties
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • getDataAssetsByName

        public java.util.List<DataAssetElement> getDataAssetsByName​(java.lang.String name,
                                                                    int startFrom,
                                                                    int pageSize,
                                                                    java.util.Date effectiveTime)
                                                             throws InvalidParameterException,
                                                                    UserNotAuthorizedException,
                                                                    PropertyServerException
        Retrieve the list of data asset metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
        Parameters:
        name - name to search for
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • createSchemaTypeFromTemplate

        public java.lang.String createSchemaTypeFromTemplate​(boolean assetManagerIsHome,
                                                             java.lang.String templateGUID,
                                                             TemplateProperties templateProperties)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             PropertyServerException
        Create a new metadata element to represent a schema type using an existing metadata element as a template.
        Parameters:
        assetManagerIsHome - ensure that only the asset manager can update this schema element
        templateGUID - unique identifier of the metadata element to copy
        templateProperties - properties that override the template
        Returns:
        unique identifier of the new schema type
        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)
      • updateSchemaType

        public void updateSchemaType​(java.lang.String schemaTypeGUID,
                                     boolean isMergeUpdate,
                                     SchemaTypeProperties schemaTypeProperties,
                                     java.util.Date effectiveTime)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
        Update the metadata element representing a schema type.
        Parameters:
        schemaTypeGUID - unique identifier of the metadata element to update
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        schemaTypeProperties - new properties for the metadata element
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • setupSchemaTypeParent

        public void setupSchemaTypeParent​(boolean assetManagerIsHome,
                                          java.lang.String schemaTypeGUID,
                                          java.lang.String parentElementGUID,
                                          java.lang.String parentElementTypeName,
                                          RelationshipProperties properties,
                                          java.util.Date effectiveTime)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException
        Connect a schema type to a data asset, process or port.
        Parameters:
        assetManagerIsHome - ensure that only the asset manager can update this relationship
        schemaTypeGUID - unique identifier of the schema type to connect
        parentElementGUID - unique identifier of the open metadata element that this schema type is to be connected to
        parentElementTypeName - unique type name of the open metadata element that this schema type is to be connected to
        properties - properties for the relationship
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • clearSchemaTypeParent

        public void clearSchemaTypeParent​(java.lang.String schemaTypeGUID,
                                          java.lang.String parentElementGUID,
                                          java.lang.String parentElementTypeName,
                                          java.util.Date effectiveTime)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException
        Remove the relationship between a schema type and its parent data asset, process or port.
        Parameters:
        schemaTypeGUID - unique identifier of the schema type to connect
        parentElementGUID - unique identifier of the open metadata element that this schema type is to be connected to
        parentElementTypeName - unique type name of the open metadata element that this schema type is to be connected to
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • findSchemaType

        public java.util.List<SchemaTypeElement> findSchemaType​(java.lang.String searchString,
                                                                int startFrom,
                                                                int pageSize,
                                                                java.util.Date effectiveTime)
                                                         throws InvalidParameterException,
                                                                UserNotAuthorizedException,
                                                                PropertyServerException
        Retrieve the list of schema type metadata elements that contain the search string. The search string is treated as a regular expression.
        Parameters:
        searchString - string to find in the properties
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • getSchemaTypeForElement

        public SchemaTypeElement getSchemaTypeForElement​(java.lang.String parentElementGUID,
                                                         java.lang.String parentElementTypeName,
                                                         java.util.Date effectiveTime)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException
        Return the schema type associated with a specific open metadata element (data asset, process or port).
        Parameters:
        parentElementGUID - unique identifier of the open metadata element that this schema type is to be connected to
        parentElementTypeName - unique type name of the open metadata element that this schema type is to be connected to
        effectiveTime - optional date for effective time of the query. Null means any effective time
        Returns:
        metadata element describing the schema type associated with the requested parent 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)
      • getSchemaTypeByName

        public java.util.List<SchemaTypeElement> getSchemaTypeByName​(java.lang.String name,
                                                                     int startFrom,
                                                                     int pageSize,
                                                                     java.util.Date effectiveTime)
                                                              throws InvalidParameterException,
                                                                     UserNotAuthorizedException,
                                                                     PropertyServerException
        Retrieve the list of schema type metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
        Parameters:
        name - name to search for
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • createSchemaAttribute

        public java.lang.String createSchemaAttribute​(boolean assetManagerIsHome,
                                                      java.lang.String schemaElementGUID,
                                                      SchemaAttributeProperties schemaAttributeProperties,
                                                      java.util.Date effectiveTime)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException
        Create a new metadata element to represent a schema attribute.
        Parameters:
        assetManagerIsHome - ensure that only the asset manager can update this schema attribute
        schemaElementGUID - unique identifier of the schemaType or Schema Attribute where the schema attribute is connected to
        schemaAttributeProperties - properties for the schema attribute
        effectiveTime - optional date for effective time of the query. Null means any effective time
        Returns:
        unique identifier of the new metadata element for the schema attribute
        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)
      • createSchemaAttributeFromTemplate

        public java.lang.String createSchemaAttributeFromTemplate​(boolean assetManagerIsHome,
                                                                  java.lang.String schemaElementGUID,
                                                                  java.lang.String templateGUID,
                                                                  TemplateProperties templateProperties,
                                                                  java.util.Date effectiveTime)
                                                           throws InvalidParameterException,
                                                                  UserNotAuthorizedException,
                                                                  PropertyServerException
        Create a new metadata element to represent a schema attribute using an existing metadata element as a template.
        Parameters:
        assetManagerIsHome - ensure that only the asset manager can update this schema attribute
        schemaElementGUID - unique identifier of the schemaType or Schema Attribute where the schema attribute is connected to
        templateGUID - unique identifier of the metadata element to copy
        templateProperties - properties that override the template
        effectiveTime - optional date for effective time of the query. Null means any effective time
        Returns:
        unique identifier of the new metadata element for the schema attribute
        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)
      • updateSchemaAttribute

        public void updateSchemaAttribute​(java.lang.String schemaAttributeGUID,
                                          boolean isMergeUpdate,
                                          SchemaAttributeProperties schemaAttributeProperties,
                                          java.util.Date effectiveTime)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException
        Update the properties of the metadata element representing a schema attribute.
        Parameters:
        schemaAttributeGUID - unique identifier of the schema attribute to update
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        schemaAttributeProperties - new properties for the schema attribute
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • setSchemaElementAsCalculatedValue

        public void setSchemaElementAsCalculatedValue​(boolean assetManagerIsHome,
                                                      java.lang.String schemaElementGUID,
                                                      java.lang.String formula,
                                                      java.util.Date effectiveTime)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException
        Classify the schema type (or attribute if type is embedded) to indicate that it is a calculated value.
        Parameters:
        assetManagerIsHome - ensure that only the asset manager can update this schema attribute
        schemaElementGUID - unique identifier of the metadata element to update
        formula - description of how the value is calculated
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • setupColumnAsPrimaryKey

        public void setupColumnAsPrimaryKey​(boolean assetManagerIsHome,
                                            java.lang.String schemaAttributeGUID,
                                            java.lang.String schemaAttributeExternalIdentifier,
                                            java.lang.String primaryKeyName,
                                            KeyPattern primaryKeyPattern,
                                            java.util.Date effectiveTime)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException
        Classify the column schema attribute to indicate that it describes a primary key.
        Parameters:
        assetManagerIsHome - ensure that only the asset manager can update this classification
        schemaAttributeGUID - unique identifier of the metadata element to update
        schemaAttributeExternalIdentifier - unique identifier of the schema attribute in the external asset manager
        primaryKeyName - name of the primary key (if different from the column name)
        primaryKeyPattern - key pattern used to maintain the primary key
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • setupForeignKeyRelationship

        public void setupForeignKeyRelationship​(boolean assetManagerIsHome,
                                                java.lang.String primaryKeyGUID,
                                                java.lang.String foreignKeyGUID,
                                                ForeignKeyProperties foreignKeyProperties,
                                                java.util.Date effectiveTime)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException
        Link two schema attributes together to show a foreign key relationship.
        Parameters:
        assetManagerIsHome - ensure that only the asset manager can update this relationship
        primaryKeyGUID - unique identifier of the derived schema element
        foreignKeyGUID - unique identifier of the query target schema element
        foreignKeyProperties - properties for the foreign key relationship
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • updateForeignKeyRelationship

        public void updateForeignKeyRelationship​(java.lang.String primaryKeyGUID,
                                                 java.lang.String foreignKeyGUID,
                                                 ForeignKeyProperties foreignKeyProperties,
                                                 java.util.Date effectiveTime)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException
        Update the relationship properties for the query target.
        Parameters:
        primaryKeyGUID - unique identifier of the derived schema element
        foreignKeyGUID - unique identifier of the query target schema element
        foreignKeyProperties - properties for the foreign key relationship
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • clearForeignKeyRelationship

        public void clearForeignKeyRelationship​(java.lang.String primaryKeyGUID,
                                                java.lang.String foreignKeyGUID,
                                                java.util.Date effectiveTime)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException
        Remove the foreign key relationship between two schema elements.
        Parameters:
        primaryKeyGUID - unique identifier of the derived schema element
        foreignKeyGUID - unique identifier of the query target schema element
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • findSchemaAttributes

        public java.util.List<SchemaAttributeElement> findSchemaAttributes​(java.lang.String searchString,
                                                                           int startFrom,
                                                                           int pageSize,
                                                                           java.util.Date effectiveTime)
                                                                    throws InvalidParameterException,
                                                                           UserNotAuthorizedException,
                                                                           PropertyServerException
        Retrieve the list of schema attribute metadata elements that contain the search string. The search string is treated as a regular expression.
        Parameters:
        searchString - string to find in the properties
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • getNestedSchemaAttributes

        public java.util.List<SchemaAttributeElement> getNestedSchemaAttributes​(java.lang.String parentSchemaElementGUID,
                                                                                int startFrom,
                                                                                int pageSize,
                                                                                java.util.Date effectiveTime)
                                                                         throws InvalidParameterException,
                                                                                UserNotAuthorizedException,
                                                                                PropertyServerException
        Retrieve the list of schema attributes associated with a schema element.
        Parameters:
        parentSchemaElementGUID - unique identifier of the schema element of interest
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        Returns:
        list of associated 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)
      • getSchemaAttributesByName

        public java.util.List<SchemaAttributeElement> getSchemaAttributesByName​(java.lang.String name,
                                                                                int startFrom,
                                                                                int pageSize,
                                                                                java.util.Date effectiveTime)
                                                                         throws InvalidParameterException,
                                                                                UserNotAuthorizedException,
                                                                                PropertyServerException
        Retrieve the list of schema attribute metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
        Parameters:
        name - name to search for
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • createProcessFromTemplate

        public java.lang.String createProcessFromTemplate​(boolean assetManagerIsHome,
                                                          java.lang.String templateGUID,
                                                          TemplateProperties templateProperties)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException
        Create a new metadata element to represent a process using an existing metadata element as a template.
        Parameters:
        assetManagerIsHome - ensure that only the asset manager can update this process
        templateGUID - unique identifier of the metadata element to copy
        templateProperties - properties that override the template
        Returns:
        unique identifier of the new process
        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)
      • updateProcess

        public void updateProcess​(java.lang.String processGUID,
                                  boolean isMergeUpdate,
                                  ProcessProperties processProperties,
                                  java.util.Date effectiveTime)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Update the metadata element representing a process.
        Parameters:
        processGUID - unique identifier of the metadata element to update
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        processProperties - new properties for the metadata element
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • setupProcessParent

        public void setupProcessParent​(java.lang.String userId,
                                       java.lang.String assetManagerGUID,
                                       java.lang.String assetManagerName,
                                       boolean assetManagerIsHome,
                                       java.lang.String parentProcessGUID,
                                       java.lang.String childProcessGUID,
                                       ProcessContainmentProperties containmentProperties,
                                       java.util.Date effectiveTime)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException
        Create a parent-child relationship between two processes.
        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
        parentProcessGUID - unique identifier of the process in the external asset manager that is to be the parent process
        childProcessGUID - unique identifier of the process in the external asset manager that is to be the nested sub-process
        containmentProperties - describes the ownership of the sub-process
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • clearProcessParent

        public void clearProcessParent​(java.lang.String parentProcessGUID,
                                       java.lang.String childProcessGUID,
                                       java.util.Date effectiveTime)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException
        Remove a parent-child relationship between two processes.
        Parameters:
        parentProcessGUID - unique identifier of the process in the external asset manager that is to be the parent process
        childProcessGUID - unique identifier of the process in the external asset manager that is to be the nested sub-process
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • publishProcess

        public void publishProcess​(java.lang.String processGUID,
                                   java.util.Date effectiveTime)
                            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:
        processGUID - unique identifier of the metadata element to publish
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • withdrawProcess

        public void withdrawProcess​(java.lang.String processGUID,
                                    java.util.Date effectiveTime)
                             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 process is first created).
        Parameters:
        processGUID - unique identifier of the metadata element to withdraw
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • removeProcess

        public void removeProcess​(java.lang.String processGUID,
                                  java.lang.String processExternalIdentifier,
                                  java.util.Date effectiveTime)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Remove the metadata element representing a process.
        Parameters:
        processGUID - unique identifier of the metadata element to remove
        processExternalIdentifier - unique identifier of the process in the external asset manager
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • findProcesses

        public java.util.List<ProcessElement> findProcesses​(java.lang.String searchString,
                                                            int startFrom,
                                                            int pageSize,
                                                            java.util.Date effectiveTime)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            PropertyServerException
        Retrieve the list of process metadata elements that contain the search string. The search string is treated as a regular expression.
        Parameters:
        searchString - string to find in the properties
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • getProcessesForAssetManager

        public java.util.List<ProcessElement> getProcessesForAssetManager​(int startFrom,
                                                                          int pageSize,
                                                                          java.util.Date effectiveTime)
                                                                   throws InvalidParameterException,
                                                                          UserNotAuthorizedException,
                                                                          PropertyServerException
        Return the list of processes associated with the asset manager.
        Parameters:
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        Returns:
        list of metadata elements describing the processes associated with the requested 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)
      • getProcessesByName

        public java.util.List<ProcessElement> getProcessesByName​(java.lang.String name,
                                                                 int startFrom,
                                                                 int pageSize,
                                                                 java.util.Date effectiveTime)
                                                          throws InvalidParameterException,
                                                                 UserNotAuthorizedException,
                                                                 PropertyServerException
        Retrieve the list of process metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
        Parameters:
        name - name to search for
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • getSubProcesses

        public java.util.List<ProcessElement> getSubProcesses​(java.lang.String processGUID,
                                                              int startFrom,
                                                              int pageSize,
                                                              java.util.Date effectiveTime)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException
        Retrieve the process metadata element with the supplied unique identifier.
        Parameters:
        processGUID - unique identifier of the requested metadata element
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        Returns:
        list of process 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)
      • createPort

        public java.lang.String createPort​(boolean assetManagerIsHome,
                                           java.lang.String processGUID,
                                           PortProperties portProperties,
                                           java.util.Date effectiveTime)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
        Create a new metadata element to represent a port.
        Parameters:
        assetManagerIsHome - ensure that only the asset manager can update this port
        processGUID - unique identifier of the process where the port is located
        portProperties - properties for the port
        effectiveTime - optional date for effective time of the query. Null means any effective time
        Returns:
        unique identifier of the new metadata element for the port
        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)
      • setupProcessPort

        public void setupProcessPort​(boolean assetManagerIsHome,
                                     java.lang.String processGUID,
                                     java.lang.String portGUID,
                                     java.util.Date effectiveTime)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
        Link a port to a process.
        Parameters:
        assetManagerIsHome - ensure that only the asset manager can update this asset
        processGUID - unique identifier of the process
        portGUID - unique identifier of the port
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • setupPortDelegation

        public void setupPortDelegation​(boolean assetManagerIsHome,
                                        java.lang.String portOneGUID,
                                        java.lang.String portTwoGUID,
                                        java.util.Date effectiveTime)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException
        Link two ports together to show that portTwo is an implementation of portOne. (That is, portOne delegates to portTwo.)
        Parameters:
        assetManagerIsHome - ensure that only the asset manager can update this asset
        portOneGUID - unique identifier of the port at end 1
        portTwoGUID - unique identifier of the port at end 2
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • setupPortSchemaType

        public void setupPortSchemaType​(boolean assetManagerIsHome,
                                        java.lang.String portGUID,
                                        java.lang.String schemaTypeGUID,
                                        java.util.Date effectiveTime)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException
        Link a schema type to a port to show the structure of data it accepts.
        Parameters:
        assetManagerIsHome - ensure that only the asset manager can update this asset
        portGUID - unique identifier of the port
        schemaTypeGUID - unique identifier of the schemaType
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • findPorts

        public java.util.List<PortElement> findPorts​(java.lang.String searchString,
                                                     int startFrom,
                                                     int pageSize,
                                                     java.util.Date effectiveTime)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException
        Retrieve the list of port metadata elements that contain the search string. The search string is treated as a regular expression.
        Parameters:
        searchString - string to find in the properties
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • getPortsForProcess

        public java.util.List<PortElement> getPortsForProcess​(java.lang.String processGUID,
                                                              int startFrom,
                                                              int pageSize,
                                                              java.util.Date effectiveTime)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException
        Retrieve the list of ports associated with a process.
        Parameters:
        processGUID - unique identifier of the process of interest
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        Returns:
        list of associated 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)
      • getPortUse

        public java.util.List<PortElement> getPortUse​(java.lang.String portGUID,
                                                      int startFrom,
                                                      int pageSize,
                                                      java.util.Date effectiveTime)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException
        Retrieve the list of ports that delegate to this port.
        Parameters:
        portGUID - unique identifier of the starting port
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        Returns:
        list of associated 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)
      • getPortsByName

        public java.util.List<PortElement> getPortsByName​(java.lang.String name,
                                                          int startFrom,
                                                          int pageSize,
                                                          java.util.Date effectiveTime)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException
        Retrieve the list of port metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
        Parameters:
        name - name to search for
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • setupDataFlow

        public java.lang.String setupDataFlow​(boolean assetManagerIsHome,
                                              java.lang.String dataSupplierGUID,
                                              java.lang.String dataConsumerGUID,
                                              DataFlowProperties properties,
                                              java.util.Date effectiveTime)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException
        Link two elements together to show that data flows from one to the other.
        Parameters:
        assetManagerIsHome - ensure that only the asset manager can update this asset
        dataSupplierGUID - unique identifier of the data supplier
        dataConsumerGUID - unique identifier of the data consumer
        properties - unique identifier for this relationship along with description and/or additional relevant properties
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • getDataFlow

        public DataFlowElement getDataFlow​(java.lang.String dataSupplierGUID,
                                           java.lang.String dataConsumerGUID,
                                           java.lang.String qualifiedName,
                                           java.util.Date effectiveTime)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
        Retrieve the data flow relationship between two elements. The qualifiedName is optional unless there is more than one data flow relationships between these two elements since it is used to disambiguate the request. This is often used in conjunction with update.
        Parameters:
        dataSupplierGUID - unique identifier of the data supplier
        dataConsumerGUID - unique identifier of the data consumer
        qualifiedName - unique identifier for this relationship
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • updateDataFlow

        public void updateDataFlow​(java.lang.String dataFlowGUID,
                                   DataFlowProperties properties,
                                   java.util.Date effectiveTime)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException
        Update relationship between two elements that shows that data flows from one to the other.
        Parameters:
        dataFlowGUID - unique identifier of the data flow relationship
        properties - unique identifier for this relationship along with description and/or additional relevant properties
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • getDataFlowConsumers

        public java.util.List<DataFlowElement> getDataFlowConsumers​(java.lang.String dataSupplierGUID,
                                                                    int startFrom,
                                                                    int pageSize,
                                                                    java.util.Date effectiveTime)
                                                             throws InvalidParameterException,
                                                                    UserNotAuthorizedException,
                                                                    PropertyServerException
        Retrieve the data flow relationships linked from a specific element to the downstream consumers.
        Parameters:
        dataSupplierGUID - unique identifier of the data supplier
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • getDataFlowSuppliers

        public java.util.List<DataFlowElement> getDataFlowSuppliers​(java.lang.String dataConsumerGUID,
                                                                    int startFrom,
                                                                    int pageSize,
                                                                    java.util.Date effectiveTime)
                                                             throws InvalidParameterException,
                                                                    UserNotAuthorizedException,
                                                                    PropertyServerException
        Retrieve the data flow relationships linked from a specific element to the upstream suppliers.
        Parameters:
        dataConsumerGUID - unique identifier of the data consumer
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • setupControlFlow

        public java.lang.String setupControlFlow​(boolean assetManagerIsHome,
                                                 java.lang.String currentStepGUID,
                                                 java.lang.String nextStepGUID,
                                                 ControlFlowProperties properties,
                                                 java.util.Date effectiveTime)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException
        Link two elements to show that when one completes the next is started.
        Parameters:
        assetManagerIsHome - ensure that only the asset manager can update this asset
        currentStepGUID - unique identifier of the previous step
        nextStepGUID - unique identifier of the next step
        properties - unique identifier for this relationship along with description and/or additional relevant properties
        effectiveTime - optional date for effective time of the query. Null means any effective time
        Returns:
        unique identifier for the control flow 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)
      • getControlFlow

        public ControlFlowElement getControlFlow​(java.lang.String currentStepGUID,
                                                 java.lang.String nextStepGUID,
                                                 java.lang.String qualifiedName,
                                                 java.util.Date effectiveTime)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException
        Retrieve the control flow relationship between two elements. The qualifiedName is optional unless there is more than one control flow relationships between these two elements since it is used to disambiguate the request. This is often used in conjunction with update.
        Parameters:
        currentStepGUID - unique identifier of the previous step
        nextStepGUID - unique identifier of the next step
        qualifiedName - unique identifier for this relationship
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • updateControlFlow

        public void updateControlFlow​(java.lang.String controlFlowGUID,
                                      ControlFlowProperties properties,
                                      java.util.Date effectiveTime)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException
        Update the relationship between two elements that shows that when one completes the next is started.
        Parameters:
        controlFlowGUID - unique identifier of the control flow relationship
        properties - unique identifier for this relationship along with description and/or additional relevant properties
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • getControlFlowNextSteps

        public java.util.List<ControlFlowElement> getControlFlowNextSteps​(java.lang.String currentStepGUID,
                                                                          int startFrom,
                                                                          int pageSize,
                                                                          java.util.Date effectiveTime)
                                                                   throws InvalidParameterException,
                                                                          UserNotAuthorizedException,
                                                                          PropertyServerException
        Retrieve the control relationships linked from a specific element to the possible next elements in the process.
        Parameters:
        currentStepGUID - unique identifier of the current step
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • getControlFlowPreviousSteps

        public java.util.List<ControlFlowElement> getControlFlowPreviousSteps​(java.lang.String currentStepGUID,
                                                                              int startFrom,
                                                                              int pageSize,
                                                                              java.util.Date effectiveTime)
                                                                       throws InvalidParameterException,
                                                                              UserNotAuthorizedException,
                                                                              PropertyServerException
        Retrieve the control relationships linked from a specific element to the possible previous elements in the process.
        Parameters:
        currentStepGUID - unique identifier of the current step
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • setupProcessCall

        public java.lang.String setupProcessCall​(boolean assetManagerIsHome,
                                                 java.lang.String callerGUID,
                                                 java.lang.String calledGUID,
                                                 ProcessCallProperties properties,
                                                 java.util.Date effectiveTime)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException
        Link two elements together to show a request-response call between them.
        Parameters:
        assetManagerIsHome - ensure that only the asset manager can update this asset
        callerGUID - unique identifier of the element that is making the call
        calledGUID - unique identifier of the element that is processing the call
        properties - unique identifier for this relationship along with description and/or additional relevant properties
        effectiveTime - optional date for effective time of the query. Null means any effective time
        Returns:
        unique identifier of the new 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)
      • getProcessCall

        public ProcessCallElement getProcessCall​(java.lang.String callerGUID,
                                                 java.lang.String calledGUID,
                                                 java.lang.String qualifiedName,
                                                 java.util.Date effectiveTime)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException
        Retrieve the process call relationship between two elements. The qualifiedName is optional unless there is more than one process call relationships between these two elements since it is used to disambiguate the request. This is often used in conjunction with update.
        Parameters:
        callerGUID - unique identifier of the element that is making the call
        calledGUID - unique identifier of the element that is processing the call
        qualifiedName - unique identifier for this relationship
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • updateProcessCall

        public void updateProcessCall​(java.lang.String processCallGUID,
                                      ProcessCallProperties properties,
                                      java.util.Date effectiveTime)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException
        Update the relationship between two elements that shows a request-response call between them.
        Parameters:
        processCallGUID - unique identifier of the process call relationship
        properties - unique identifier for this relationship along with description and/or additional relevant properties
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • getProcessCalled

        public java.util.List<ProcessCallElement> getProcessCalled​(java.lang.String callerGUID,
                                                                   int startFrom,
                                                                   int pageSize,
                                                                   java.util.Date effectiveTime)
                                                            throws InvalidParameterException,
                                                                   UserNotAuthorizedException,
                                                                   PropertyServerException
        Retrieve the process call relationships linked from a specific element to the elements it calls.
        Parameters:
        callerGUID - unique identifier of the element that is making the call
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • getProcessCallers

        public java.util.List<ProcessCallElement> getProcessCallers​(java.lang.String calledGUID,
                                                                    int startFrom,
                                                                    int pageSize,
                                                                    java.util.Date effectiveTime)
                                                             throws InvalidParameterException,
                                                                    UserNotAuthorizedException,
                                                                    PropertyServerException
        Retrieve the process call relationships linked from a specific element to its callers.
        Parameters:
        calledGUID - unique identifier of the element that is processing the call
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • setupLineageMapping

        public void setupLineageMapping​(java.lang.String sourceElementGUID,
                                        java.lang.String destinationElementGUID,
                                        LineageMappingProperties properties,
                                        java.util.Date effectiveTime)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException
        Link to elements together to show that they are part of the lineage of the data that is moving between the processes. Typically, the lineage relationships stitch together processes and data assets supported by different technologies.
        Parameters:
        sourceElementGUID - unique identifier of the source
        destinationElementGUID - unique identifier of the destination
        properties - unique identifier for this relationship along with description and/or additional relevant properties
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • getDestinationLineageMappings

        public java.util.List<LineageMappingElement> getDestinationLineageMappings​(java.lang.String sourceElementGUID,
                                                                                   int startFrom,
                                                                                   int pageSize,
                                                                                   java.util.Date effectiveTime)
                                                                            throws InvalidParameterException,
                                                                                   UserNotAuthorizedException,
                                                                                   PropertyServerException
        Retrieve the lineage mapping relationships linked from a specific source element to its destinations.
        Parameters:
        sourceElementGUID - unique identifier of the source
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        Returns:
        list of lineage mapping relationships
        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)
      • getSourceLineageMappings

        public java.util.List<LineageMappingElement> getSourceLineageMappings​(java.lang.String destinationElementGUID,
                                                                              int startFrom,
                                                                              int pageSize,
                                                                              java.util.Date effectiveTime)
                                                                       throws InvalidParameterException,
                                                                              UserNotAuthorizedException,
                                                                              PropertyServerException
        Retrieve the lineage mapping relationships linked from a specific destination element to its sources.
        Parameters:
        destinationElementGUID - unique identifier of the destination
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - optional date for effective time of the query. Null means any effective time
        Returns:
        list of lineage mapping relationships
        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)
      • addMementoClassification

        public void addMementoClassification​(java.lang.String elementGUID,
                                             java.lang.String elementExternalIdentifier,
                                             java.util.Date effectiveTime)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException
        Classify the element with the Memento classification to indicate that it has been logically deleted for by lineage requests.
        Parameters:
        elementGUID - unique identifier of the metadata element to update
        elementExternalIdentifier - unique identifier of the element in the external asset manager
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • clearMementoClassification

        public void clearMementoClassification​(java.lang.String elementGUID,
                                               java.lang.String elementExternalIdentifier,
                                               java.util.Date effectiveTime)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException
        Remove the memento designation from the element.
        Parameters:
        elementGUID - unique identifier of the metadata element to update
        elementExternalIdentifier - unique identifier of the element in the external asset manager
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • addIncompleteClassification

        public void addIncompleteClassification​(java.lang.String elementGUID,
                                                java.lang.String elementExternalIdentifier,
                                                java.util.Date effectiveTime)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException
        Classify the element with the Incomplete classification to indicate that it has more details to come.
        Parameters:
        elementGUID - unique identifier of the metadata element to update
        elementExternalIdentifier - unique identifier of the element in the external asset manager
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • clearIncompleteClassification

        public void clearIncompleteClassification​(java.lang.String elementGUID,
                                                  java.lang.String elementExternalIdentifier,
                                                  java.util.Date effectiveTime)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException
        Remove the Incomplete designation from the element.
        Parameters:
        elementGUID - unique identifier of the metadata element to update
        elementExternalIdentifier - unique identifier of the element in the external asset manager
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)