Package org.odpi.openmetadata.frameworkservices.gaf.server.spring

Class OpenGovernanceResource

java.lang.Object
org.odpi.openmetadata.frameworkservices.gaf.server.spring.OpenGovernanceResource
@RestController @RequestMapping("/servers/{serverName}/open-metadata/framework-services/{serviceURLMarker}/open-governance-service/users/{userId}") public class OpenGovernanceResource extends Object
GovernanceEngineOMASResource supports the REST APIs for running Governance Action Service

  • Constructor Summary

    Constructors
    Constructor
    Description
    OpenGovernanceResource()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    initiateGovernanceAction(String serverName, String userId, String governanceEngineName, org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionRequestBody requestBody)
    Create a governance action in the metadata store which will trigger the governance action service associated with the supplied request type.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    initiateGovernanceActionProcess(String serverName, String userId, org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessRequestBody requestBody)
    Using the named governance action process as a template, initiate a chain of governance actions.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    linkConsolidatedDuplicate(String serverName, String userId, org.odpi.openmetadata.frameworkservices.gaf.rest.ConsolidatedDuplicatesRequestBody requestBody)
    Create a simple relationship between two elements.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    linkElementsAsPeerDuplicates(String serverName, String userId, org.odpi.openmetadata.frameworkservices.gaf.rest.PeerDuplicatesRequestBody requestBody)
    Create a simple relationship between two elements.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    recordCompletionStatus(String serverName, String userId, String governanceActionGUID, org.odpi.openmetadata.frameworkservices.gaf.rest.CompletionStatusRequestBody requestBody)
    Declare that all the processing for the governance action service is finished and the status of the work.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateActionTargetStatus(String serverName, String userId, org.odpi.openmetadata.frameworkservices.gaf.rest.ActionTargetStatusRequestBody requestBody)
    Update the status of a specific action target.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • OpenGovernanceResource

      public OpenGovernanceResource()

  • Method Details

    • updateActionTargetStatus

      @PostMapping(path="/governance-actions/action-targets/update") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateActionTargetStatus(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.frameworkservices.gaf.rest.ActionTargetStatusRequestBody requestBody)
      Update the status of a specific action target. By default, these values are derived from the values for the governance action service. However, if the governance action service has to process name target elements, then setting the status on each individual target will show the progress of the governance action service.
      Parameters:
      serverName - name of server instance to route request to
      userId - caller's userId
      requestBody - relationship properties
      Returns:
      void or InvalidParameterException the action target GUID is not recognized UserNotAuthorizedException the governance action service is not authorized to update the action target properties PropertyServerException there is a problem connecting to the metadata store

    • recordCompletionStatus

      @PostMapping(path="/governance-actions/{governanceActionGUID}/completion-status") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse recordCompletionStatus(@PathVariable String serverName, @PathVariable String userId, @PathVariable String governanceActionGUID, @RequestBody org.odpi.openmetadata.frameworkservices.gaf.rest.CompletionStatusRequestBody requestBody)
      Declare that all the processing for the governance action service is finished and the status of the work.
      Parameters:
      serverName - name of server instance to route request to
      userId - caller's userId
      governanceActionGUID - unique identifier of the governance action to update
      requestBody - completion status enum value, optional guard strings for triggering subsequent action(s) plus a list of additional elements to add to the action targets for the next phase
      Returns:
      void or InvalidParameterException the completion status is null UserNotAuthorizedException the governance action service is not authorized to update the governance action service status PropertyServerException there is a problem connecting to the metadata store

    • initiateGovernanceAction

      @PostMapping(path="/governance-engines/{governanceEngineName}/governance-actions/initiate") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse initiateGovernanceAction(@PathVariable String serverName, @PathVariable String userId, @PathVariable String governanceEngineName, @RequestBody org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionRequestBody requestBody)
      Create a governance action in the metadata store which will trigger the governance action service associated with the supplied request type. The governance action remains to act as a record of the actions taken for auditing.
      Parameters:
      serverName - name of server instance to route request to
      userId - caller's userId
      governanceEngineName - name of the governance engine that should execute the request
      requestBody - properties for the governance action and to pass to the governance action service
      Returns:
      unique identifier of the governance action or InvalidParameterException null qualified name UserNotAuthorizedException this governance action service is not authorized to create a governance action PropertyServerException there is a problem with the metadata store

    • initiateGovernanceActionProcess

      @PostMapping(path="/governance-action-processes/initiate") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse initiateGovernanceActionProcess(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessRequestBody requestBody)
      Using the named governance action process as a template, initiate a chain of governance actions.
      Parameters:
      serverName - name of server instance to route request to
      userId - caller's userId
      requestBody - properties to initiate the new instance of the process
      Returns:
      unique identifier of the first governance action of the process or InvalidParameterException null or unrecognized qualified name of the process UserNotAuthorizedException this governance action service is not authorized to create a governance action process PropertyServerException there is a problem with the metadata store

    • linkElementsAsPeerDuplicates

      @PostMapping(path="/related-elements/link-as-peer-duplicate") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse linkElementsAsPeerDuplicates(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.frameworkservices.gaf.rest.PeerDuplicatesRequestBody requestBody)
      Create a simple relationship between two elements. If the relationship already exists, the properties are updated.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - parameters for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid, or the elements are of different types PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • linkConsolidatedDuplicate

      @PostMapping(path="/related-elements/link-as-consolidated-duplicate") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse linkConsolidatedDuplicate(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.frameworkservices.gaf.rest.ConsolidatedDuplicatesRequestBody requestBody)
      Create a simple relationship between two elements. If the relationship already exists, the properties are updated.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - parameters for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid, or the elements are of different types PropertyServerException problem accessing property server UserNotAuthorizedException security access problem