@RestController
@RequestMapping(value="/servers/{serverName}/open-metadata/access-services/discovery-engine/users/{userId}")
public class DiscoveryConfigurationResource
extends Object
| Constructor and Description |
|---|
DiscoveryConfigurationResource() |
| Modifier and Type | Method and Description |
|---|---|
GUIDResponse |
createDiscoveryEngine(String serverName,
String userId,
NewDiscoveryEngineRequestBody requestBody)
Create a new discovery engine definition.
|
GUIDResponse |
createDiscoveryService(String serverName,
String userId,
NewDiscoveryServiceRequestBody requestBody)
Create a discovery service definition.
|
VoidResponse |
deleteDiscoveryEngine(String serverName,
String userId,
String guid,
DeleteRequestBody requestBody)
Remove the properties of the discovery engine.
|
VoidResponse |
deleteDiscoveryService(String serverName,
String userId,
String guid,
DeleteRequestBody requestBody)
Remove the properties of the discovery service.
|
DiscoveryEngineListResponse |
getAllDiscoveryEngines(String serverName,
String userId,
int startingFrom,
int maximumResults)
Return the list of discovery engine definitions that are stored.
|
DiscoveryServiceListResponse |
getAllDiscoveryServices(String serverName,
String userId,
int startingFrom,
int maximumResults)
Return the list of discovery services definitions that are stored.
|
DiscoveryEnginePropertiesResponse |
getDiscoveryEngineByGUID(String serverName,
String userId,
String guid)
Return the properties from a discovery engine definition.
|
DiscoveryEnginePropertiesResponse |
getDiscoveryEngineByName(String serverName,
String userId,
String name)
Return the properties from a discovery engine definition.
|
DiscoveryServicePropertiesResponse |
getDiscoveryServiceByGUID(String serverName,
String userId,
String guid)
Return the properties from a discovery service definition.
|
DiscoveryServicePropertiesResponse |
getDiscoveryServiceByName(String serverName,
String userId,
String name)
Return the properties from a discovery service definition.
|
GUIDListResponse |
getDiscoveryServiceRegistrations(String serverName,
String userId,
String guid)
Return the list of discovery engines that a specific discovery service is registered with.
|
ConnectionResponse |
getOutTopicConnection(String serverName,
String userId,
String callerId)
Return the connection object for the Discovery Engine OMAS's out topic.
|
RegisteredDiscoveryServiceResponse |
getRegisteredDiscoveryService(String serverName,
String userId,
String discoveryEngineGUID,
String discoveryServiceGUID)
Retrieve a specific discovery service registered with a discovery engine.
|
GUIDListResponse |
getRegisteredDiscoveryServices(String serverName,
String userId,
String discoveryEngineGUID,
int startingFrom,
int maximumResults)
Retrieve the identifiers of the discovery services registered with a discovery engine.
|
VoidResponse |
registerDiscoveryServiceWithEngine(String serverName,
String userId,
String guid,
DiscoveryServiceRegistrationRequestBody requestBody)
Register a discovery service with a specific discovery engine.
|
VoidResponse |
unregisterDiscoveryServiceFromEngine(String serverName,
String userId,
String discoveryEngineGUID,
String discoveryServiceGUID,
NullRequestBody requestBody)
Unregister a discovery service from the discovery engine.
|
VoidResponse |
updateDiscoveryEngine(String serverName,
String userId,
String guid,
UpdateDiscoveryEngineRequestBody requestBody)
Update the properties of an existing discovery engine definition.
|
VoidResponse |
updateDiscoveryService(String serverName,
String userId,
String guid,
UpdateDiscoveryServiceRequestBody requestBody)
Update the properties of an existing discovery service definition.
|
@GetMapping(path="/topics/out-topic-connection/{callerId}")
public ConnectionResponse getOutTopicConnection(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String callerId)
serverName - name of the service to route the request to.userId - identifier of calling user.callerId - unique identifier of the caller@PostMapping(path="/discovery-engines") public GUIDResponse createDiscoveryEngine(@PathVariable String serverName, @PathVariable String userId, @RequestBody NewDiscoveryEngineRequestBody requestBody)
serverName - name of the service to route the request to.userId - identifier of calling user.requestBody - containing:
qualifiedName - unique name for the discovery engine;
displayName - display name for messages and user interfaces;
description - description of the types of discovery services that wil be associated with
this discovery engine.@GetMapping(path="/discovery-engines/{guid}")
public DiscoveryEnginePropertiesResponse getDiscoveryEngineByGUID(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid)
serverName - name of the service to route the request to.userId - identifier of calling user.guid - unique identifier (guid) of the discovery engine definition.@GetMapping(path="/discovery-engines/by-name/{name}")
public DiscoveryEnginePropertiesResponse getDiscoveryEngineByName(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String name)
serverName - name of the service to route the request to.userId - identifier of calling user.name - qualified name or display name (if unique).@GetMapping(path="/discovery-engines") public DiscoveryEngineListResponse getAllDiscoveryEngines(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startingFrom, @RequestParam int maximumResults)
serverName - name of the service to route the request to.userId - identifier of calling user.startingFrom - initial position in the stored list.maximumResults - maximum number of definitions to return on this call.@PostMapping(path="/discovery-engines/{guid}")
public VoidResponse updateDiscoveryEngine(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid,
@RequestBody
UpdateDiscoveryEngineRequestBody requestBody)
serverName - name of the service to route the request to.userId - identifier of calling user.guid - unique identifier of the discovery engine - used to locate the definition.requestBody - containing the new properties of the discovery engine.@PostMapping(path="/discovery-engines/{guid}/delete")
public VoidResponse deleteDiscoveryEngine(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid,
@RequestBody
DeleteRequestBody requestBody)
serverName - name of the service to route the request to.userId - identifier of calling user.guid - unique identifier of the discovery engine - used to locate the definition.requestBody - containing the unique name for the discovery engine.@PostMapping(path="/discovery-services") public GUIDResponse createDiscoveryService(@PathVariable String serverName, @PathVariable String userId, @RequestBody NewDiscoveryServiceRequestBody requestBody)
serverName - name of the service to route the request to.userId - identifier of calling user.requestBody - containing:
qualifiedName - unique name for the discovery service;
displayName - display name for the discovery service;
description - description of the analysis provided by the discovery service;
connection - connection to instantiate the discovery service implementation.@GetMapping(path="/discovery-services/{guid}")
public DiscoveryServicePropertiesResponse getDiscoveryServiceByGUID(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid)
serverName - name of the service to route the request to.userId - identifier of calling user.guid - unique identifier (guid) of the discovery service definition.@GetMapping(path="/discovery-services/by-name/{name}")
public DiscoveryServicePropertiesResponse getDiscoveryServiceByName(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String name)
serverName - name of the service to route the request to.userId - identifier of calling user.name - qualified name or display name (if unique).@GetMapping(path="/discovery-services") public DiscoveryServiceListResponse getAllDiscoveryServices(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startingFrom, @RequestParam int maximumResults)
serverName - name of the service to route the request to.userId - identifier of calling user.startingFrom - initial position in the stored list.maximumResults - maximum number of definitions to return on this call.@GetMapping(path="/discovery-services/{guid}/registrations")
public GUIDListResponse getDiscoveryServiceRegistrations(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid)
serverName - name of the service to route the request to.userId - identifier of calling user.guid - discovery service to search for.@PostMapping(path="/discovery-services/{guid}")
public VoidResponse updateDiscoveryService(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid,
@RequestBody
UpdateDiscoveryServiceRequestBody requestBody)
serverName - name of the service to route the request to.userId - identifier of calling user.guid - unique identifier of the discovery service - used to locate the definition.requestBody - containing the new parameters for the discovery service.@PostMapping(path="/discovery-services/{guid}/delete")
public VoidResponse deleteDiscoveryService(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid,
@RequestBody
DeleteRequestBody requestBody)
serverName - name of the service to route the request to.userId - identifier of calling user.guid - unique identifier of the discovery service - used to locate the definition.requestBody - containing the unique name for the discovery service.@PostMapping(path="/discovery-engines/{guid}/discovery-services")
public VoidResponse registerDiscoveryServiceWithEngine(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid,
@RequestBody
DiscoveryServiceRegistrationRequestBody requestBody)
serverName - name of the service to route the request to.userId - identifier of calling user.guid - unique identifier of the discovery engine.requestBody - containing:
guid - unique identifier of the discovery service;
discoveryRequestTypes - list of asset discovery types that this discovery service is able to process.@GetMapping(path="/discovery-engines/{discoveryEngineGUID}/discovery-services/{discoveryServiceGUID}")
public RegisteredDiscoveryServiceResponse getRegisteredDiscoveryService(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String discoveryEngineGUID,
@PathVariable
String discoveryServiceGUID)
serverName - name of the service to route the request to.userId - identifier of calling user.discoveryEngineGUID - unique identifier of the discovery engine.discoveryServiceGUID - unique identifier of the discovery service.@GetMapping(path="/discovery-engines/{discoveryEngineGUID}/discovery-services")
public GUIDListResponse getRegisteredDiscoveryServices(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String discoveryEngineGUID,
@RequestParam
int startingFrom,
@RequestParam
int maximumResults)
serverName - name of the service to route the request to.userId - identifier of calling user.discoveryEngineGUID - unique identifier of the discovery engine.startingFrom - initial position in the stored list.maximumResults - maximum number of definitions to return on this call.@PostMapping(path="/discovery-engines/{discoveryEngineGUID}/discovery-services/{discoveryServiceGUID}/delete")
public VoidResponse unregisterDiscoveryServiceFromEngine(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String discoveryEngineGUID,
@PathVariable
String discoveryServiceGUID,
@RequestBody
NullRequestBody requestBody)
serverName - name of the service to route the request to.userId - identifier of calling user.discoveryEngineGUID - unique identifier of the discovery engine.discoveryServiceGUID - unique identifier of the discovery service.requestBody - null request body.Copyright © 2018–2021 LF AI & Data Foundation. All rights reserved.