Package org.odpi.openmetadata.accessservices.discoveryengine.server.spring

Class DiscoveryConfigurationResource

  • @RestController
@RequestMapping("/servers/{serverName}/open-metadata/access-services/discovery-engine/users/{userId}")
public class DiscoveryConfigurationResource
extends Object
    DiscoveryConfigurationResource provides the Spring wrapper for the DiscoveryConfigurationServices

    • Constructor Detail

      • DiscoveryConfigurationResource

        public DiscoveryConfigurationResource()

    • Method Detail

      • getOutTopicConnection

        @GetMapping(path="/topics/out-topic-connection/{callerId}")
public ConnectionResponse getOutTopicConnection​(@PathVariable
                                                String serverName,
                                                @PathVariable
                                                String userId,
                                                @PathVariable
                                                String callerId)
        Return the connection object for the Discovery Engine OMAS's out topic.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        callerId - unique identifier of the caller
        Returns:
        connection object for the out topic or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem retrieving the discovery engine definition.

      • createDiscoveryEngine

        @PostMapping(path="/discovery-engines")
public GUIDResponse createDiscoveryEngine​(@PathVariable
                                          String serverName,
                                          @PathVariable
                                          String userId,
                                          @RequestBody
                                          NewDiscoveryEngineRequestBody requestBody)
        Create a new discovery engine definition.
        Parameters:
        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.
        Returns:
        unique identifier (guid) of the discovery engine definition or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • getDiscoveryEngineByGUID

        @GetMapping(path="/discovery-engines/{guid}")
public DiscoveryEnginePropertiesResponse getDiscoveryEngineByGUID​(@PathVariable
                                                                  String serverName,
                                                                  @PathVariable
                                                                  String userId,
                                                                  @PathVariable
                                                                  String guid)
        Return the properties from a discovery engine definition.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        guid - unique identifier (guid) of the discovery engine definition.
        Returns:
        properties from the discovery engine definition or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • getDiscoveryEngineByName

        @GetMapping(path="/discovery-engines/by-name/{name}")
public DiscoveryEnginePropertiesResponse getDiscoveryEngineByName​(@PathVariable
                                                                  String serverName,
                                                                  @PathVariable
                                                                  String userId,
                                                                  @PathVariable
                                                                  String name)
        Return the properties from a discovery engine definition.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        name - qualified name or display name (if unique).
        Returns:
        properties from the discovery engine definition or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • getAllDiscoveryEngines

        @GetMapping(path="/discovery-engines")
public DiscoveryEngineListResponse getAllDiscoveryEngines​(@PathVariable
                                                          String serverName,
                                                          @PathVariable
                                                          String userId,
                                                          @RequestParam
                                                          int startingFrom,
                                                          @RequestParam
                                                          int maximumResults)
        Return the list of discovery engine definitions that are stored.
        Parameters:
        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.
        Returns:
        list of discovery engine definitions or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • updateDiscoveryEngine

        @PostMapping(path="/discovery-engines/{guid}")
public VoidResponse updateDiscoveryEngine​(@PathVariable
                                          String serverName,
                                          @PathVariable
                                          String userId,
                                          @PathVariable
                                          String guid,
                                          @RequestBody
                                          UpdateDiscoveryEngineRequestBody requestBody)
        Update the properties of an existing discovery engine definition. Use the current value to keep a property value the same, or use the new value. Null means remove the property from the definition.
        Parameters:
        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.
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • deleteDiscoveryEngine

        @PostMapping(path="/discovery-engines/{guid}/delete")
public VoidResponse deleteDiscoveryEngine​(@PathVariable
                                          String serverName,
                                          @PathVariable
                                          String userId,
                                          @PathVariable
                                          String guid,
                                          @RequestBody
                                          DeleteRequestBody requestBody)
        Remove the properties of the discovery engine. Both the guid and the qualified name is supplied to validate that the correct discovery engine is being deleted.
        Parameters:
        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.
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • createDiscoveryService

        @PostMapping(path="/discovery-services")
public GUIDResponse createDiscoveryService​(@PathVariable
                                           String serverName,
                                           @PathVariable
                                           String userId,
                                           @RequestBody
                                           NewDiscoveryServiceRequestBody requestBody)
        Create a discovery service definition. The same discovery service can be associated with multiple discovery engines.
        Parameters:
        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.
        Returns:
        unique identifier of the discovery service or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • getDiscoveryServiceByGUID

        @GetMapping(path="/discovery-services/{guid}")
public DiscoveryServicePropertiesResponse getDiscoveryServiceByGUID​(@PathVariable
                                                                    String serverName,
                                                                    @PathVariable
                                                                    String userId,
                                                                    @PathVariable
                                                                    String guid)
        Return the properties from a discovery service definition.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        guid - unique identifier (guid) of the discovery service definition.
        Returns:
        properties of the discovery service or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • getDiscoveryServiceByName

        @GetMapping(path="/discovery-services/by-name/{name}")
public DiscoveryServicePropertiesResponse getDiscoveryServiceByName​(@PathVariable
                                                                    String serverName,
                                                                    @PathVariable
                                                                    String userId,
                                                                    @PathVariable
                                                                    String name)
        Return the properties from a discovery service definition.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        name - qualified name or display name (if unique).
        Returns:
        properties from the discovery engine definition or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • getAllDiscoveryServices

        @GetMapping(path="/discovery-services")
public DiscoveryServiceListResponse getAllDiscoveryServices​(@PathVariable
                                                            String serverName,
                                                            @PathVariable
                                                            String userId,
                                                            @RequestParam
                                                            int startingFrom,
                                                            @RequestParam
                                                            int maximumResults)
        Return the list of discovery services definitions that are stored.
        Parameters:
        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.
        Returns:
        list of discovery service definitions or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • getDiscoveryServiceRegistrations

        @GetMapping(path="/discovery-services/{guid}/registrations")
public GUIDListResponse getDiscoveryServiceRegistrations​(@PathVariable
                                                         String serverName,
                                                         @PathVariable
                                                         String userId,
                                                         @PathVariable
                                                         String guid)
        Return the list of discovery engines that a specific discovery service is registered with.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        guid - discovery service to search for.
        Returns:
        list of discovery engine unique identifiers (guids) or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • updateDiscoveryService

        @PostMapping(path="/discovery-services/{guid}")
public VoidResponse updateDiscoveryService​(@PathVariable
                                           String serverName,
                                           @PathVariable
                                           String userId,
                                           @PathVariable
                                           String guid,
                                           @RequestBody
                                           UpdateDiscoveryServiceRequestBody requestBody)
        Update the properties of an existing discovery service definition. Use the current value to keep a property value the same, or use the new value. Null means remove the property from the definition.
        Parameters:
        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.
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • deleteDiscoveryService

        @PostMapping(path="/discovery-services/{guid}/delete")
public VoidResponse deleteDiscoveryService​(@PathVariable
                                           String serverName,
                                           @PathVariable
                                           String userId,
                                           @PathVariable
                                           String guid,
                                           @RequestBody
                                           DeleteRequestBody requestBody)
        Remove the properties of the discovery service. Both the guid and the qualified name is supplied to validate that the correct discovery service is being deleted. The discovery service is also unregistered from its discovery engines.
        Parameters:
        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.
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • registerDiscoveryServiceWithEngine

        @PostMapping(path="/discovery-engines/{guid}/discovery-services")
public VoidResponse registerDiscoveryServiceWithEngine​(@PathVariable
                                                       String serverName,
                                                       @PathVariable
                                                       String userId,
                                                       @PathVariable
                                                       String guid,
                                                       @RequestBody
                                                       DiscoveryServiceRegistrationRequestBody requestBody)
        Register a discovery service with a specific discovery engine.
        Parameters:
        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.
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • getRegisteredDiscoveryService

        @GetMapping(path="/discovery-engines/{discoveryEngineGUID}/discovery-services/{discoveryServiceGUID}")
public RegisteredDiscoveryServiceResponse getRegisteredDiscoveryService​(@PathVariable
                                                                        String serverName,
                                                                        @PathVariable
                                                                        String userId,
                                                                        @PathVariable
                                                                        String discoveryEngineGUID,
                                                                        @PathVariable
                                                                        String discoveryServiceGUID)
        Retrieve a specific discovery service registered with a discovery engine.
        Parameters:
        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.
        Returns:
        details of the discovery service and the asset types it is registered for or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • getRegisteredDiscoveryServices

        @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)
        Retrieve the identifiers of the discovery services registered with a discovery engine.
        Parameters:
        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.
        Returns:
        list of unique identifiers or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • unregisterDiscoveryServiceFromEngine

        @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)
        Unregister a discovery service from the discovery engine.
        Parameters:
        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.
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.