@RestController
@RequestMapping(value="/servers/{serverName}/open-metadata/access-services/discovery-engine/users/{userId}")
public class DiscoveryMetadataStoreResource
extends Object
| Constructor and Description |
|---|
DiscoveryMetadataStoreResource()
Default constructor
|
| Modifier and Type | Method and Description |
|---|---|
GUIDResponse |
addAnnotationToAnnotation(String serverName,
String userId,
String parentAnnotationGUID,
Annotation requestBody)
Add a new annotation and link it to an existing annotation.
|
GUIDResponse |
addAnnotationToDataField(String serverName,
String userId,
String parentDataFieldGUID,
Annotation annotation)
Add a new annotation and link it to an existing data field.
|
GUIDResponse |
addAnnotationToDiscoveryReport(String serverName,
String userId,
String discoveryReportGUID,
Annotation requestBody)
Add a new annotation to the annotation store as a top level annotation linked directly off of the report.
|
GUIDResponse |
addDataFieldToDataField(String serverName,
String userId,
String parentDataFieldGUID,
DataField dataField)
Add a new data field and link it to an existing data field.
|
GUIDResponse |
addDataFieldToDiscoveryReport(String serverName,
String userId,
String annotationGUID,
DataField dataField)
Add a new data field to the Annotation store linked off of an annotation (typically SchemaAnalysisAnnotation).
|
GUIDResponse |
createDiscoveryAnalysisReport(String serverName,
String userId,
String assetGUID,
DiscoveryAnalysisReportRequestBody requestBody)
Create a new discovery analysis report and chain it to its asset, discovery engine and discovery service.
|
VoidResponse |
deleteAnnotation(String serverName,
String userId,
String annotationGUID,
NullRequestBody requestBody)
Remove an annotation from the annotation store.
|
VoidResponse |
deleteDataField(String serverName,
String userId,
String dataFieldGUID,
NullRequestBody requestBody)
Remove a data field from the annotation store.
|
GUIDListResponse |
findAssets(String serverName,
String userId,
String searchString,
int startFrom,
int pageSize)
Return a list of assets with the requested search string in their name, qualified name
or description.
|
GUIDListResponse |
findAssetsByEndpoint(String serverName,
String userId,
String networkAddress,
int startFrom,
int pageSize)
Return the list of assets that have the same endpoint address.
|
AnnotationResponse |
getAnnotation(String serverName,
String userId,
String annotationGUID)
Retrieve a single annotation by unique identifier.
|
AnnotationListResponse |
getAnnotationsForAssetByStatus(String serverName,
String userId,
String assetGUID,
int startingFrom,
int maximumResults,
StatusRequestBody requestBody)
Return the list of annotations from previous runs of the discovery service that are set to a specific status.
|
GUIDListResponse |
getAssets(String serverName,
String userId,
int startFrom,
int pageSize)
Return the next set of assets to process.
|
GUIDListResponse |
getAssetsByName(String serverName,
String userId,
String name,
int startFrom,
int pageSize)
Return the list of matching assets that have the supplied name as either the
qualified name or display name.
|
GUIDListResponse |
getAssetsByQualifiedName(String serverName,
String userId,
String name,
int startFrom,
int pageSize)
Return the assets with the same qualified name.
|
DataFieldResponse |
getDataField(String serverName,
String userId,
String dataFieldGUID)
Return a specific data field stored in the annotation store (previous or new).
|
DiscoveryAnalysisReportResponse |
getDiscoveryReport(String serverName,
String userId,
String discoveryReportGUID)
Request the discovery report for a discovery request that has completed.
|
AnnotationListResponse |
getDiscoveryReportAnnotations(String serverName,
String userId,
String discoveryReportGUID,
int startingFrom,
int maximumResults)
Return the annotations linked directly to the report.
|
AnnotationListResponse |
getExtendedAnnotations(String serverName,
String userId,
String annotationGUID,
int startingFrom,
int maximumResults)
Return any annotations attached to this annotation.
|
DataFieldListResponse |
getNestedDataFields(String serverName,
String userId,
String parentDataFieldGUID,
int startingFrom,
int maximumResults)
Return any annotations attached to this annotation.
|
DataFieldListResponse |
getNewDataFieldsForAsset(String serverName,
String userId,
String discoveryReportGUID,
int startingFrom,
int maximumResults)
Return the current list of data fields for this discovery run.
|
DataFieldListResponse |
getPreviousDataFieldsForAsset(String serverName,
String userId,
String discoveryReportGUID,
int startingFrom,
int maximumResults)
Return the list of data fields from previous runs of the discovery service.
|
NameListResponse |
getTypesOfAnnotation(String serverName,
String userId)
Return the annotation subtype names.
|
StringMapResponse |
getTypesOfAnnotationWithDescriptions(String serverName,
String userId)
Return the annotation subtype names mapped to their descriptions.
|
VoidResponse |
logAssetAuditMessage(String serverName,
String userId,
String assetGUID,
String discoveryService,
String message)
Log an audit message about this asset.
|
VoidResponse |
updateAnnotation(String serverName,
String userId,
String annotationGUID,
Annotation requestBody)
Replace the current properties of an annotation.
|
VoidResponse |
updateDataField(String serverName,
String userId,
String dataFieldGUID,
DataField dataField)
Replace the current properties of a data field.
|
VoidResponse |
updateDiscoveryAnalysisReport(String serverName,
String userId,
String discoveryReportGUID,
DiscoveryAnalysisReport requestBody)
Update the properties of the discovery analysis report.
|
public DiscoveryMetadataStoreResource()
@GetMapping(path="/assets") public GUIDListResponse getAssets(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize)
serverName - name of server instance to route request touserId - calling userstartFrom - starting point of the querypageSize - maximum number of results to return@PostMapping(path="/assets/by-qualified-name") public GUIDListResponse getAssetsByQualifiedName(@PathVariable String serverName, @PathVariable String userId, @RequestBody String name, @RequestParam int startFrom, @RequestParam int pageSize)
serverName - name of server instance to route request touserId - calling username - the qualified name to query onstartFrom - place to start in querypageSize - number of results to return@PostMapping(path="/assets/by-name") public GUIDListResponse getAssetsByName(@PathVariable String serverName, @PathVariable String userId, @RequestBody String name, @RequestParam int startFrom, @RequestParam int pageSize)
serverName - name of server instance to route request touserId - calling username - name to query forstartFrom - place to start in querypageSize - number of results to return@PostMapping(path="/assets/by-search-string") public GUIDListResponse findAssets(@PathVariable String serverName, @PathVariable String userId, @RequestBody String searchString, @RequestParam int startFrom, @RequestParam int pageSize)
serverName - name of server instance to route request touserId - calling usersearchString - string to search for in textstartFrom - starting element (used in paging through large result sets)pageSize - maximum number of results to return@PostMapping(path="/assets/by-endpoint-address") public GUIDListResponse findAssetsByEndpoint(@PathVariable String serverName, @PathVariable String userId, @RequestBody String networkAddress, @RequestParam int startFrom, @RequestParam int pageSize)
serverName - name of server instance to route request touserId - calling usernetworkAddress - address to query onstartFrom - place to start in querypageSize - number of results to return@PostMapping(path="/assets/{assetGUID}/log-records/{discoveryService}")
public VoidResponse logAssetAuditMessage(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String assetGUID,
@PathVariable
String discoveryService,
@RequestBody
String message)
serverName - name of server instance to route request touserId - userId of user making request.assetGUID - unique identifier for asset.discoveryService - unique name for discoveryService.message - message to log@PostMapping(path="/assets/{assetGUID}/discovery-analysis-reports")
public GUIDResponse createDiscoveryAnalysisReport(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String assetGUID,
@RequestBody
DiscoveryAnalysisReportRequestBody requestBody)
serverName - name of server instance to route request touserId - calling userassetGUID - unique identifier of the asset being analysedrequestBody - all of the other parameters@PostMapping(path="/discovery-analysis-reports/{discoveryReportGUID}")
public VoidResponse updateDiscoveryAnalysisReport(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String discoveryReportGUID,
@RequestBody
DiscoveryAnalysisReport requestBody)
serverName - name of server instance to route request touserId - calling userdiscoveryReportGUID - unique identifier of the report to updaterequestBody - updated report - this will replace what was previous stored@GetMapping(path="/discovery-analysis-reports/{discoveryReportGUID}")
public DiscoveryAnalysisReportResponse getDiscoveryReport(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String discoveryReportGUID)
serverName - name of server instance to route request touserId - identifier of calling userdiscoveryReportGUID - identifier of the discovery request.@GetMapping(path="/annotations/sub-types") public NameListResponse getTypesOfAnnotation(@PathVariable String serverName, @PathVariable String userId)
serverName - name of the server instance to connect touserId - calling user@GetMapping(path="/annotations/sub-types/descriptions") public StringMapResponse getTypesOfAnnotationWithDescriptions(@PathVariable String serverName, @PathVariable String userId)
serverName - name of the server instance to connect touserId - calling user@GetMapping(path="/assets/{assetGUID}/annotations")
public AnnotationListResponse getAnnotationsForAssetByStatus(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String assetGUID,
@RequestParam
int startingFrom,
@RequestParam
int maximumResults,
@RequestBody
StatusRequestBody requestBody)
serverName - name of server instance to route request touserId - calling userassetGUID - unique identifier of the assetstartingFrom - starting position in the list.maximumResults - maximum number of elements that can be returnedrequestBody - status value to use on the query@GetMapping(path="/discovery-analysis-reports/{discoveryReportGUID}/annotations")
public AnnotationListResponse getDiscoveryReportAnnotations(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String discoveryReportGUID,
@RequestParam
int startingFrom,
@RequestParam
int maximumResults)
serverName - name of server instance to route request touserId - identifier of calling userdiscoveryReportGUID - 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 userId,
@PathVariable
String annotationGUID,
@RequestParam
int startingFrom,
@RequestParam
int maximumResults)
serverName - name of server instance to route request touserId - identifier of calling userannotationGUID - parent 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 userId,
@PathVariable
String annotationGUID)
serverName - name of server instance to route request touserId - identifier of calling userannotationGUID - unique identifier of the annotation@PostMapping(path="/discovery-analysis-reports/{discoveryReportGUID}/annotations")
public GUIDResponse addAnnotationToDiscoveryReport(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String discoveryReportGUID,
@RequestBody
Annotation requestBody)
serverName - name of server instance to route request touserId - identifier of calling userdiscoveryReportGUID - unique identifier of the discovery analysis reportrequestBody - annotation object@PostMapping(path="/annotations/{parentAnnotationGUID}/extended-annotations")
public GUIDResponse addAnnotationToAnnotation(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String parentAnnotationGUID,
@RequestBody
Annotation requestBody)
serverName - name of server instance to route request touserId - identifier of calling userparentAnnotationGUID - unique identifier of the annotation that this new one os to be attached torequestBody - annotation object@PostMapping(path="/annotations/{annotationGUID}/update")
public VoidResponse updateAnnotation(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String annotationGUID,
@RequestBody
Annotation requestBody)
serverName - name of server instance to route request touserId - identifier of calling userannotationGUID - identifier of the annotation to changerequestBody - new properties@PostMapping(path="/annotations/{annotationGUID}/delete")
public VoidResponse deleteAnnotation(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String annotationGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of server instance to route request touserId - identifier of calling userannotationGUID - unique identifier of the annotationrequestBody - null request body to satisfy POST semantics@GetMapping(path="/discovery-analysis-reports/{discoveryReportGUID}/data-fields/previous")
public DataFieldListResponse getPreviousDataFieldsForAsset(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String discoveryReportGUID,
@RequestParam
int startingFrom,
@RequestParam
int maximumResults)
serverName - name of server instance to route request touserId - identifier of calling userdiscoveryReportGUID - unique identifier of the discovery analysis reportstartingFrom - starting position in the list.maximumResults - maximum number of elements that can be returned@GetMapping(path="/discovery-analysis-reports/{discoveryReportGUID}/data-fields")
public DataFieldListResponse getNewDataFieldsForAsset(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String discoveryReportGUID,
@RequestParam
int startingFrom,
@RequestParam
int maximumResults)
serverName - name of server instance to route request touserId - identifier of calling userdiscoveryReportGUID - unique identifier of the discovery analysis reportstartingFrom - starting position in the list.maximumResults - maximum number of elements that can be returned@GetMapping(path="/data-fields/{parentDataFieldGUID}/nested-data-fields")
public DataFieldListResponse getNestedDataFields(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String parentDataFieldGUID,
@RequestParam
int startingFrom,
@RequestParam
int maximumResults)
serverName - name of server instance to route request touserId - identifier of calling userparentDataFieldGUID - parent data field identifierstartingFrom - starting position in the listmaximumResults - maximum number of annotations that can be returned.@GetMapping(path="/data-fields/{dataFieldGUID}")
public DataFieldResponse getDataField(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String dataFieldGUID)
serverName - name of server instance to route request touserId - identifier of calling userdataFieldGUID - unique identifier of the data field@PostMapping(path="/annotations/{annotationGUID}/data-fields")
public GUIDResponse addDataFieldToDiscoveryReport(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String annotationGUID,
@RequestBody
DataField dataField)
serverName - name of server instance to route request touserId - identifier of calling userannotationGUID - unique identifier of the annotation that the data field is to be linked todataField - dataField object@PostMapping(path="/data-fields/{parentDataFieldGUID}/nested-data-fields")
public GUIDResponse addDataFieldToDataField(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String parentDataFieldGUID,
@RequestBody
DataField dataField)
serverName - name of server instance to route request touserId - identifier of calling userparentDataFieldGUID - unique identifier of the data field that this new one is to be attached todataField - data field object@PostMapping(path="/data-fields/{parentDataFieldGUID}/annotations")
public GUIDResponse addAnnotationToDataField(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String parentDataFieldGUID,
@RequestBody
Annotation annotation)
serverName - name of server instance to route request touserId - identifier of calling userparentDataFieldGUID - unique identifier of the data field that this new one is to be attached toannotation - data field object@PostMapping(path="/data-fields/{dataFieldGUID}/update")
public VoidResponse updateDataField(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String dataFieldGUID,
@RequestBody
DataField dataField)
serverName - name of server instance to route request touserId - identifier of calling userdataFieldGUID - unique identifier of data fielddataField - new properties@PostMapping(path="/data-fields/{dataFieldGUID}/delete")
public VoidResponse deleteDataField(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String dataFieldGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of server instance to route request touserId - identifier of calling userdataFieldGUID - unique identifier of the data fieldCopyright © 2018–2021 LF AI & Data Foundation. All rights reserved.