Package org.odpi.openmetadata.viewservices.automatedcuration.server

Class AutomatedCurationRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.automatedcuration.server.AutomatedCurationRESTServices
public class AutomatedCurationRESTServices extends TokenController
The AutomatedCurationRESTServices provides the implementation of the Automated Curation Open Metadata View Service (OMVS).

  • Constructor Details

    • AutomatedCurationRESTServices

      public AutomatedCurationRESTServices()
      Default constructor

  • Method Details

    • findTechnologyTypes

      public TechnologyTypeSummaryListResponse findTechnologyTypes(String serverName, String urlMarker, SearchStringRequestBody requestBody)
      Retrieve the list of deployed implementation type metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getTechnologyTypesForOpenMetadataType

      public TechnologyTypeSummaryListResponse getTechnologyTypesForOpenMetadataType(String serverName, String urlMarker, String typeName, ResultsRequestBody requestBody)
      Retrieve the list of deployed implementation type metadata elements linked to a particular open metadata type.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      typeName - the type name to search for
      requestBody - does the value start with the supplied string?
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getTechnologyTypeDetail

      public TechnologyTypeReportResponse getTechnologyTypeDetail(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the requested deployed implementation type metadata element.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getTechnologyTypeHierarchy

      public TechnologyTypeHierarchyResponse getTechnologyTypeHierarchy(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the requested deployed implementation type metadata element and its subtypes. A mermaid version if the hierarchy is also returned.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getTechnologyTypeElements

      public OpenMetadataRootElementsResponse getTechnologyTypeElements(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the requested deployed implementation type metadata element. There are no wildcards allowed in the name.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • createElementFromTemplate

      public GUIDResponse createElementFromTemplate(String serverName, String urlMarker, TemplateRequestBody requestBody)
      Create a new element from a template.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - information about the template
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • cancelEngineAction

      public VoidResponse cancelEngineAction(String serverName, String urlMarker, String engineActionGUID)
      Request that an engine action is stopped.
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      engineActionGUID - identifier of the engine action request.
      Returns:
      engine action properties and status or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException user not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • getActiveEngineActions

      public EngineActionElementsResponse getActiveEngineActions(String serverName, String urlMarker, int startFrom, int pageSize)
      Retrieve the engine actions that are still in process.
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      startFrom - starting from element
      pageSize - maximum elements to return
      Returns:
      list of engine action elements or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException user not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • initiateEngineAction

      public GUIDResponse initiateEngineAction(String serverName, String urlMarker, String governanceEngineName, InitiateEngineActionRequestBody 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
      urlMarker - view service URL marker
      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

    • initiateGovernanceActionType

      public GUIDResponse initiateGovernanceActionType(String serverName, String urlMarker, InitiateGovernanceActionTypeRequestBody requestBody)
      Using the named governance action type as a template, initiate an engine action.
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      requestBody - properties to initiate the new instance of the engine action
      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

    • initiateGovernanceActionProcess

      public GUIDResponse initiateGovernanceActionProcess(String serverName, String urlMarker, InitiateGovernanceActionProcessRequestBody 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
      urlMarker - view service URL marker
      requestBody - properties to initiate the new instance of the process
      Returns:
      unique identifier of the governance action process instance 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