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

Class DataEngineResource

  • @RestController
@RequestMapping("/servers/{serverName}/open-metadata/access-services/data-engine/users/{userId}")
public class DataEngineResource
extends Object
    The DataEngineResource provides the server-side implementation of the Data Engine Open Metadata Assess Service (OMAS). This interface facilitates the creation of processes, ports and schema types, with all the needed relationships.

    • Constructor Detail

      • DataEngineResource

        public DataEngineResource()
        Default Constructor

    • Method Detail

      • createExternalDataEngine

        @PostMapping(path="/registration")
public GUIDResponse createExternalDataEngine​(@PathVariable("serverName")
                                             String serverName,
                                             @PathVariable("userId")
                                             String userId,
                                             @RequestBody
                                             DataEngineRegistrationRequestBody requestBody)
        Register external data engine as source of metadata by creating a software server capability entity
        Parameters:
        serverName - name of server instance to call
        userId - the name of the calling user
        requestBody - properties of the entity
        Returns:
        unique identifier of the software server capability

      • getExternalDataEngineByQualifiedName

        @GetMapping(path="/registration/{qualifiedName}")
public GUIDResponse getExternalDataEngineByQualifiedName​(@PathVariable
                                                         String serverName,
                                                         @PathVariable
                                                         String userId,
                                                         @PathVariable
                                                         String qualifiedName)
        Return the unique identifier of an external data engine from a software server capability definition.
        Parameters:
        serverName - name of server instance to call
        userId - identifier of calling user
        qualifiedName - qualified name of the software server capability
        Returns:
        unique identified of the software server capability

      • deleteExternalDataEngine

        @DeleteMapping(path="/registration")
public VoidResponse deleteExternalDataEngine​(@PathVariable("userId")
                                             String userId,
                                             @PathVariable("serverName")
                                             String serverName,
                                             @RequestBody
                                             DeleteRequestBody requestBody)
        Delete the external data engine
        Parameters:
        serverName - name of server instance to call
        userId - the name of the calling user
        requestBody - properties of the data engine
        Returns:
        void response

      • createOrUpdateSchemaType

        @PostMapping(path="/schema-types")
public GUIDResponse createOrUpdateSchemaType​(@PathVariable("userId")
                                             String userId,
                                             @PathVariable("serverName")
                                             String serverName,
                                             @RequestBody
                                             SchemaTypeRequestBody requestBody)
        Create a SchemaType entity with schema attributes and relationships
        Parameters:
        serverName - name of server instance to call
        userId - the name of the calling user
        requestBody - properties for the schema type
        Returns:
        unique identifier of the created entity

      • deleteSchemaType

        @DeleteMapping(path="/schema-types")
public VoidResponse deleteSchemaType​(@PathVariable("userId")
                                     String userId,
                                     @PathVariable("serverName")
                                     String serverName,
                                     @RequestBody
                                     DeleteRequestBody requestBody)
        Remove a SchemaType entity with all the needed relationships
        Parameters:
        serverName - name of server instance to call
        userId - the name of the calling user
        requestBody - properties for the schema type
        Returns:
        void response

      • createOrUpdatePortImplementation

        @PostMapping(path="/port-implementations")
public GUIDResponse createOrUpdatePortImplementation​(@PathVariable("userId")
                                                     String userId,
                                                     @PathVariable("serverName")
                                                     String serverName,
                                                     @RequestBody
                                                     PortImplementationRequestBody portImplementationRequestBody)
        Create the PortImplementation entity
        Parameters:
        serverName - name of server instance to call
        userId - the name of the calling user
        portImplementationRequestBody - properties of the port implementation
        Returns:
        unique identifier of the created port implementation

      • deletePortImplementation

        @DeleteMapping(path="/port-implementations")
public VoidResponse deletePortImplementation​(@PathVariable("userId")
                                             String userId,
                                             @PathVariable("serverName")
                                             String serverName,
                                             @RequestBody
                                             DeleteRequestBody requestBody)
        Delete the PortImplementation entity
        Parameters:
        serverName - name of server instance to call
        userId - the name of the calling user
        requestBody - properties of the port implementation
        Returns:
        void response

      • createOrUpdatePortAlias

        @PostMapping(path="/port-aliases")
public GUIDResponse createOrUpdatePortAlias​(@PathVariable("userId")
                                            String userId,
                                            @PathVariable("serverName")
                                            String serverName,
                                            @RequestBody
                                            PortAliasRequestBody portAliasRequestBody)
        Create the PortAlias entity
        Parameters:
        serverName - name of server instance to call
        userId - the name of the calling user
        portAliasRequestBody - properties of the port alias
        Returns:
        unique identifier of the created port alias

      • deletePortAliases

        @DeleteMapping(path="/port-aliases")
public VoidResponse deletePortAliases​(@PathVariable("userId")
                                      String userId,
                                      @PathVariable("serverName")
                                      String serverName,
                                      @RequestBody
                                      DeleteRequestBody requestBody)
        Delete the PortAlias entity
        Parameters:
        serverName - name of server instance to call
        userId - the name of the calling user
        requestBody - properties of the port implementation
        Returns:
        void response

      • addProcessHierarchy

        @PostMapping(path="/process-hierarchies")
public GUIDResponse addProcessHierarchy​(@PathVariable("userId")
                                        String userId,
                                        @PathVariable("serverName")
                                        String serverName,
                                        @RequestBody
                                        ProcessHierarchyRequestBody processHierarchyRequestBody)
        Add a ProcessHierarchy relationship between Process entities
        Parameters:
        serverName - name of server instance to call
        userId - the name of the calling user
        processHierarchyRequestBody - properties of the process hierarchy
        Returns:
        the unique identifier (guid) of the child of the process hierarchy that was updated

      • createOrUpdateProcess

        @PostMapping(path="/processes")
public GUIDResponse createOrUpdateProcess​(@PathVariable("userId")
                                          String userId,
                                          @PathVariable("serverName")
                                          String serverName,
                                          @RequestBody
                                          ProcessRequestBody processRequestBody)
        Create or update the Process entity with ports, schema types and all needed relationships
        Parameters:
        serverName - name of server instance to call
        userId - the name of the calling user
        processRequestBody - properties of the process
        Returns:
        unique identifier of the created process

      • deleteProcess

        @DeleteMapping(path="/processes")
public VoidResponse deleteProcess​(@PathVariable("userId")
                                  String userId,
                                  @PathVariable("serverName")
                                  String serverName,
                                  @RequestBody
                                  DeleteRequestBody requestBody)
        Delete the Process
        Parameters:
        serverName - name of server instance to call
        userId - the name of the calling user
        requestBody - properties of the process
        Returns:
        void response

      • addLineageMappings

        @PostMapping(path="/lineage-mappings")
public VoidResponse addLineageMappings​(@PathVariable("userId")
                                       String userId,
                                       @PathVariable("serverName")
                                       String serverName,
                                       @RequestBody
                                       LineageMappingsRequestBody lineageMappingsRequestBody)
        Add LineageMapping relationships
        Parameters:
        serverName - name of server instance to call
        userId - the name of the calling user
        lineageMappingsRequestBody - properties of the mappings
        Returns:
        unique identifier of the created entity

      • getInTopicConnection

        @GetMapping(path="/topics/in-topic-connection")
public ConnectionResponse getInTopicConnection​(@PathVariable
                                               String serverName,
                                               @PathVariable
                                               String userId)
        Get connection details used to access Data Engine OMAS input topic
        Parameters:
        serverName - name of server instance to call
        userId - name of the calling user
        Returns:
        OCF API ConnectionResponse object describing the details for the in topic connection used 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

      • upsertDatabase

        @PostMapping(path="/databases")
public GUIDResponse upsertDatabase​(@PathVariable("userId")
                                   String userId,
                                   @PathVariable("serverName")
                                   String serverName,
                                   @RequestBody
                                   DatabaseRequestBody requestBody)
        Create a Database entity with all the needed relationships
        Parameters:
        serverName - name of server instance to call
        userId - the name of the calling user
        requestBody - properties for the database
        Returns:
        unique identifier of the created entity

      • deleteDatabase

        @DeleteMapping(path="/databases")
public VoidResponse deleteDatabase​(@PathVariable("userId")
                                   String userId,
                                   @PathVariable("serverName")
                                   String serverName,
                                   @RequestBody
                                   DeleteRequestBody requestBody)
        Deletes the database
        Parameters:
        serverName - name of server instance to call
        userId - the name of the calling user
        requestBody - properties for the database
        Returns:
        void response

      • upsertRelationalTable

        @PostMapping(path="/relational-tables")
public GUIDResponse upsertRelationalTable​(@PathVariable("userId")
                                          String userId,
                                          @PathVariable("serverName")
                                          String serverName,
                                          @RequestBody
                                          RelationalTableRequestBody requestBody)
        Create a RelationalTable entity with all the needed relationships
        Parameters:
        serverName - name of server instance to call
        userId - the name of the calling user
        requestBody - properties for the relational table
        Returns:
        unique identifier of the created entity

      • deleteRelationalTable

        @DeleteMapping(path="/relational-tables")
public VoidResponse deleteRelationalTable​(@PathVariable("userId")
                                          String userId,
                                          @PathVariable("serverName")
                                          String serverName,
                                          @RequestBody
                                          DeleteRequestBody requestBody)
        Deletes the relational table with columns
        Parameters:
        serverName - name of server instance to call
        userId - the name of the calling user
        requestBody - properties for the relational table
        Returns:
        void response

      • upsertDataFile

        @PostMapping(path="/data-files")
public GUIDResponse upsertDataFile​(@PathVariable
                                   String serverName,
                                   @PathVariable
                                   String userId,
                                   @RequestBody
                                   DataFileRequestBody dataFileRequestBody)
        Add a DataFile asset or any of its subtype
        Parameters:
        serverName - name of server instance to call
        userId - name of the calling user
        dataFileRequestBody - properties of data file
        Returns:
        unique identifier of the created entity

      • deleteDataFile

        @DeleteMapping(path="/data-files")
public VoidResponse deleteDataFile​(@PathVariable("userId")
                                   String userId,
                                   @PathVariable("serverName")
                                   String serverName,
                                   @RequestBody
                                   DeleteRequestBody requestBody)
        Deletes the data file with columns
        Parameters:
        serverName - name of server instance to call
        userId - the name of the calling user
        requestBody - properties for the data file
        Returns:
        void response

      • deleteFolder

        @DeleteMapping(path="/folders")
public VoidResponse deleteFolder​(@PathVariable("userId")
                                 String userId,
                                 @PathVariable("serverName")
                                 String serverName,
                                 @RequestBody
                                 DeleteRequestBody requestBody)
        Deletes the folder
        Parameters:
        serverName - name of server instance to call
        userId - the name of the calling user
        requestBody - properties for the folder
        Returns:
        void response

      • deleteConnection

        @DeleteMapping(path="/connections")
public VoidResponse deleteConnection​(@PathVariable("userId")
                                     String userId,
                                     @PathVariable("serverName")
                                     String serverName,
                                     @RequestBody
                                     DeleteRequestBody requestBody)
        Deletes the connection
        Parameters:
        serverName - name of server instance to call
        userId - the name of the calling user
        requestBody - properties for the connection
        Returns:
        void response

      • deleteEndpoint

        @DeleteMapping(path="/endpoints")
public VoidResponse deleteEndpoint​(@PathVariable("userId")
                                   String userId,
                                   @PathVariable("serverName")
                                   String serverName,
                                   @RequestBody
                                   DeleteRequestBody requestBody)
        Deletes the connection
        Parameters:
        serverName - name of server instance to call
        userId - the name of the calling user
        requestBody - properties for the connection
        Returns:
        void response