Package org.odpi.openmetadata.integrationservices.lineage.connector

Class LineageIntegratorContext

java.lang.Object
org.odpi.openmetadata.frameworks.integration.context.IntegrationContext
org.odpi.openmetadata.integrationservices.lineage.connector.LineageIntegratorContext
All Implemented Interfaces:
OpenLineageListenerManager
public class LineageIntegratorContext extends org.odpi.openmetadata.frameworks.integration.context.IntegrationContext implements OpenLineageListenerManager
LineageIntegratorContext provides a wrapper around the Asset Manager OMAS client. It provides the simplified interface to open metadata needed by the LineageIntegratorConnector.

  • Constructor Summary

    Constructors
    Constructor
    Description
    LineageIntegratorContext(String connectorId, String connectorName, String connectorUserId, String serverName, org.odpi.openmetadata.frameworks.integration.client.OpenIntegrationClient openIntegrationClient, org.odpi.openmetadata.frameworks.governanceaction.client.OpenMetadataClient openMetadataStoreClient, OpenLineageListenerManager openLineageListenerManager, org.odpi.openmetadata.accessservices.assetmanager.client.exchange.DataAssetExchangeClient dataAssetExchangeClient, org.odpi.openmetadata.accessservices.assetmanager.client.exchange.LineageExchangeClient lineageExchangeClient, org.odpi.openmetadata.accessservices.assetmanager.client.exchange.GovernanceExchangeClient governanceExchangeClient, org.odpi.openmetadata.accessservices.assetmanager.client.AssetManagerEventClient eventClient, boolean generateIntegrationReport, org.odpi.openmetadata.frameworks.integration.contextmanager.PermittedSynchronization permittedSynchronization, String integrationConnectorGUID, String externalSourceGUID, String externalSourceName, String integrationServiceName, int maxPageSize, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Create a new context for a connector.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addIncompleteClassification(String elementGUID, String elementExternalIdentifier, Date effectiveTime)
    Classify the element with the Incomplete classification to indicate that it has more details to come.
    void
    addMementoClassification(String elementGUID, String elementExternalIdentifier, Date effectiveTime)
    Classify the element with the Memento classification to indicate that it has been logically deleted for by lineage requests.
    void
    clearAssetRelationship(String relationshipTypeName, String relationshipGUID, Date effectiveTime)
    Remove the relationship between two elements.
    void
    clearBusinessSignificant(String elementGUID, Date effectiveTime)
    Remove the "BusinessSignificant" designation from the element.
    void
    clearColumnAsPrimaryKey(String schemaAttributeGUID, Date effectiveTime)
    Remove the primary key designation from the schema attribute.
    void
    clearControlFlow(String controlFlowGUID, Date effectiveTime)
    Remove the control flow relationship between two elements.
    void
    clearDataAssetAsReferenceData(String assetGUID, Date effectiveTime)
    Remove the reference data designation from the asset.
    void
    clearDataFlow(String dataFlowGUID, Date effectiveTime)
    Remove the data flow relationship between two elements.
    void
    clearForeignKeyRelationship(String primaryKeyGUID, String foreignKeyGUID, Date effectiveTime)
    Remove the foreign key relationship between two schema elements.
    void
    clearIncompleteClassification(String elementGUID, String elementExternalIdentifier, Date effectiveTime)
    Remove the Incomplete designation from the element.
    void
    clearLineageMapping(String lineageMappingGUID, Date effectiveTime)
    Remove the lineage mapping between two elements.
    void
    clearMementoClassification(String elementGUID, String elementExternalIdentifier, Date effectiveTime)
    Remove the memento designation from the element.
    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.
    void
    clearSchemaElementAsCalculatedValue(String schemaElementGUID, Date effectiveTime)
    Remove the calculated value designation from the schema element.
    void
    clearSchemaElementRelationship(String endOneGUID, String endTwoGUID, String relationshipName, Date effectiveTime)
    Remove a relationship between two schema elements.
    void
    clearSchemaTypeParent(String schemaTypeGUID, String parentElementGUID, String parentElementTypeName, Date effectiveTime)
    Remove the relationship between a schema type and its parent data asset, process or port.
    String
    createAnchoredSchemaType(boolean assetManagerIsHome, String anchorGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalIdentifierProperties externalIdentifierProperties, org.odpi.openmetadata.accessservices.assetmanager.properties.SchemaTypeProperties schemaTypeProperties)
    Create a new metadata element to represent a schema type.
    String
    createDataAsset(boolean assetManagerIsHome, org.odpi.openmetadata.accessservices.assetmanager.properties.DataAssetProperties assetProperties)
    Create a new metadata element to represent the root of a data asset.
    String
    createDataAssetFromTemplate(boolean assetManagerIsHome, String templateGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.TemplateProperties templateProperties)
    Create a new metadata element to represent an asset using an existing metadata element as a template.
    String
    createPort(boolean assetManagerIsHome, String processGUID, 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.ProcessStatus processStatus, org.odpi.openmetadata.accessservices.assetmanager.properties.ProcessProperties processProperties)
    Create a new metadata element to represent a process.
    String
    createProcessFromTemplate(boolean assetManagerIsHome, String templateGUID, 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.
    String
    createSchemaAttribute(boolean assetManagerIsHome, String schemaElementGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.SchemaAttributeProperties schemaAttributeProperties, Date effectiveTime)
    Create a new metadata element to represent a schema attribute.
    String
    createSchemaAttributeFromTemplate(boolean assetManagerIsHome, String schemaElementGUID, String templateGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.TemplateProperties templateProperties, Date effectiveTime)
    Create a new metadata element to represent a schema attribute using an existing metadata element as a template.
    String
    createSchemaType(boolean assetManagerIsHome, org.odpi.openmetadata.accessservices.assetmanager.properties.SchemaTypeProperties schemaTypeProperties)
    Create a new metadata element to represent a schema type.
    String
    createSchemaTypeFromTemplate(boolean assetManagerIsHome, String templateGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.TemplateProperties templateProperties)
    Create a new metadata element to represent a schema type using an existing metadata element as a template.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.DataAssetElement>
    findDataAssets(String searchString, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the list of data asset metadata elements that contain the search string.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GovernanceActionProcessElement>
    findGovernanceActionProcesses(String searchString, int startFrom, int pageSize)
    Retrieve the list of governance action process metadata elements that contain the search string.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GovernanceActionTypeElement>
    findGovernanceActionTypes(String searchString, int startFrom, int pageSize)
    Retrieve the list of governance action type metadata elements that contain the search string.
    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.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.SchemaAttributeElement>
    findSchemaAttributes(String searchString, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the list of schema attribute metadata elements that contain the search string.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.SchemaTypeElement>
    findSchemaType(String searchString, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the list of schema type metadata elements that contain the search string.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GovernanceActionElement>
    getActiveGovernanceActions(int startFrom, int pageSize)
    Retrieve the governance actions that are still in process.
    org.odpi.openmetadata.accessservices.assetmanager.metadataelements.RelationshipElement
    getAssetRelationship(String relationshipTypeName, String fromAssetGUID, String toAssetGUID, Date effectiveTime)
    Retrieve the relationship between two elements.
    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.DataAssetElement
    getDataAssetByGUID(String openMetadataGUID, Date effectiveTime)
    Retrieve the asset metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.DataAssetElement>
    getDataAssetsByName(String name, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the list of data asset metadata elements with a matching qualified or display name.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.DataAssetElement>
    getDataAssetsForAssetManager(int startFrom, int pageSize, Date effectiveTime)
    Retrieve the list of assets created on behalf of this asset manager.
    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.GovernanceActionTypeElement
    getFirstActionType(String processGUID)
    Return the governance action type that is the first step in a governance action process.
    org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GovernanceActionElement
    getGovernanceAction(String governanceActionGUID)
    Request the status of an executing governance action request.
    org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GovernanceActionProcessElement
    getGovernanceActionProcessByGUID(String processGUID)
    Retrieve the governance action process metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GovernanceActionProcessElement>
    getGovernanceActionProcessesByName(String name, int startFrom, int pageSize)
    Retrieve the list of governance action process metadata elements with a matching qualified or display name.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GovernanceActionElement>
    getGovernanceActions(int startFrom, int pageSize)
    Retrieve the governance actions known to the server.
    org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GovernanceActionTypeElement
    getGovernanceActionTypeByGUID(String actionTypeGUID)
    Retrieve the governance action type metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GovernanceActionTypeElement>
    getGovernanceActionTypesByName(String name, int startFrom, int pageSize)
    Retrieve the list of governance action type metadata elements with a matching qualified or display name.
    String
    getIntegrationServiceName()
    Return the qualified name of the integration services that is supplied in the configuration document.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.SchemaAttributeElement>
    getNestedSchemaAttributes(String parentSchemaElementGUID, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the list of schema attributes associated with a schema element.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.NextGovernanceActionTypeElement>
    getNextGovernanceActionTypes(String actionTypeGUID, int startFrom, int pageSize)
    Return the lust of next action type defined for the governance action process.
    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 processGUID, Date effectiveTime)
    Retrieve the process metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.RelationshipElement>
    getRelatedAssetsAtEnd1(String relationshipTypeName, String toAssetGUID, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the relationships linked from a specific element at end 2 of the relationship.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.RelationshipElement>
    getRelatedAssetsAtEnd2(String relationshipTypeName, String fromAssetGUID, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the requested relationships linked from a specific element at end 2.
    org.odpi.openmetadata.accessservices.assetmanager.metadataelements.SchemaAttributeElement
    getSchemaAttributeByGUID(String schemaAttributeGUID, Date effectiveTime)
    Retrieve the schema attribute metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.SchemaAttributeElement>
    getSchemaAttributesByName(String name, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the list of schema attribute metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.accessservices.assetmanager.metadataelements.SchemaTypeElement
    getSchemaTypeByGUID(String schemaTypeGUID, Date effectiveTime)
    Retrieve the schema type metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.SchemaTypeElement>
    getSchemaTypeByName(String name, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the list of schema type metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.accessservices.assetmanager.metadataelements.SchemaTypeElement
    getSchemaTypeForElement(String parentElementGUID, String parentElementTypeName, Date effectiveTime)
    Return the schema type associated with a specific open metadata element (data asset, process or port).
    org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader
    getSchemaTypeParent(String schemaTypeGUID, Date effectiveTime)
    Retrieve the header of the metadata element connected to a schema type.
    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.
    boolean
    isForLineage()
    Return whether retrieval requests from this service are to include elements with the Memento classification attached or not.
    void
    publishDataAsset(String assetGUID, Date effectiveTime)
    Update the zones for the data asset so that it becomes visible to consumers.
    void
    publishOpenLineageRunEvent(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(String processGUID, Date effectiveTime)
    Update the zones for the asset so that it becomes visible to consumers.
    void
    registerListener(org.odpi.openmetadata.accessservices.assetmanager.api.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(String assetGUID, Date effectiveTime)
    Remove the metadata element representing a data asset.
    void
    removePort(String portGUID, 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
    removeSchemaAttribute(String schemaAttributeGUID, Date effectiveTime)
    Remove the metadata element representing a schema attribute.
    void
    removeSchemaType(String schemaTypeGUID, Date effectiveTime)
    Remove the metadata element representing a schema type.
    void
    setBusinessSignificant(String elementGUID, Date effectiveTime)
    Classify a port, process or asset as "BusinessSignificant" (this may affect the way that lineage is displayed).
    void
    setDataAssetAsReferenceData(String assetGUID, 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, String schemaElementGUID, String formula, Date effectiveTime)
    Classify the schema type (or attribute if type is embedded) to indicate that it is a calculated value.
    void
    setupColumnAsPrimaryKey(boolean assetManagerIsHome, String schemaAttributeGUID, String schemaAttributeExternalIdentifier, String primaryKeyName, org.odpi.openmetadata.accessservices.assetmanager.properties.KeyPattern primaryKeyPattern, Date effectiveTime)
    Classify the column schema attribute to indicate that it describes a primary key.
    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
    setupForeignKeyRelationship(boolean assetManagerIsHome, String primaryKeyGUID, String foreignKeyGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ForeignKeyProperties foreignKeyProperties, Date effectiveTime)
    Link two schema attributes together to show a foreign key relationship.
    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
    setupProcessParent(String userId, String externalSourceGUID, String externalSourceName, boolean assetManagerIsHome, String parentProcessGUID, String childProcessGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ProcessContainmentProperties containmentProperties, Date effectiveTime)
    Deprecated.
    void
    setupProcessPort(boolean assetManagerIsHome, String processGUID, String portGUID, Date effectiveTime)
    Link a port to a process.
    String
    setupRelatedDataAsset(boolean assetManagerIsHome, String relationshipTypeName, String fromAssetGUID, String toAssetGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.RelationshipProperties relationshipProperties, Date effectiveTime)
    Link two asset together.
    void
    setupSchemaElementRelationship(boolean assetManagerIsHome, String endOneGUID, String endTwoGUID, String relationshipName, Date effectiveTime, org.odpi.openmetadata.accessservices.assetmanager.properties.RelationshipProperties properties)
    Create a relationship between two schema elements.
    void
    setupSchemaTypeParent(boolean assetManagerIsHome, String schemaTypeGUID, String parentElementGUID, String parentElementTypeName, org.odpi.openmetadata.accessservices.assetmanager.properties.RelationshipProperties properties, Date effectiveTime)
    Connect a schema type to a data asset, process or port.
    void
    updateAssetRelationship(String relationshipTypeName, String relationshipGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetmanager.properties.RelationshipProperties relationshipProperties, Date effectiveTime)
    Update relationship between two elements.
    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
    updateDataAsset(String assetGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetmanager.properties.DataAssetProperties assetProperties, Date effectiveTime)
    Update the metadata element representing a data source.
    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
    updateForeignKeyRelationship(String primaryKeyGUID, String foreignKeyGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ForeignKeyProperties foreignKeyProperties, Date effectiveTime)
    Update the relationship properties for the query target.
    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, org.odpi.openmetadata.accessservices.assetmanager.properties.PortProperties portProperties, Date effectiveTime)
    Update the properties of the metadata element representing a port.
    void
    updateProcess(String processGUID, 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, org.odpi.openmetadata.accessservices.assetmanager.properties.ProcessStatus processStatus, Date effectiveTime)
    Update the status of the metadata element representing a process.
    void
    updateSchemaAttribute(String schemaAttributeGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetmanager.properties.SchemaAttributeProperties schemaAttributeProperties, Date effectiveTime)
    Update the properties of the metadata element representing a schema attribute.
    void
    updateSchemaType(String schemaTypeGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetmanager.properties.SchemaTypeProperties schemaTypeProperties, Date effectiveTime)
    Update the metadata element representing a schema type.
    void
    withdrawDataAsset(String assetGUID, Date effectiveTime)
    Update the zones for the data asset so that it is no longer visible to consumers.
    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.frameworks.integration.context.IntegrationContext

    getAnchorGUID, getCatalogTargets, getIntegrationGovernanceContext, getMaxPageSize, getMetadataSourceQualifiedName, getPermittedSynchronization, isTypeOf, publishReport, setActiveReportPublishing, startRecording

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • LineageIntegratorContext

      public LineageIntegratorContext(String connectorId, String connectorName, String connectorUserId, String serverName, org.odpi.openmetadata.frameworks.integration.client.OpenIntegrationClient openIntegrationClient, org.odpi.openmetadata.frameworks.governanceaction.client.OpenMetadataClient openMetadataStoreClient, OpenLineageListenerManager openLineageListenerManager, org.odpi.openmetadata.accessservices.assetmanager.client.exchange.DataAssetExchangeClient dataAssetExchangeClient, org.odpi.openmetadata.accessservices.assetmanager.client.exchange.LineageExchangeClient lineageExchangeClient, org.odpi.openmetadata.accessservices.assetmanager.client.exchange.GovernanceExchangeClient governanceExchangeClient, org.odpi.openmetadata.accessservices.assetmanager.client.AssetManagerEventClient eventClient, boolean generateIntegrationReport, org.odpi.openmetadata.frameworks.integration.contextmanager.PermittedSynchronization permittedSynchronization, String integrationConnectorGUID, String externalSourceGUID, String externalSourceName, String integrationServiceName, int maxPageSize, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
      Create a new context for a connector.
      Parameters:
      connectorId - unique identifier of the connector (used to configure the event listener)
      connectorName - name of connector from config
      connectorUserId - userId for the connector
      serverName - name of the integration daemon
      openIntegrationClient - client for calling the metadata server
      openMetadataStoreClient - client for calling the metadata server
      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
      eventClient - client managing listeners for the OMAS OutTopic
      generateIntegrationReport - should the connector generate an integration reports?
      permittedSynchronization - the direction of integration permitted by the integration connector
      integrationConnectorGUID - unique identifier for the integration connector if it is started via an integration group (otherwise it is null).
      externalSourceGUID - unique identifier of the software server capability for the asset manager
      externalSourceName - unique name of the software server capability for the asset manager
      integrationServiceName - name of this service
      maxPageSize - max number of elements that can be returned on a query
      auditLog - logging destination

  • Method Details

    • getIntegrationServiceName

      public 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(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

    • registerListener

      public void registerListener(org.odpi.openmetadata.accessservices.assetmanager.api.AssetManagerEventListener listener) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Register a listener object that will be passed each of the events published by the Asset Manager OMAS.
      Parameters:
      listener - listener object
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there are errors in the initialization of the connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • createDataAsset

      public String createDataAsset(boolean assetManagerIsHome, org.odpi.openmetadata.accessservices.assetmanager.properties.DataAssetProperties assetProperties) 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 the root of a data asset.
      Parameters:
      assetManagerIsHome - ensure that only the asset manager can update this asset
      assetProperties - properties to store
      Returns:
      unique identifier of the new 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)

    • createDataAssetFromTemplate

      public String createDataAssetFromTemplate(boolean assetManagerIsHome, String templateGUID, 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 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:
      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)

    • updateDataAsset

      public void updateDataAsset(String assetGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetmanager.properties.DataAssetProperties assetProperties, 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 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:
      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)

    • publishDataAsset

      public void publishDataAsset(String assetGUID, 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 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:
      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)

    • withdrawDataAsset

      public void withdrawDataAsset(String assetGUID, 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 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:
      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)

    • removeDataAsset

      public void removeDataAsset(String assetGUID, 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 data asset. This will delete the asset and all anchored elements such as schema and comments.
      Parameters:
      assetGUID - unique identifier of the metadata element to remove
      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)

    • setDataAssetAsReferenceData

      public void setDataAssetAsReferenceData(String assetGUID, 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 the data asset to indicate that it can be used as reference data.
      Parameters:
      assetGUID - unique identifier of the metadata element to update
      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)

    • clearDataAssetAsReferenceData

      public void clearDataAssetAsReferenceData(String assetGUID, 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 reference data designation from the asset.
      Parameters:
      assetGUID - unique identifier of the metadata element to update
      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)

    • setupRelatedDataAsset

      public String setupRelatedDataAsset(boolean assetManagerIsHome, String relationshipTypeName, String fromAssetGUID, String toAssetGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.RelationshipProperties relationshipProperties, 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 asset together. Use information from the relationship type definition to ensure the fromAssetGUID and toAssetGUID are the right way around.
      Parameters:
      assetManagerIsHome - ensure that only the process manager can update this process
      relationshipTypeName - type name of relationship to create
      fromAssetGUID - unique identifier of the asset at end 1 of the relationship
      toAssetGUID - unique identifier of the asset at end 2 of the relationship
      relationshipProperties - unique identifier for this relationship
      effectiveTime - optional date for effective time of the query. Null means any effective time
      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)

    • getAssetRelationship

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.RelationshipElement getAssetRelationship(String relationshipTypeName, String fromAssetGUID, String toAssetGUID, 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 relationship between two elements.
      Parameters:
      relationshipTypeName - type name of relationship to create
      fromAssetGUID - unique identifier of the asset at end 1 of the relationship
      toAssetGUID - unique identifier of the asset at end 2 of the relationship
      effectiveTime - optional date for effective time of the query. Null means any effective time
      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)

    • updateAssetRelationship

      public void updateAssetRelationship(String relationshipTypeName, String relationshipGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetmanager.properties.RelationshipProperties relationshipProperties, 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.
      Parameters:
      relationshipTypeName - type name of relationship to update
      relationshipGUID - unique identifier of the relationship
      relationshipProperties - description and/or purpose of the relationship
      isMergeUpdate - should the new properties be merged with the existing properties, or replace them entirely
      effectiveTime - optional date for effective time of the query. Null means any effective time
      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)

    • clearAssetRelationship

      public void clearAssetRelationship(String relationshipTypeName, String relationshipGUID, 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 relationship between two elements.
      Parameters:
      relationshipTypeName - type name of relationship to delete
      relationshipGUID - unique identifier of the relationship
      effectiveTime - optional date for effective time of the query. Null means any effective time
      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)

    • getRelatedAssetsAtEnd2

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.RelationshipElement> getRelatedAssetsAtEnd2(String relationshipTypeName, String fromAssetGUID, 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 requested relationships linked from a specific element at end 2.
      Parameters:
      relationshipTypeName - type name of relationship to delete
      fromAssetGUID - unique identifier of the asset at end 1 of the relationship
      startFrom - start position for results
      pageSize - maximum number of results
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      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)

    • getRelatedAssetsAtEnd1

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.RelationshipElement> getRelatedAssetsAtEnd1(String relationshipTypeName, String toAssetGUID, 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 relationships linked from a specific element at end 2 of the relationship.
      Parameters:
      relationshipTypeName - type name of relationship to delete
      toAssetGUID - unique identifier of the asset at end 2 of the relationship
      startFrom - start position for results
      pageSize - maximum number of results
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      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)

    • findDataAssets

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.DataAssetElement> findDataAssets(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 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:
      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)

    • getDataAssetsByName

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.DataAssetElement> getDataAssetsByName(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 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:
      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)

    • getDataAssetsForAssetManager

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.DataAssetElement> getDataAssetsForAssetManager(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 assets created on behalf of this 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 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)

    • getDataAssetByGUID

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.DataAssetElement getDataAssetByGUID(String openMetadataGUID, 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 asset metadata element with the supplied unique identifier.
      Parameters:
      openMetadataGUID - 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)

    • createSchemaType

      public String createSchemaType(boolean assetManagerIsHome, org.odpi.openmetadata.accessservices.assetmanager.properties.SchemaTypeProperties schemaTypeProperties) 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 schema type.
      Parameters:
      assetManagerIsHome - ensure that only the asset manager can update this schema element
      schemaTypeProperties - properties about the schema type to store
      Returns:
      unique identifier of the new schema type
      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)

    • createAnchoredSchemaType

      public String createAnchoredSchemaType(boolean assetManagerIsHome, String anchorGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalIdentifierProperties externalIdentifierProperties, org.odpi.openmetadata.accessservices.assetmanager.properties.SchemaTypeProperties schemaTypeProperties) 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 schema type.
      Parameters:
      assetManagerIsHome - ensure that only the asset manager can update this schema element
      anchorGUID - unique identifier of the intended anchor of the schema type
      externalIdentifierProperties - optional properties used to define an external identifier
      schemaTypeProperties - properties about the schema type to store
      Returns:
      unique identifier of the new schema type
      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)

    • createSchemaTypeFromTemplate

      public String createSchemaTypeFromTemplate(boolean assetManagerIsHome, String templateGUID, 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 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:
      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)

    • updateSchemaType

      public void updateSchemaType(String schemaTypeGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetmanager.properties.SchemaTypeProperties schemaTypeProperties, 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 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:
      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)

    • setupSchemaTypeParent

      public void setupSchemaTypeParent(boolean assetManagerIsHome, String schemaTypeGUID, String parentElementGUID, String parentElementTypeName, org.odpi.openmetadata.accessservices.assetmanager.properties.RelationshipProperties 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
      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:
      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)

    • clearSchemaTypeParent

      public void clearSchemaTypeParent(String schemaTypeGUID, String parentElementGUID, String parentElementTypeName, 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 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:
      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)

    • setupSchemaElementRelationship

      public void setupSchemaElementRelationship(boolean assetManagerIsHome, String endOneGUID, String endTwoGUID, String relationshipName, Date effectiveTime, org.odpi.openmetadata.accessservices.assetmanager.properties.RelationshipProperties properties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a relationship between two schema elements. The name of the desired relationship, and any properties (including effectivity dates) are passed on the API.
      Parameters:
      assetManagerIsHome - ensure that only the asset manager can update this relationship
      endOneGUID - unique identifier of the schema element at end one of the relationship
      endTwoGUID - unique identifier of the schema element at end two of the relationship
      relationshipName - name of the relationship to delete
      effectiveTime - optional date for effective time of the query. Null means any effective time
      properties - relationship properties
      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)

    • clearSchemaElementRelationship

      public void clearSchemaElementRelationship(String endOneGUID, String endTwoGUID, String relationshipName, 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 relationship between two schema elements. The name of the desired relationship is passed on the API.
      Parameters:
      endOneGUID - unique identifier of the schema element at end one of the relationship
      endTwoGUID - unique identifier of the schema element at end two of the relationship
      relationshipName - name of the relationship to delete
      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)

    • removeSchemaType

      public void removeSchemaType(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 metadata element representing a schema type.
      Parameters:
      schemaTypeGUID - unique identifier of the metadata element to remove
      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)

    • findSchemaType

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.SchemaTypeElement> findSchemaType(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 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:
      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)

    • getSchemaTypeForElement

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.SchemaTypeElement getSchemaTypeForElement(String parentElementGUID, String parentElementTypeName, 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 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:
      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)

    • getSchemaTypeByName

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.SchemaTypeElement> getSchemaTypeByName(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 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:
      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)

    • getSchemaTypeByGUID

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.SchemaTypeElement getSchemaTypeByGUID(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
      Retrieve the schema type metadata element with the supplied unique identifier.
      Parameters:
      schemaTypeGUID - 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)

    • getSchemaTypeParent

      public org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader getSchemaTypeParent(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
      Retrieve the header of the metadata element connected to a schema type.
      Parameters:
      schemaTypeGUID - unique identifier of the requested metadata element
      effectiveTime - optional date for effective time of the query. Null means any effective time
      Returns:
      header for parent element (data asset, process, 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)

    • createSchemaAttribute

      public String createSchemaAttribute(boolean assetManagerIsHome, String schemaElementGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.SchemaAttributeProperties schemaAttributeProperties, 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 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:
      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)

    • createSchemaAttributeFromTemplate

      public String createSchemaAttributeFromTemplate(boolean assetManagerIsHome, String schemaElementGUID, String templateGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.TemplateProperties templateProperties, 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 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:
      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)

    • updateSchemaAttribute

      public void updateSchemaAttribute(String schemaAttributeGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetmanager.properties.SchemaAttributeProperties schemaAttributeProperties, 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 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:
      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)

    • setSchemaElementAsCalculatedValue

      public void setSchemaElementAsCalculatedValue(boolean assetManagerIsHome, String schemaElementGUID, String formula, 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 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:
      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)

    • clearSchemaElementAsCalculatedValue

      public void clearSchemaElementAsCalculatedValue(String schemaElementGUID, 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 calculated value designation from the schema element.
      Parameters:
      schemaElementGUID - unique identifier of the metadata element to update
      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)

    • setupColumnAsPrimaryKey

      public void setupColumnAsPrimaryKey(boolean assetManagerIsHome, String schemaAttributeGUID, String schemaAttributeExternalIdentifier, String primaryKeyName, org.odpi.openmetadata.accessservices.assetmanager.properties.KeyPattern primaryKeyPattern, 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 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:
      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)

    • clearColumnAsPrimaryKey

      public void clearColumnAsPrimaryKey(String schemaAttributeGUID, 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 primary key designation from the schema attribute.
      Parameters:
      schemaAttributeGUID - unique identifier of the metadata element to update
      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)

    • setupForeignKeyRelationship

      public void setupForeignKeyRelationship(boolean assetManagerIsHome, String primaryKeyGUID, String foreignKeyGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ForeignKeyProperties foreignKeyProperties, 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 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:
      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)

    • updateForeignKeyRelationship

      public void updateForeignKeyRelationship(String primaryKeyGUID, String foreignKeyGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ForeignKeyProperties foreignKeyProperties, 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 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:
      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)

    • clearForeignKeyRelationship

      public void clearForeignKeyRelationship(String primaryKeyGUID, String foreignKeyGUID, 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 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:
      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)

    • removeSchemaAttribute

      public void removeSchemaAttribute(String schemaAttributeGUID, 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 schema attribute.
      Parameters:
      schemaAttributeGUID - unique identifier of the metadata element to remove
      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)

    • findSchemaAttributes

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.SchemaAttributeElement> findSchemaAttributes(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 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:
      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)

    • getNestedSchemaAttributes

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.SchemaAttributeElement> getNestedSchemaAttributes(String parentSchemaElementGUID, 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 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:
      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)

    • getSchemaAttributesByName

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.SchemaAttributeElement> getSchemaAttributesByName(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 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:
      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)

    • getSchemaAttributeByGUID

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.SchemaAttributeElement getSchemaAttributeByGUID(String schemaAttributeGUID, 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 schema attribute metadata element with the supplied unique identifier.
      Parameters:
      schemaAttributeGUID - 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)

    • createProcess

      public String createProcess(boolean assetManagerIsHome, org.odpi.openmetadata.accessservices.assetmanager.properties.ProcessStatus processStatus, org.odpi.openmetadata.accessservices.assetmanager.properties.ProcessProperties processProperties) 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
      processStatus - initial status of the process
      processProperties - properties about the process to store
      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.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
      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, 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
      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, 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
      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

      @Deprecated public void setupProcessParent(String userId, String externalSourceGUID, String externalSourceName, 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
      Deprecated.
      Create a parent-child relationship between two processes. No longer use this method. Use following method instead.
      Parameters:
      userId - value from context used
      externalSourceGUID - value from context used
      externalSourceName - value from context used
      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)

    • 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:
      processGUID - unique identifier of the metadata element to publish
      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)

    • 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 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:
      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.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
      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, 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
      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, 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
      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, 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
      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, 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
      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 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:
      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)

    • 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)

    • addMementoClassification

      public void addMementoClassification(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 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 - external identifier (optional)
      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)

    • clearMementoClassification

      public void clearMementoClassification(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 memento designation from the element.
      Parameters:
      elementGUID - unique identifier of the metadata element to update
      elementExternalIdentifier - external identifier (optional)
      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)

    • addIncompleteClassification

      public void addIncompleteClassification(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 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:
      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)

    • clearIncompleteClassification

      public void clearIncompleteClassification(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 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:
      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)

    • findGovernanceActionProcesses

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GovernanceActionProcessElement> findGovernanceActionProcesses(String searchString, int startFrom, int pageSize) 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 governance action 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
      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)

    • getGovernanceActionProcessesByName

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GovernanceActionProcessElement> getGovernanceActionProcessesByName(String name, int startFrom, int pageSize) 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 governance action 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
      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)

    • getGovernanceActionProcessByGUID

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GovernanceActionProcessElement getGovernanceActionProcessByGUID(String processGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the governance action process metadata element with the supplied unique identifier.
      Parameters:
      processGUID - unique identifier of the requested metadata element
      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)

    • findGovernanceActionTypes

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GovernanceActionTypeElement> findGovernanceActionTypes(String searchString, int startFrom, int pageSize) 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 governance action 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
      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)

    • getGovernanceActionTypesByName

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GovernanceActionTypeElement> getGovernanceActionTypesByName(String name, int startFrom, int pageSize) 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 governance action 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
      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)

    • getGovernanceActionTypeByGUID

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GovernanceActionTypeElement getGovernanceActionTypeByGUID(String actionTypeGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the governance action type metadata element with the supplied unique identifier.
      Parameters:
      actionTypeGUID - unique identifier of the governance action type
      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)

    • getFirstActionType

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GovernanceActionTypeElement getFirstActionType(String processGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the governance action type that is the first step in a governance action process.
      Parameters:
      processGUID - unique identifier of the governance action process
      Returns:
      properties of the governance action type
      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)

    • getNextGovernanceActionTypes

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.NextGovernanceActionTypeElement> getNextGovernanceActionTypes(String actionTypeGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the lust of next action type defined for the governance action process.
      Parameters:
      actionTypeGUID - unique identifier of the current governance action type
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      return the list of relationships and attached governance action types.
      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)

    • getGovernanceAction

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GovernanceActionElement getGovernanceAction(String governanceActionGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Request the status of an executing governance action request.
      Parameters:
      governanceActionGUID - identifier of the governance action request.
      Returns:
      status enum
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem detected by the metadata store.

    • getGovernanceActions

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GovernanceActionElement> getGovernanceActions(int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the governance actions known to the server.
      Parameters:
      startFrom - starting from element
      pageSize - maximum elements to return
      Returns:
      list of governance action elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem detected by the metadata store.

    • getActiveGovernanceActions

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GovernanceActionElement> getActiveGovernanceActions(int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the governance actions that are still in process.
      Parameters:
      startFrom - starting from element
      pageSize - maximum elements to return
      Returns:
      list of governance action elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem detected by the metadata store.