Package org.odpi.openmetadata.integrationservices.catalog.connector

Class LineageExchangeService

java.lang.Object
org.odpi.openmetadata.integrationservices.catalog.connector.SchemaExchangeService
org.odpi.openmetadata.integrationservices.catalog.connector.LineageExchangeService
public class LineageExchangeService extends SchemaExchangeService
LineageExchangeService is the context for managing process definitions and lineage linkage.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clearBusinessSignificant(String elementGUID, String elementExternalIdentifier, Date effectiveTime)
    Remove the "BusinessSignificant" designation from the element.
    void
    clearControlFlow(String assetManagerGUID, String assetManagerName, String controlFlowGUID, Date effectiveTime)
    Remove the control flow relationship between two elements.
    void
    clearDataFlow(String dataFlowGUID, Date effectiveTime)
    Remove the data flow relationship between two elements.
    void
    clearLineageMapping(String lineageMappingGUID, Date effectiveTime)
    Remove the lineage mapping between two elements.
    void
    clearPortDelegation(String portOneGUID, String portTwoGUID, Date effectiveTime)
    Remove the port delegation relationship between two ports.
    void
    clearPortSchemaType(String portGUID, String schemaTypeGUID, Date effectiveTime)
    Remove the schema type from a port.
    void
    clearProcessCall(String processCallGUID, Date effectiveTime)
    Remove the process call relationship.
    void
    clearProcessParent(String parentProcessGUID, String childProcessGUID, Date effectiveTime)
    Remove a parent-child relationship between two processes.
    void
    clearProcessPort(String processGUID, String portGUID, Date effectiveTime)
    Unlink a port from a process.
    String
    createPort(boolean assetManagerIsHome, String processGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalIdentifierProperties externalIdentifierProperties, org.odpi.openmetadata.accessservices.assetmanager.properties.PortProperties portProperties, Date effectiveTime)
    Create a new metadata element to represent a port.
    String
    createProcess(boolean assetManagerIsHome, org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalIdentifierProperties externalIdentifierProperties, org.odpi.openmetadata.accessservices.assetmanager.properties.ProcessProperties processProperties, org.odpi.openmetadata.accessservices.assetmanager.properties.ProcessStatus initialStatus)
    Create a new metadata element to represent a process.
    String
    createProcessFromTemplate(boolean assetManagerIsHome, String templateGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalIdentifierProperties externalIdentifierProperties, org.odpi.openmetadata.accessservices.assetmanager.properties.TemplateProperties templateProperties)
    Create a new metadata element to represent a process using an existing metadata element as a template.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.PortElement>
    findPorts(String searchString, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the list of port metadata elements that contain the search string.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ProcessElement>
    findProcesses(String searchString, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the list of process metadata elements that contain the search string.
    org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ControlFlowElement
    getControlFlow(String currentStepGUID, String nextStepGUID, String qualifiedName, Date effectiveTime)
    Retrieve the control flow relationship between two elements.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ControlFlowElement>
    getControlFlowNextSteps(String currentStepGUID, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the control relationships linked from a specific element to the possible next elements in the process.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ControlFlowElement>
    getControlFlowPreviousSteps(String currentStepGUID, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the control relationships linked from a specific element to the possible previous elements in the process.
    org.odpi.openmetadata.accessservices.assetmanager.metadataelements.DataFlowElement
    getDataFlow(String dataSupplierGUID, String dataConsumerGUID, String qualifiedName, Date effectiveTime)
    Retrieve the data flow relationship between two elements.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.DataFlowElement>
    getDataFlowConsumers(String dataSupplierGUID, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the data flow relationships linked from a specific element to the downstream consumers.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.DataFlowElement>
    getDataFlowSuppliers(String dataConsumerGUID, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the data flow relationships linked from a specific element to the upstream suppliers.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.LineageMappingElement>
    getDestinationLineageMappings(String sourceElementGUID, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the lineage mapping relationships linked from a specific source element to its destinations.
    org.odpi.openmetadata.accessservices.assetmanager.metadataelements.LineageMappingElement
    getLineageMapping(String userId, String assetManagerGUID, String assetManagerName, String sourceElementGUID, String destinationElementGUID, String qualifiedName, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Retrieve the relationship between two elements.
    org.odpi.openmetadata.accessservices.assetmanager.metadataelements.PortElement
    getPortByGUID(String portGUID, Date effectiveTime)
    Retrieve the port metadata element with the supplied unique identifier.
    org.odpi.openmetadata.accessservices.assetmanager.metadataelements.PortElement
    getPortDelegation(String portGUID, Date effectiveTime)
    Retrieve the port that this port delegates to.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.PortElement>
    getPortsByName(String name, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the list of port metadata elements with a matching qualified or display name.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.PortElement>
    getPortsForProcess(String processGUID, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the list of ports associated with a process.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.PortElement>
    getPortUse(String portGUID, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the list of ports that delegate to this port.
    org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ProcessElement
    getProcessByGUID(String processGUID, Date effectiveTime)
    Retrieve the process metadata element with the supplied unique identifier.
    org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ProcessCallElement
    getProcessCall(String callerGUID, String calledGUID, String qualifiedName, Date effectiveTime)
    Retrieve the process call relationship between two elements.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ProcessCallElement>
    getProcessCalled(String callerGUID, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the process call relationships linked from a specific element to the elements it calls.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ProcessCallElement>
    getProcessCallers(String calledGUID, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the process call relationships linked from a specific element to its callers.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ProcessElement>
    getProcessesByName(String name, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the list of process metadata elements with a matching qualified or display name.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ProcessElement>
    getProcessesForAssetManager(int startFrom, int pageSize, Date effectiveTime)
    Return the list of processes associated with the asset manager.
    org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ProcessElement
    getProcessParent(String assetManagerGUID, String assetManagerName, String processGUID, Date effectiveTime)
    Retrieve the process metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.LineageMappingElement>
    getSourceLineageMappings(String destinationElementGUID, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the lineage mapping relationships linked from a specific destination element to its sources.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ProcessElement>
    getSubProcesses(String processGUID, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the process metadata element with the supplied unique identifier.
    void
    publishProcess(String processGUID, Date effectiveTime)
    Update the zones for the asset so that it becomes visible to consumers.
    void
    removePort(String portGUID, String portExternalIdentifier, Date effectiveTime)
    Remove the metadata element representing a port.
    void
    removeProcess(String processGUID, String processExternalIdentifier, Date effectiveTime)
    Remove the metadata element representing a process.
    void
    setBusinessSignificant(String elementGUID, String elementExternalIdentifier, Date effectiveTime)
    Classify a port, process or asset as "BusinessSignificant" (this may affect the way that lineage is displayed).
    String
    setupControlFlow(boolean assetManagerIsHome, String currentStepGUID, String nextStepGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ControlFlowProperties properties, Date effectiveTime)
    Link two elements to show that when one completes the next is started.
    String
    setupDataFlow(boolean assetManagerIsHome, String dataSupplierGUID, String dataConsumerGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.DataFlowProperties properties, Date effectiveTime)
    Link two elements together to show that data flows from one to the other.
    void
    setupLineageMapping(String sourceElementGUID, String destinationElementGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.LineageMappingProperties properties, 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, String portOneGUID, String portTwoGUID, Date effectiveTime)
    Link two ports together to show that portTwo is an implementation of portOne.
    void
    setupPortSchemaType(boolean assetManagerIsHome, String portGUID, String schemaTypeGUID, Date effectiveTime)
    Link a schema type to a port to show the structure of data it accepts.
    String
    setupProcessCall(boolean assetManagerIsHome, String callerGUID, String calledGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ProcessCallProperties properties, Date effectiveTime)
    Link two elements together to show a request-response call between them.
    void
    setupProcessParent(boolean assetManagerIsHome, String parentProcessGUID, String childProcessGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ProcessContainmentProperties containmentProperties, Date effectiveTime)
    Create a parent-child relationship between two processes.
    void
    setupProcessPort(boolean assetManagerIsHome, String processGUID, String portGUID, Date effectiveTime)
    Link a port to a process.
    void
    updateControlFlow(String controlFlowGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ControlFlowProperties properties, Date effectiveTime)
    Update the relationship between two elements that shows that when one completes the next is started.
    void
    updateDataFlow(String dataFlowGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.DataFlowProperties properties, Date effectiveTime)
    Update relationship between two elements that shows that data flows from one to the other.
    void
    updateLineageMapping(String lineageMappingGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.LineageMappingProperties properties, Date effectiveTime)
    Update the lineage mapping relationship between two elements.
    void
    updatePort(String portGUID, String portExternalIdentifier, org.odpi.openmetadata.accessservices.assetmanager.properties.PortProperties portProperties, Date effectiveTime)
    Update the properties of the metadata element representing a port.
    void
    updateProcess(String processGUID, String processExternalIdentifier, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetmanager.properties.ProcessProperties processProperties, Date effectiveTime)
    Update the metadata element representing a process.
    void
    updateProcessCall(String processCallGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ProcessCallProperties properties, Date effectiveTime)
    Update the relationship between two elements that shows a request-response call between them.
    void
    updateProcessStatus(String processGUID, String processExternalIdentifier, org.odpi.openmetadata.accessservices.assetmanager.properties.ProcessStatus processStatus, Date effectiveTime)
    Update the status of the metadata element representing a process.
    void
    withdrawProcess(String processGUID, Date effectiveTime)
    Update the zones for the asset so that it is no longer visible to consumers.

    Methods inherited from class org.odpi.openmetadata.integrationservices.catalog.connector.SchemaExchangeService

    clearColumnAsPrimaryKey, clearForeignKeyRelationship, clearSchemaElementAsCalculatedValue, clearSchemaElementRelationship, clearSchemaTypeParent, createSchemaAttribute, createSchemaAttributeFromTemplate, createSchemaType, createSchemaTypeFromTemplate, findSchemaAttributes, findSchemaType, getNestedAttributes, getSchemaAttributeByGUID, getSchemaAttributesByName, getSchemaTypeByGUID, getSchemaTypeByName, getSchemaTypeForElement, getSchemaTypeParent, isForDuplicateProcessing, isForLineage, removeSchemaAttribute, removeSchemaType, setForDuplicateProcessing, setForLineage, setSchemaElementAsCalculatedValue, setupColumnAsPrimaryKey, setupForeignKeyRelationship, setupSchemaElementRelationship, setupSchemaTypeParent, updateForeignKeyRelationship, updateSchemaAttribute, updateSchemaType

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • createProcess

      public String createProcess(boolean assetManagerIsHome, org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalIdentifierProperties externalIdentifierProperties, org.odpi.openmetadata.accessservices.assetmanager.properties.ProcessProperties processProperties, org.odpi.openmetadata.accessservices.assetmanager.properties.ProcessStatus initialStatus) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent a process.
      Parameters:
      assetManagerIsHome - ensure that only the asset manager can update this process
      externalIdentifierProperties - optional properties used to define an external identifier
      processProperties - properties about the process to store
      initialStatus - status value for the new process (default = ACTIVE)
      Returns:
      unique identifier of the new process
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createProcessFromTemplate

      public String createProcessFromTemplate(boolean assetManagerIsHome, String templateGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalIdentifierProperties externalIdentifierProperties, org.odpi.openmetadata.accessservices.assetmanager.properties.TemplateProperties templateProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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
      externalIdentifierProperties - optional properties used to define an external identifier
      templateProperties - properties that override the template
      Returns:
      unique identifier of the new process
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateProcess

      public void updateProcess(String processGUID, String processExternalIdentifier, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetmanager.properties.ProcessProperties processProperties, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the metadata element representing a process.
      Parameters:
      processGUID - unique identifier of the metadata element to update
      processExternalIdentifier - unique identifier of the process in the external asset manager
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateProcessStatus

      public void updateProcessStatus(String processGUID, String processExternalIdentifier, org.odpi.openmetadata.accessservices.assetmanager.properties.ProcessStatus processStatus, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the status of the metadata element representing a process.
      Parameters:
      processGUID - unique identifier of the process to update
      processExternalIdentifier - unique identifier of the process in the external asset manager
      processStatus - new status for the process
      effectiveTime - optional date for effective time of the query. Null means any effective time
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupProcessParent

      public void setupProcessParent(boolean assetManagerIsHome, String parentProcessGUID, String childProcessGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ProcessContainmentProperties containmentProperties, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a parent-child relationship between two processes.
      Parameters:
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearProcessParent

      public void clearProcessParent(String parentProcessGUID, String childProcessGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • publishProcess

      public void publishProcess(String processGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      effectiveTime - optional date for effective time of the query. Null means any effective time
      processGUID - unique identifier of the metadata element to publish
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • withdrawProcess

      public void withdrawProcess(String processGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeProcess

      public void removeProcess(String processGUID, String processExternalIdentifier, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • findProcesses

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ProcessElement> findProcesses(String searchString, int startFrom, int pageSize, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getProcessesForAssetManager

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ProcessElement> getProcessesForAssetManager(int startFrom, int pageSize, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getProcessesByName

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ProcessElement> getProcessesByName(String name, int startFrom, int pageSize, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getProcessByGUID

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ProcessElement getProcessByGUID(String processGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the process metadata element with the supplied unique identifier.
      Parameters:
      processGUID - unique identifier of the requested metadata element
      effectiveTime - optional date for effective time of the query. Null means any effective time
      Returns:
      requested metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getProcessParent

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ProcessElement getProcessParent(String assetManagerGUID, String assetManagerName, String processGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the process metadata element with the supplied unique identifier.
      Parameters:
      assetManagerGUID - unique identifier of software server capability representing the caller
      assetManagerName - unique name of software server capability representing the caller
      processGUID - unique identifier of the requested metadata element
      effectiveTime - optional date for effective time of the query. Null means any effective time
      Returns:
      parent process element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getSubProcesses

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ProcessElement> getSubProcesses(String processGUID, int startFrom, int pageSize, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createPort

      public String createPort(boolean assetManagerIsHome, String processGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalIdentifierProperties externalIdentifierProperties, org.odpi.openmetadata.accessservices.assetmanager.properties.PortProperties portProperties, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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
      externalIdentifierProperties - optional properties used to define an external identifier
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updatePort

      public void updatePort(String portGUID, String portExternalIdentifier, org.odpi.openmetadata.accessservices.assetmanager.properties.PortProperties portProperties, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the properties of the metadata element representing a port. This call replaces all existing properties with the supplied properties.
      Parameters:
      portGUID - unique identifier of the port to update
      portProperties - new properties for the port
      portExternalIdentifier - unique identifier of the port in the external asset manager
      effectiveTime - optional date for effective time of the query. Null means any effective time
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupProcessPort

      public void setupProcessPort(boolean assetManagerIsHome, String processGUID, String portGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearProcessPort

      public void clearProcessPort(String processGUID, String portGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Unlink a port from a process.
      Parameters:
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupPortDelegation

      public void setupPortDelegation(boolean assetManagerIsHome, String portOneGUID, String portTwoGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearPortDelegation

      public void clearPortDelegation(String portOneGUID, String portTwoGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the port delegation relationship between two ports.
      Parameters:
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupPortSchemaType

      public void setupPortSchemaType(boolean assetManagerIsHome, String portGUID, String schemaTypeGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearPortSchemaType

      public void clearPortSchemaType(String portGUID, String schemaTypeGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the schema type from a port.
      Parameters:
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • removePort

      public void removePort(String portGUID, String portExternalIdentifier, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the metadata element representing a port.
      Parameters:
      portGUID - unique identifier of the metadata element to remove
      portExternalIdentifier - unique identifier of the port in the external asset manager
      effectiveTime - optional date for effective time of the query. Null means any effective time
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • findPorts

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.PortElement> findPorts(String searchString, int startFrom, int pageSize, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getPortsForProcess

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.PortElement> getPortsForProcess(String processGUID, int startFrom, int pageSize, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getPortUse

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.PortElement> getPortUse(String portGUID, int startFrom, int pageSize, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getPortDelegation

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.PortElement getPortDelegation(String portGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the port that this port delegates to.
      Parameters:
      portGUID - unique identifier of the starting port alias
      effectiveTime - optional date for effective time of the query. Null means any effective time
      Returns:
      matching metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getPortsByName

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.PortElement> getPortsByName(String name, int startFrom, int pageSize, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getPortByGUID

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.PortElement getPortByGUID(String portGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the port metadata element with the supplied unique identifier.
      Parameters:
      portGUID - unique identifier of the requested metadata element
      effectiveTime - optional date for effective time of the query. Null means any effective time
      Returns:
      matching metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setBusinessSignificant

      public void setBusinessSignificant(String elementGUID, String elementExternalIdentifier, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Classify a port, process or asset as "BusinessSignificant" (this may affect the way that lineage is displayed).
      Parameters:
      elementGUID - unique identifier of the metadata element to update
      elementExternalIdentifier - unique identifier of the port in the external asset manager
      effectiveTime - optional date for effective time of the query. Null means any effective time
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearBusinessSignificant

      public void clearBusinessSignificant(String elementGUID, String elementExternalIdentifier, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the "BusinessSignificant" 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 (can be null)
      effectiveTime - optional date for effective time of the query. Null means any effective time
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupDataFlow

      public String setupDataFlow(boolean assetManagerIsHome, String dataSupplierGUID, String dataConsumerGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.DataFlowProperties properties, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getDataFlow

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.DataFlowElement getDataFlow(String dataSupplierGUID, String dataConsumerGUID, String qualifiedName, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateDataFlow

      public void updateDataFlow(String dataFlowGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.DataFlowProperties properties, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearDataFlow

      public void clearDataFlow(String dataFlowGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the data flow relationship between two elements.
      Parameters:
      dataFlowGUID - unique identifier of the data flow relationship
      effectiveTime - optional date for effective time of the query. Null means any effective time
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getDataFlowConsumers

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.DataFlowElement> getDataFlowConsumers(String dataSupplierGUID, int startFrom, int pageSize, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getDataFlowSuppliers

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.DataFlowElement> getDataFlowSuppliers(String dataConsumerGUID, int startFrom, int pageSize, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupControlFlow

      public String setupControlFlow(boolean assetManagerIsHome, String currentStepGUID, String nextStepGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ControlFlowProperties properties, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getControlFlow

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ControlFlowElement getControlFlow(String currentStepGUID, String nextStepGUID, String qualifiedName, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateControlFlow

      public void updateControlFlow(String controlFlowGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ControlFlowProperties properties, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearControlFlow

      public void clearControlFlow(String assetManagerGUID, String assetManagerName, String controlFlowGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the control flow relationship between two elements.
      Parameters:
      assetManagerGUID - unique identifier of software server capability representing the caller
      assetManagerName - unique name of software server capability representing the caller
      controlFlowGUID - unique identifier of the control flow relationship
      effectiveTime - optional date for effective time of the query. Null means any effective time
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getControlFlowNextSteps

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ControlFlowElement> getControlFlowNextSteps(String currentStepGUID, int startFrom, int pageSize, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getControlFlowPreviousSteps

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ControlFlowElement> getControlFlowPreviousSteps(String currentStepGUID, int startFrom, int pageSize, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupProcessCall

      public String setupProcessCall(boolean assetManagerIsHome, String callerGUID, String calledGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ProcessCallProperties properties, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getProcessCall

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ProcessCallElement getProcessCall(String callerGUID, String calledGUID, String qualifiedName, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateProcessCall

      public void updateProcessCall(String processCallGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ProcessCallProperties properties, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearProcessCall

      public void clearProcessCall(String processCallGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the process call relationship.
      Parameters:
      processCallGUID - unique identifier of the process call relationship
      effectiveTime - optional date for effective time of the query. Null means any effective time
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getProcessCalled

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ProcessCallElement> getProcessCalled(String callerGUID, int startFrom, int pageSize, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getProcessCallers

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ProcessCallElement> getProcessCallers(String calledGUID, int startFrom, int pageSize, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupLineageMapping

      public void setupLineageMapping(String sourceElementGUID, String destinationElementGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.LineageMappingProperties properties, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getLineageMapping

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.LineageMappingElement getLineageMapping(String userId, String assetManagerGUID, String assetManagerName, String sourceElementGUID, String destinationElementGUID, String qualifiedName, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the relationship between two elements. The qualifiedName is optional unless there is more than one relationship between these two elements since it is used to disambiguate the request. This is often used in conjunction with update.
      Parameters:
      userId - calling user
      assetManagerGUID - unique identifier of software server capability representing the caller
      assetManagerName - unique name of software server capability representing the caller
      sourceElementGUID - unique identifier of the element that is making the call
      destinationElementGUID - 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
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      Returns:
      unique identifier and properties of the relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateLineageMapping

      public void updateLineageMapping(String lineageMappingGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.LineageMappingProperties properties, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the lineage mapping relationship between two elements.
      Parameters:
      lineageMappingGUID - unique identifier of the lineage mapping 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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearLineageMapping

      public void clearLineageMapping(String lineageMappingGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the lineage mapping between two elements.
      Parameters:
      lineageMappingGUID - unique identifier of the source
      effectiveTime - optional date for effective time of the query. Null means any effective time
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getDestinationLineageMappings

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.LineageMappingElement> getDestinationLineageMappings(String sourceElementGUID, int startFrom, int pageSize, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getSourceLineageMappings

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.LineageMappingElement> getSourceLineageMappings(String destinationElementGUID, int startFrom, int pageSize, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)