Package org.odpi.openmetadata.frameworkservices.gaf.client

Class OpenGovernanceClientBase

java.lang.Object
org.odpi.openmetadata.frameworkservices.gaf.client.OpenGovernanceClientBase
All Implemented Interfaces:
org.odpi.openmetadata.frameworks.governanceaction.client.ActionControlInterface, org.odpi.openmetadata.frameworks.governanceaction.client.DuplicateManagementInterface, org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface, org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionTypeInterface
Direct Known Subclasses:
GovernanceContextClientBase
public class OpenGovernanceClientBase extends Object implements org.odpi.openmetadata.frameworks.governanceaction.client.ActionControlInterface, org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionTypeInterface, org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface, org.odpi.openmetadata.frameworks.governanceaction.client.DuplicateManagementInterface
OpenGovernanceClientBase provides common governance services that originate in the Governance Action Framework (GAF). This includes the ability to define and execute governance action processes as well as manage duplicates.

  • Constructor Summary

    Constructors
    Constructor
    Description
    OpenGovernanceClientBase(String serviceURLMarker, String serverName, String serverPlatformURLRoot, int maxPageSize)
    Create a new client with no authentication embedded in the HTTP request.
    OpenGovernanceClientBase(String serviceURLMarker, String serverName, String serverPlatformURLRoot, String serverUserId, String serverPassword, int maxPageSize)
    Create a new client that passes userId and password in each HTTP request.
    OpenGovernanceClientBase(String serviceURLMarker, String serverName, String serverPlatformURLRoot, GAFRESTClient restClient, int maxPageSize)
    Create a new client that passes userId and password in each HTTP request.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cancelEngineAction(String userId, String engineActionGUID)
    Request that execution of an engine action is stopped.
    String
    createGovernanceActionProcess(String userId, org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionProcessProperties processProperties, org.odpi.openmetadata.frameworks.openmetadata.enums.ProcessStatus initialStatus)
    Create a new metadata element to represent a governance action process.
    String
    createGovernanceActionProcessStep(String userId, org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionProcessStepProperties processStepProperties)
    Create a new metadata element to represent a governance action process step.
    String
    createGovernanceActionType(String userId, org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionTypeProperties properties)
    Create a new metadata element to represent a governance action type.
    List<org.odpi.openmetadata.frameworks.governanceaction.properties.EngineActionElement>
    findEngineActions(String userId, String searchString, int startFrom, int pageSize)
    Retrieve the list of engine action metadata elements that contain the search string.
    List<org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionProcessElement>
    findGovernanceActionProcesses(String userId, String searchString, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the list of governance action process metadata elements that contain the search string.
    List<org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionProcessStepElement>
    findGovernanceActionProcessSteps(String userId, String searchString, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the list of governance action process step metadata elements that contain the search string.
    List<org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionTypeElement>
    findGovernanceActionTypes(String userId, String searchString, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the list of governance action type metadata elements that contain the search string.
    List<org.odpi.openmetadata.frameworks.governanceaction.properties.EngineActionElement>
    getActiveEngineActions(String userId, int startFrom, int pageSize)
    Retrieve the engine actions that are still in process.
    org.odpi.openmetadata.frameworks.governanceaction.properties.EngineActionElement
    getEngineAction(String userId, String engineActionGUID)
    Request the status of an executing engine action request.
    List<org.odpi.openmetadata.frameworks.governanceaction.properties.EngineActionElement>
    getEngineActions(String userId, int startFrom, int pageSize)
    Retrieve the engine actions known to the server.
    List<org.odpi.openmetadata.frameworks.governanceaction.properties.EngineActionElement>
    getEngineActionsByName(String userId, String name, int startFrom, int pageSize)
    Retrieve the list of engine action metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.frameworks.governanceaction.properties.FirstGovernanceActionProcessStepElement
    getFirstActionProcessStep(String userId, String processGUID)
    Return the governance action process step that is the first step in a governance action process.
    org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionProcessElement
    getGovernanceActionProcessByGUID(String userId, String processGUID)
    Retrieve the governance action process metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionProcessElement>
    getGovernanceActionProcessesByName(String userId, String name, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the list of governance action process metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionProcessGraph
    getGovernanceActionProcessGraph(String userId, String processGUID, Date effectiveTime)
    Retrieve the governance action process metadata element with the supplied unique identifier along with its process flow implementation.
    org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionProcessStepElement
    getGovernanceActionProcessStepByGUID(String userId, String processStepGUID)
    Retrieve the governance action process step metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionProcessStepElement>
    getGovernanceActionProcessStepsByName(String userId, String name, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the list of governance action process step metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionTypeElement
    getGovernanceActionTypeByGUID(String userId, String governanceActionTypeGUID)
    Retrieve the governance action type metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionTypeElement>
    getGovernanceActionTypesByName(String userId, String name, int startFrom, int pageSize, Date effectiveTime)
    Retrieve the list of governance action type metadata elements with a matching qualified or display name.
    List<org.odpi.openmetadata.frameworks.governanceaction.properties.NextGovernanceActionProcessStepElement>
    getNextGovernanceActionProcessSteps(String userId, String processStepGUID, int startFrom, int pageSize)
    Return the list of next action process step defined for the governance action process.
    String
    initiateEngineAction(String userId, String qualifiedName, int domainIdentifier, String displayName, String description, List<String> requestSourceGUIDs, List<org.odpi.openmetadata.frameworks.governanceaction.properties.NewActionTarget> actionTargets, List<String> receivedGuards, Date startTime, String governanceEngineName, String requestType, Map<String,String> requestParameters, String processName, String requestSourceName, String originatorServiceName, String originatorEngineName)
    Create an engine action in the metadata store which will trigger the governance service associated with the supplied request type.
    String
    initiateGovernanceActionProcess(String userId, String processQualifiedName, List<String> requestSourceGUIDs, List<org.odpi.openmetadata.frameworks.governanceaction.properties.NewActionTarget> actionTargets, Date startTime, Map<String,String> requestParameters, String originatorServiceName, String originatorEngineName)
    Using the named governance action process as a template, initiate a chain of engine actions.
    String
    initiateGovernanceActionType(String userId, String governanceActionTypeQualifiedName, List<String> requestSourceGUIDs, List<org.odpi.openmetadata.frameworks.governanceaction.properties.NewActionTarget> actionTargets, Date startTime, Map<String,String> requestParameters, String originatorServiceName, String originatorEngineName)
    Using the named governance action type as a template, initiate an engine action.
    void
    linkConsolidatedDuplicate(String userId, String consolidatedElementGUID, int statusIdentifier, String steward, String stewardTypeName, String stewardPropertyName, String source, String notes, List<String> sourceElementGUIDs)
    Identify an element that acts as a consolidated version for a set of duplicate elements.
    void
    linkElementsAsPeerDuplicates(String userId, String metadataElement1GUID, String metadataElement2GUID, int statusIdentifier, String steward, String stewardTypeName, String stewardPropertyName, String source, String notes, boolean setKnownDuplicate)
    Link elements as peer duplicates.
    void
    publishGovernanceActionProcess(String userId, String processGUID)
    Update the zones for the asset so that it becomes visible to consumers.
    void
    removeFirstActionProcessStep(String userId, String processGUID)
    Remove the link between a governance process and that governance action process step that defines its first step.
    void
    removeGovernanceActionProcess(String userId, String processGUID)
    Remove the metadata element representing a governance action process.
    void
    removeGovernanceActionProcessStep(String userId, String processStepGUID)
    Remove the metadata element representing a governance action process step.
    void
    removeGovernanceActionType(String userId, String governanceActionTypeGUID)
    Remove the metadata element representing a governance action type.
    void
    removeNextActionProcessStep(String userId, String processStepLinkGUID)
    Remove a follow-on step from a governance action process.
    void
    setupFirstActionProcessStep(String userId, String processGUID, String processStepGUID, String guard)
    Set up a link between a governance action process and a governance action process step.
    String
    setupNextActionProcessStep(String userId, String currentActionProcessStepGUID, String nextActionProcessStepGUID, String guard, boolean mandatoryGuard)
    Add a link between two governance action process steps to show that one follows on from the other when a governance action process is executing.
    void
    updateGovernanceActionProcess(String userId, String processGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.enums.ProcessStatus processStatus, org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionProcessProperties processProperties)
    Update the metadata element representing a governance action process.
    void
    updateGovernanceActionProcessStep(String userId, String processStepGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionProcessStepProperties processStepProperties)
    Update the metadata element representing a governance action process step.
    void
    updateGovernanceActionType(String userId, String governanceActionTypeGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionTypeProperties properties)
    Update the metadata element representing a governance action type.
    void
    updateNextActionProcessStep(String userId, String nextProcessStepLinkGUID, String guard, boolean mandatoryGuard)
    Update the properties of the link between two governance action process steps that shows that one follows on from the other when a governance action process is executing.
    void
    withdrawGovernanceActionProcess(String userId, String processGUID)
    Update the zones for the asset so that it is no longer visible to consumers.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • OpenGovernanceClientBase

      public OpenGovernanceClientBase(String serviceURLMarker, String serverName, String serverPlatformURLRoot, int maxPageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      maxPageSize - pre-initialized parameter limit
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • OpenGovernanceClientBase

      public OpenGovernanceClientBase(String serviceURLMarker, String serverName, String serverPlatformURLRoot, String serverUserId, String serverPassword, int maxPageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      serverUserId - caller's userId embedded in all HTTP requests
      serverPassword - caller's password embedded in all HTTP requests
      maxPageSize - pre-initialized parameter limit
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • OpenGovernanceClientBase

      public OpenGovernanceClientBase(String serviceURLMarker, String serverName, String serverPlatformURLRoot, GAFRESTClient restClient, int maxPageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      restClient - pre-initialized REST client
      maxPageSize - pre-initialized parameter limit
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem with the information about the remote OMAS

  • Method Details

    • initiateEngineAction

      public String initiateEngineAction(String userId, String qualifiedName, int domainIdentifier, String displayName, String description, List<String> requestSourceGUIDs, List<org.odpi.openmetadata.frameworks.governanceaction.properties.NewActionTarget> actionTargets, List<String> receivedGuards, Date startTime, String governanceEngineName, String requestType, Map<String,String> requestParameters, String processName, String requestSourceName, String originatorServiceName, String originatorEngineName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create an engine action in the metadata store which will trigger the governance service associated with the supplied request type. The engine action remains to act as a record of the actions taken for auditing.
      Specified by:
      initiateEngineAction in interface org.odpi.openmetadata.frameworks.governanceaction.client.ActionControlInterface
      Parameters:
      userId - caller's userId
      qualifiedName - unique identifier to give this engine action
      domainIdentifier - governance domain associated with this action (0=ALL)
      displayName - display name for this action
      description - description for this action
      requestSourceGUIDs - request source elements for the resulting governance service
      actionTargets - list of action target names to GUIDs for the resulting governance service
      receivedGuards - list of guards to initiate the engine action
      startTime - future start time or null for "as soon as possible"
      governanceEngineName - name of the governance engine that should execute the request
      requestType - governance request type from the caller
      requestParameters - properties to pass to the governance service
      processName - name of the process that this action is a part of
      requestSourceName - source of the request
      originatorServiceName - unique name of the requesting governance service (if initiated by a governance engine).
      originatorEngineName - optional unique name of the requesting governance engine (if initiated by a governance engine).
      Returns:
      unique identifier of the engine action
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - null qualified name
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the caller is not authorized to create an engine action
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store

    • initiateGovernanceActionType

      public String initiateGovernanceActionType(String userId, String governanceActionTypeQualifiedName, List<String> requestSourceGUIDs, List<org.odpi.openmetadata.frameworks.governanceaction.properties.NewActionTarget> actionTargets, Date startTime, Map<String,String> requestParameters, String originatorServiceName, String originatorEngineName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Using the named governance action type as a template, initiate an engine action.
      Specified by:
      initiateGovernanceActionType in interface org.odpi.openmetadata.frameworks.governanceaction.client.ActionControlInterface
      Parameters:
      userId - caller's userId
      governanceActionTypeQualifiedName - unique name of the governance action type to use
      requestSourceGUIDs - request source elements for the resulting governance service
      actionTargets - list of action target names to GUIDs for the resulting governance service
      startTime - future start time or null for "as soon as possible".
      requestParameters - request properties to be passed to the engine action
      originatorServiceName - unique name of the requesting governance service (if initiated by a governance engine).
      originatorEngineName - optional unique name of the governance engine (if initiated by a governance engine).
      Returns:
      unique identifier of the engine action
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - null or unrecognized qualified name of the type
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the caller is not authorized to create an engine action
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store

    • initiateGovernanceActionProcess

      public String initiateGovernanceActionProcess(String userId, String processQualifiedName, List<String> requestSourceGUIDs, List<org.odpi.openmetadata.frameworks.governanceaction.properties.NewActionTarget> actionTargets, Date startTime, Map<String,String> requestParameters, String originatorServiceName, String originatorEngineName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Using the named governance action process as a template, initiate a chain of engine actions.
      Specified by:
      initiateGovernanceActionProcess in interface org.odpi.openmetadata.frameworks.governanceaction.client.ActionControlInterface
      Parameters:
      userId - caller's userId
      processQualifiedName - unique name of the governance action process to use
      requestSourceGUIDs - request source elements for the resulting governance service
      actionTargets - list of action target names to GUIDs for the resulting governance service
      startTime - future start time or null for "as soon as possible".
      requestParameters - request properties to be passed to the first engine action
      originatorServiceName - unique name of the requesting governance service (if initiated by a governance engine).
      originatorEngineName - optional unique name of the governance engine (if initiated by a governance engine).
      Returns:
      unique identifier of the governance action process instance
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - null or unrecognized qualified name of the process
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the caller is not authorized to create a governance action process
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store

    • getEngineAction

      public org.odpi.openmetadata.frameworks.governanceaction.properties.EngineActionElement getEngineAction(String userId, String engineActionGUID) 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 engine action request.
      Specified by:
      getEngineAction in interface org.odpi.openmetadata.frameworks.governanceaction.client.ActionControlInterface
      Parameters:
      userId - identifier of calling user
      engineActionGUID - identifier of the engine 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.

    • cancelEngineAction

      public void cancelEngineAction(String userId, String engineActionGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Request that execution of an engine action is stopped.
      Specified by:
      cancelEngineAction in interface org.odpi.openmetadata.frameworks.governanceaction.client.ActionControlInterface
      Parameters:
      userId - identifier of calling user
      engineActionGUID - identifier of the engine action request.
      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.

    • getEngineActions

      public List<org.odpi.openmetadata.frameworks.governanceaction.properties.EngineActionElement> getEngineActions(String userId, 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 engine actions known to the server.
      Specified by:
      getEngineActions in interface org.odpi.openmetadata.frameworks.governanceaction.client.ActionControlInterface
      Parameters:
      userId - userId of caller
      startFrom - starting from element
      pageSize - maximum elements to return
      Returns:
      list of engine 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.

    • getActiveEngineActions

      public List<org.odpi.openmetadata.frameworks.governanceaction.properties.EngineActionElement> getActiveEngineActions(String userId, 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 engine actions that are still in process.
      Specified by:
      getActiveEngineActions in interface org.odpi.openmetadata.frameworks.governanceaction.client.ActionControlInterface
      Parameters:
      userId - userId of caller
      startFrom - starting from element
      pageSize - maximum elements to return
      Returns:
      list of engine 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.

    • findEngineActions

      public List<org.odpi.openmetadata.frameworks.governanceaction.properties.EngineActionElement> findEngineActions(String userId, 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 engine action metadata elements that contain the search string. The search string is treated as a regular expression.
      Specified by:
      findEngineActions in interface org.odpi.openmetadata.frameworks.governanceaction.client.ActionControlInterface
      Parameters:
      userId - calling user
      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)

    • getEngineActionsByName

      public List<org.odpi.openmetadata.frameworks.governanceaction.properties.EngineActionElement> getEngineActionsByName(String userId, 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 engine action metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Specified by:
      getEngineActionsByName in interface org.odpi.openmetadata.frameworks.governanceaction.client.ActionControlInterface
      Parameters:
      userId - calling user
      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)

    • linkElementsAsPeerDuplicates

      public void linkElementsAsPeerDuplicates(String userId, String metadataElement1GUID, String metadataElement2GUID, int statusIdentifier, String steward, String stewardTypeName, String stewardPropertyName, String source, String notes, boolean setKnownDuplicate) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Link elements as peer duplicates. Create a simple relationship between two elements. If the relationship already exists, the properties are updated.
      Specified by:
      linkElementsAsPeerDuplicates in interface org.odpi.openmetadata.frameworks.governanceaction.client.DuplicateManagementInterface
      Parameters:
      userId - caller's userId
      metadataElement1GUID - unique identifier of the metadata element at end 1 of the relationship
      metadataElement2GUID - unique identifier of the metadata element at end 2 of the relationship
      statusIdentifier - what is the status of this relationship (negative means untrusted, 0 means unverified and positive means trusted)
      steward - identifier of the steward
      stewardTypeName - type of element used to identify the steward
      stewardPropertyName - property name used to identify steward
      source - source of the duplicate detection processing
      notes - notes for the steward
      setKnownDuplicate - boolean flag indicating whether the KnownDuplicate classification should be set on the linked entities.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the unique identifier's of the metadata elements are null or invalid in some way; the properties are not valid for this type of relationship
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the caller is not authorized to create this type of relationship
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store

    • linkConsolidatedDuplicate

      public void linkConsolidatedDuplicate(String userId, String consolidatedElementGUID, int statusIdentifier, String steward, String stewardTypeName, String stewardPropertyName, String source, String notes, List<String> sourceElementGUIDs) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Identify an element that acts as a consolidated version for a set of duplicate elements. (The consolidated element is created using createMetadataElement.)
      Specified by:
      linkConsolidatedDuplicate in interface org.odpi.openmetadata.frameworks.governanceaction.client.DuplicateManagementInterface
      Parameters:
      userId - caller's userId
      consolidatedElementGUID - unique identifier of the metadata element
      statusIdentifier - what is the status of this relationship (negative means untrusted, 0 means unverified and positive means trusted)
      steward - identifier of the steward
      stewardTypeName - type of element used to identify the steward
      stewardPropertyName - property name used to identify steward
      source - source of the duplicate detection processing
      notes - notes for the steward
      sourceElementGUIDs - List of the source elements that must be linked to the consolidated element. It is assumed that they already have the KnownDuplicateClassification.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the unique identifier's of the metadata elements are null or invalid in some way; the properties are not valid for this type of relationship
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the caller is not authorized to create this type of relationship
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store

    • createGovernanceActionType

      public String createGovernanceActionType(String userId, org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionTypeProperties 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 new metadata element to represent a governance action type.
      Specified by:
      createGovernanceActionType in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionTypeInterface
      Parameters:
      userId - calling user
      properties - properties about the governance action type to store
      Returns:
      unique identifier of the new 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)

    • updateGovernanceActionType

      public void updateGovernanceActionType(String userId, String governanceActionTypeGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionTypeProperties properties) 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 governance action type.
      Specified by:
      updateGovernanceActionType in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionTypeInterface
      Parameters:
      userId - calling user
      governanceActionTypeGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      properties - new properties for the 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)

    • removeGovernanceActionType

      public void removeGovernanceActionType(String userId, String governanceActionTypeGUID) 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 governance action type.
      Specified by:
      removeGovernanceActionType in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionTypeInterface
      Parameters:
      userId - calling user
      governanceActionTypeGUID - unique identifier of the metadata element to remove
      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.frameworks.governanceaction.properties.GovernanceActionTypeElement> findGovernanceActionTypes(String userId, 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 governance action type metadata elements that contain the search string. The search string is treated as a regular expression.
      Specified by:
      findGovernanceActionTypes in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionTypeInterface
      Parameters:
      userId - calling user
      searchString - string to find in the properties
      startFrom - paging start point
      pageSize - maximum results that can be returned
      effectiveTime - effective date/time for query
      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.frameworks.governanceaction.properties.GovernanceActionTypeElement> getGovernanceActionTypesByName(String userId, 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 governance action type metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Specified by:
      getGovernanceActionTypesByName in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionTypeInterface
      Parameters:
      userId - calling user
      name - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      effectiveTime - effective date/time for query
      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.frameworks.governanceaction.properties.GovernanceActionTypeElement getGovernanceActionTypeByGUID(String userId, String governanceActionTypeGUID) 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.
      Specified by:
      getGovernanceActionTypeByGUID in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionTypeInterface
      Parameters:
      userId - calling user
      governanceActionTypeGUID - 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)

    • createGovernanceActionProcess

      public String createGovernanceActionProcess(String userId, org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionProcessProperties processProperties, org.odpi.openmetadata.frameworks.openmetadata.enums.ProcessStatus initialStatus) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent a governance action process.
      Specified by:
      createGovernanceActionProcess in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface
      Parameters:
      userId - calling user
      processProperties - properties about the process to store
      initialStatus - status value for the new process (default = ACTIVE)
      Returns:
      unique identifier of the new process
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateGovernanceActionProcess

      public void updateGovernanceActionProcess(String userId, String processGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.enums.ProcessStatus processStatus, org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionProcessProperties processProperties) 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 governance action process.
      Specified by:
      updateGovernanceActionProcess in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface
      Parameters:
      userId - calling user
      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)?
      processStatus - new status for the process
      processProperties - new properties for the 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)

    • publishGovernanceActionProcess

      public void publishGovernanceActionProcess(String userId, String processGUID) 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 Governance Engine OMAS).
      Specified by:
      publishGovernanceActionProcess in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface
      Parameters:
      userId - calling user
      processGUID - unique identifier of the metadata element to publish
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • withdrawGovernanceActionProcess

      public void withdrawGovernanceActionProcess(String userId, String processGUID) 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 Governance Engine OMAS. This is the setting when the process is first created).
      Specified by:
      withdrawGovernanceActionProcess in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface
      Parameters:
      userId - calling user
      processGUID - unique identifier of the metadata element to withdraw
      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)

    • removeGovernanceActionProcess

      public void removeGovernanceActionProcess(String userId, String processGUID) 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 governance action process.
      Specified by:
      removeGovernanceActionProcess in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface
      Parameters:
      userId - calling user
      processGUID - unique identifier of the metadata element to remove
      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.frameworks.governanceaction.properties.GovernanceActionProcessElement> findGovernanceActionProcesses(String userId, 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 governance action process metadata elements that contain the search string. The search string is treated as a regular expression.
      Specified by:
      findGovernanceActionProcesses in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface
      Parameters:
      userId - calling user
      searchString - string to find in the properties
      startFrom - paging start point
      pageSize - maximum results that can be returned
      effectiveTime - effective date/time for query
      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.frameworks.governanceaction.properties.GovernanceActionProcessElement> getGovernanceActionProcessesByName(String userId, 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 governance action process metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Specified by:
      getGovernanceActionProcessesByName in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface
      Parameters:
      userId - calling user
      name - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      effectiveTime - effective date/time for query
      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.frameworks.governanceaction.properties.GovernanceActionProcessElement getGovernanceActionProcessByGUID(String userId, 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.
      Specified by:
      getGovernanceActionProcessByGUID in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface
      Parameters:
      userId - calling user
      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)

    • getGovernanceActionProcessGraph

      public org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionProcessGraph getGovernanceActionProcessGraph(String userId, 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 governance action process metadata element with the supplied unique identifier along with its process flow implementation. This includes the process steps and the links between them
      Specified by:
      getGovernanceActionProcessGraph in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface
      Parameters:
      userId - calling user
      processGUID - unique identifier of the requested metadata element
      effectiveTime - effective date/time for query
      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)

    • createGovernanceActionProcessStep

      public String createGovernanceActionProcessStep(String userId, org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionProcessStepProperties processStepProperties) 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 governance action process step.
      Specified by:
      createGovernanceActionProcessStep in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface
      Parameters:
      userId - calling user
      processStepProperties - properties about the process step to store
      Returns:
      unique identifier of the new governance action process step
      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)

    • updateGovernanceActionProcessStep

      public void updateGovernanceActionProcessStep(String userId, String processStepGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionProcessStepProperties processStepProperties) 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 governance action process step.
      Specified by:
      updateGovernanceActionProcessStep in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface
      Parameters:
      userId - calling user
      processStepGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      processStepProperties - new properties for the 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)

    • removeGovernanceActionProcessStep

      public void removeGovernanceActionProcessStep(String userId, String processStepGUID) 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 governance action process step.
      Specified by:
      removeGovernanceActionProcessStep in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface
      Parameters:
      userId - calling user
      processStepGUID - unique identifier of the metadata element to remove
      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)

    • findGovernanceActionProcessSteps

      public List<org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionProcessStepElement> findGovernanceActionProcessSteps(String userId, 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 governance action process step metadata elements that contain the search string. The search string is treated as a regular expression.
      Specified by:
      findGovernanceActionProcessSteps in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface
      Parameters:
      userId - calling user
      searchString - string to find in the properties
      startFrom - paging start point
      pageSize - maximum results that can be returned
      effectiveTime - effective date/time for query
      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)

    • getGovernanceActionProcessStepsByName

      public List<org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionProcessStepElement> getGovernanceActionProcessStepsByName(String userId, 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 governance action process step metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Specified by:
      getGovernanceActionProcessStepsByName in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface
      Parameters:
      userId - calling user
      name - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      effectiveTime - effective date/time for query
      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)

    • getGovernanceActionProcessStepByGUID

      public org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionProcessStepElement getGovernanceActionProcessStepByGUID(String userId, String processStepGUID) 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 step metadata element with the supplied unique identifier.
      Specified by:
      getGovernanceActionProcessStepByGUID in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface
      Parameters:
      userId - calling user
      processStepGUID - unique identifier of the governance action process step
      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)

    • setupFirstActionProcessStep

      public void setupFirstActionProcessStep(String userId, String processGUID, String processStepGUID, String guard) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Set up a link between a governance action process and a governance action process step. This defines the first step in the process.
      Specified by:
      setupFirstActionProcessStep in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface
      Parameters:
      userId - calling user
      processGUID - unique identifier of the governance action process
      processStepGUID - unique identifier of the governance action process step
      guard - optional guard for the first governance service to run
      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)

    • getFirstActionProcessStep

      public org.odpi.openmetadata.frameworks.governanceaction.properties.FirstGovernanceActionProcessStepElement getFirstActionProcessStep(String userId, 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 process step that is the first step in a governance action process.
      Specified by:
      getFirstActionProcessStep in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface
      Parameters:
      userId - calling user
      processGUID - unique identifier of the governance action process
      Returns:
      properties of the first governance action process step
      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)

    • removeFirstActionProcessStep

      public void removeFirstActionProcessStep(String userId, String processGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the link between a governance process and that governance action process step that defines its first step.
      Specified by:
      removeFirstActionProcessStep in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface
      Parameters:
      userId - calling user
      processGUID - unique identifier of the governance action 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)

    • setupNextActionProcessStep

      public String setupNextActionProcessStep(String userId, String currentActionProcessStepGUID, String nextActionProcessStepGUID, String guard, boolean mandatoryGuard) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Add a link between two governance action process steps to show that one follows on from the other when a governance action process is executing.
      Specified by:
      setupNextActionProcessStep in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface
      Parameters:
      userId - calling user
      currentActionProcessStepGUID - unique identifier of the governance action process step that defines the previous step in the governance action process
      nextActionProcessStepGUID - unique identifier of the governance action process step that defines the next step in the governance action process
      guard - guard required for this next step to proceed - or null for always run the next step.
      mandatoryGuard - means that no next steps can run if this guard is not returned
      Returns:
      unique identifier of the new link
      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)

    • updateNextActionProcessStep

      public void updateNextActionProcessStep(String userId, String nextProcessStepLinkGUID, String guard, boolean mandatoryGuard) 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 link between two governance action process steps that shows that one follows on from the other when a governance action process is executing.
      Specified by:
      updateNextActionProcessStep in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface
      Parameters:
      userId - calling user
      nextProcessStepLinkGUID - unique identifier of the relationship between the governance action process steps
      guard - guard required for this next step to proceed - or null for always run the next step.
      mandatoryGuard - means that no next steps can run if this guard is not returned
      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)

    • getNextGovernanceActionProcessSteps

      public List<org.odpi.openmetadata.frameworks.governanceaction.properties.NextGovernanceActionProcessStepElement> getNextGovernanceActionProcessSteps(String userId, String processStepGUID, 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 list of next action process step defined for the governance action process.
      Specified by:
      getNextGovernanceActionProcessSteps in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface
      Parameters:
      userId - calling user
      processStepGUID - unique identifier of the current governance action process step
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      return the list of relationships and attached governance action process steps.
      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)

    • removeNextActionProcessStep

      public void removeNextActionProcessStep(String userId, String processStepLinkGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove a follow-on step from a governance action process.
      Specified by:
      removeNextActionProcessStep in interface org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface
      Parameters:
      userId - calling user
      processStepLinkGUID - unique identifier of the relationship between the governance action process steps
      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)