@RestController
@RequestMapping(value="/servers/{serverName}/open-metadata/engine-services/asset-analysis/users/{userId}/discovery-engines/{discoveryEngineName}")
public class DiscoveryEngineResource
extends Object
| Constructor and Description |
|---|
DiscoveryEngineResource() |
| Modifier and Type | Method and Description |
|---|---|
GUIDResponse |
discoverAsset(String serverName,
String discoveryEngineName,
String userId,
String assetGUID,
String discoveryRequestType,
DiscoveryRequestRequestBody requestBody)
Request the execution of a discovery service to explore a specific asset.
|
AnnotationResponse |
getAnnotation(String serverName,
String discoveryEngineName,
String userId,
String annotationGUID)
Retrieve a single annotation by unique identifier.
|
DiscoveryAnalysisReportResponse |
getDiscoveryAnalysisReport(String serverName,
String discoveryEngineName,
String userId,
String discoveryRequestGUID)
Request the discovery report for a discovery request that has completed.
|
AnnotationListResponse |
getDiscoveryReportAnnotations(String serverName,
String discoveryEngineName,
String userId,
String discoveryRequestGUID,
int startingFrom,
int maximumResults)
Return the annotations linked direction to the report.
|
AnnotationListResponse |
getExtendedAnnotations(String serverName,
String discoveryEngineName,
String userId,
String annotationGUID,
int startingFrom,
int maximumResults)
Return any annotations attached to this annotation.
|
VoidResponse |
scanAllAssets(String serverName,
String discoveryEngineName,
String userId,
String discoveryRequestType,
DiscoveryRequestRequestBody requestBody)
Request the execution of a discovery service for each asset that is stored in the asset catalog.
|
@PostMapping(path="/discovery-request-types/{discoveryRequestType}/assets/{assetGUID}")
public GUIDResponse discoverAsset(@PathVariable
String serverName,
@PathVariable
String discoveryEngineName,
@PathVariable
String userId,
@PathVariable
String assetGUID,
@PathVariable
String discoveryRequestType,
@RequestBody
DiscoveryRequestRequestBody requestBody)
serverName - name of the engine host server.discoveryEngineName - unique name of the discovery engine.userId - identifier of calling userassetGUID - 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@PostMapping(path="/discovery-request-types/{discoveryRequestType}/assets")
public VoidResponse scanAllAssets(@PathVariable
String serverName,
@PathVariable
String discoveryEngineName,
@PathVariable
String userId,
@PathVariable
String discoveryRequestType,
@RequestBody(required=false)
DiscoveryRequestRequestBody requestBody)
serverName - name of the engine host server.discoveryEngineName - unique name of the discovery engine.userId - identifier of calling userdiscoveryRequestType - identifier of the type of discovery request to run - this determines which discovery service to run.requestBody - containing analysisParameters and annotationTypes@GetMapping(path="/discovery-analysis-reports/{discoveryRequestGUID}")
public DiscoveryAnalysisReportResponse getDiscoveryAnalysisReport(@PathVariable
String serverName,
@PathVariable
String discoveryEngineName,
@PathVariable
String userId,
@PathVariable
String discoveryRequestGUID)
serverName - name of the engine host server.discoveryEngineName - unique name of the discovery engine.userId - calling userdiscoveryRequestGUID - identifier of the discovery request.@GetMapping(path="/discovery-analysis-reports/{discoveryRequestGUID}/annotations")
public AnnotationListResponse getDiscoveryReportAnnotations(@PathVariable
String serverName,
@PathVariable
String discoveryEngineName,
@PathVariable
String userId,
@PathVariable
String discoveryRequestGUID,
@RequestParam
int startingFrom,
@RequestParam
int maximumResults)
serverName - name of the engine host server.discoveryEngineName - unique name of the discovery engine.userId - calling userdiscoveryRequestGUID - identifier of the discovery request.startingFrom - initial position in the stored list.maximumResults - maximum number of definitions to return on this call.@GetMapping(path="/annotations/{annotationGUID}/extended-annotations")
public AnnotationListResponse getExtendedAnnotations(@PathVariable
String serverName,
@PathVariable
String discoveryEngineName,
@PathVariable
String userId,
@PathVariable
String annotationGUID,
@RequestParam
int startingFrom,
@RequestParam
int maximumResults)
serverName - name of the engine host server.discoveryEngineName - unique name of the discovery engine.userId - calling userannotationGUID - anchor annotationstartingFrom - starting position in the listmaximumResults - maximum number of annotations that can be returned.@GetMapping(path="/annotations/{annotationGUID}")
public AnnotationResponse getAnnotation(@PathVariable
String serverName,
@PathVariable
String discoveryEngineName,
@PathVariable
String userId,
@PathVariable
String annotationGUID)
serverName - name of the engine host server.discoveryEngineName - unique name of the discovery engine.userId - calling userannotationGUID - unique identifier of the annotationCopyright © 2018–2021 LF AI & Data Foundation. All rights reserved.