Package org.odpi.openmetadata.engineservices.assetanalysis.server.spring

Class DiscoveryEngineResource

java.lang.Object
org.odpi.openmetadata.engineservices.assetanalysis.server.spring.DiscoveryEngineResource
@RestController @RequestMapping("/servers/{serverName}/open-metadata/engine-services/asset-analysis/users/{userId}/discovery-engines/{discoveryEngineName}") public class DiscoveryEngineResource extends Object
DiscoveryEngineResource provides the server-side catcher for REST calls using Spring that target a specific discovery engine hosted in a engine host server. The engine host server routes these requests to the named discovery engine.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DiscoveryEngineResource()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    discoverAsset(String serverName, String discoveryEngineName, String userId, String assetGUID, String discoveryRequestType, org.odpi.openmetadata.accessservices.discoveryengine.rest.DiscoveryRequestRequestBody requestBody)
    Request the execution of a discovery service to explore a specific asset.
    org.odpi.openmetadata.accessservices.discoveryengine.rest.AnnotationResponse
    getAnnotation(String serverName, String discoveryEngineName, String userId, String annotationGUID)
    Retrieve a single annotation by unique identifier.
    org.odpi.openmetadata.accessservices.discoveryengine.rest.DiscoveryAnalysisReportResponse
    getDiscoveryAnalysisReport(String serverName, String discoveryEngineName, String userId, String discoveryRequestGUID)
    Request the discovery report for a discovery request that has completed.
    org.odpi.openmetadata.accessservices.discoveryengine.rest.AnnotationListResponse
    getDiscoveryReportAnnotations(String serverName, String discoveryEngineName, String userId, String discoveryRequestGUID, int startingFrom, int maximumResults)
    Return the annotations linked direction to the report.
    org.odpi.openmetadata.accessservices.discoveryengine.rest.AnnotationListResponse
    getExtendedAnnotations(String serverName, String discoveryEngineName, String userId, String annotationGUID, int startingFrom, int maximumResults)
    Return any annotations attached to this annotation.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    scanAllAssets(String serverName, String discoveryEngineName, String userId, String discoveryRequestType, org.odpi.openmetadata.accessservices.discoveryengine.rest.DiscoveryRequestRequestBody requestBody)
    Request the execution of a discovery service for each asset that is stored in the asset catalog.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DiscoveryEngineResource

      public DiscoveryEngineResource()

  • Method Details

    • discoverAsset

      @PostMapping(path="/discovery-request-types/{discoveryRequestType}/assets/{assetGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse discoverAsset(@PathVariable String serverName, @PathVariable String discoveryEngineName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String discoveryRequestType, @RequestBody org.odpi.openmetadata.accessservices.discoveryengine.rest.DiscoveryRequestRequestBody requestBody)
      Request the execution of a discovery service to explore a specific asset.
      Parameters:
      serverName - name of the engine host server.
      discoveryEngineName - unique name of the discovery engine.
      userId - identifier of calling user
      assetGUID - identifier of the asset to analyze.
      discoveryRequestType - identifier of the type of discovery request to run - this determines which discovery service to run.
      requestBody - containing analysisParameters and annotationTypes
      Returns:
      unique id for the discovery request or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or DiscoveryEngineException there was a problem detected by the discovery engine.

    • scanAllAssets

      @PostMapping(path="/discovery-request-types/{discoveryRequestType}/assets") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse scanAllAssets(@PathVariable String serverName, @PathVariable String discoveryEngineName, @PathVariable String userId, @PathVariable String discoveryRequestType, @RequestBody(required=false) org.odpi.openmetadata.accessservices.discoveryengine.rest.DiscoveryRequestRequestBody requestBody)
      Request the execution of a discovery service for each asset that is stored in the asset catalog.
      Parameters:
      serverName - name of the engine host server.
      discoveryEngineName - unique name of the discovery engine.
      userId - identifier of calling user
      discoveryRequestType - identifier of the type of discovery request to run - this determines which discovery service to run.
      requestBody - containing analysisParameters and annotationTypes
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or DiscoveryEngineException there was a problem detected by the discovery engine.

    • getDiscoveryAnalysisReport

      @GetMapping(path="/discovery-analysis-reports/{discoveryRequestGUID}") public org.odpi.openmetadata.accessservices.discoveryengine.rest.DiscoveryAnalysisReportResponse getDiscoveryAnalysisReport(@PathVariable String serverName, @PathVariable String discoveryEngineName, @PathVariable String userId, @PathVariable String discoveryRequestGUID)
      Request the discovery report for a discovery request that has completed.
      Parameters:
      serverName - name of the engine host server.
      discoveryEngineName - unique name of the discovery engine.
      userId - calling user
      discoveryRequestGUID - identifier of the discovery request.
      Returns:
      discovery report or DiscoveryEngineException there was a problem detected by the discovery engine.

    • getDiscoveryReportAnnotations

      @GetMapping(path="/discovery-analysis-reports/{discoveryRequestGUID}/annotations") public org.odpi.openmetadata.accessservices.discoveryengine.rest.AnnotationListResponse getDiscoveryReportAnnotations(@PathVariable String serverName, @PathVariable String discoveryEngineName, @PathVariable String userId, @PathVariable String discoveryRequestGUID, @RequestParam int startingFrom, @RequestParam int maximumResults)
      Return the annotations linked direction to the report.
      Parameters:
      serverName - name of the engine host server.
      discoveryEngineName - unique name of the discovery engine.
      userId - calling user
      discoveryRequestGUID - identifier of the discovery request.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of annotations or DiscoveryEngineException there was a problem detected by the discovery engine.

    • getExtendedAnnotations

      @GetMapping(path="/annotations/{annotationGUID}/extended-annotations") public org.odpi.openmetadata.accessservices.discoveryengine.rest.AnnotationListResponse getExtendedAnnotations(@PathVariable String serverName, @PathVariable String discoveryEngineName, @PathVariable String userId, @PathVariable String annotationGUID, @RequestParam int startingFrom, @RequestParam int maximumResults)
      Return any annotations attached to this annotation.
      Parameters:
      serverName - name of the engine host server.
      discoveryEngineName - unique name of the discovery engine.
      userId - calling user
      annotationGUID - anchor annotation
      startingFrom - starting position in the list
      maximumResults - maximum number of annotations that can be returned.
      Returns:
      list of Annotation objects or DiscoveryEngineException there was a problem detected by the discovery engine.

    • getAnnotation

      @GetMapping(path="/annotations/{annotationGUID}") public org.odpi.openmetadata.accessservices.discoveryengine.rest.AnnotationResponse getAnnotation(@PathVariable String serverName, @PathVariable String discoveryEngineName, @PathVariable String userId, @PathVariable String annotationGUID)
      Retrieve a single annotation by unique identifier. This call is typically used to retrieve the latest values for an annotation.
      Parameters:
      serverName - name of the engine host server.
      discoveryEngineName - unique name of the discovery engine.
      userId - calling user
      annotationGUID - unique identifier of the annotation
      Returns:
      Annotation object or DiscoveryEngineException there was a problem detected by the discovery engine.