DataEngineResource (Data Engine OMAS with Spring 2.10 API)

java.lang.Object
- org.odpi.openmetadata.accessservices.dataengine.server.spring.DataEngineResource

```
@RestController
 @RequestMapping(value="/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 Summary

Constructors
Constructor and Description

DataEngineResource()
Default Constructor

Constructors
Constructor and Description
`DataEngineResource()` Default Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VoidResponse`	`addLineageMappings(String userId, String serverName, LineageMappingsRequestBody lineageMappingsRequestBody)` Add LineageMapping relationships
`GUIDResponse`	`addProcessHierarchy(String userId, String serverName, ProcessHierarchyRequestBody processHierarchyRequestBody)` Add a ProcessHierarchy relationship between Process entities
`GUIDResponse`	`createExternalDataEngine(String serverName, String userId, DataEngineRegistrationRequestBody requestBody)` Register external data engine as source of metadata by creating a software server capability entity
`GUIDResponse`	`createOrUpdatePortAlias(String userId, String serverName, PortAliasRequestBody portAliasRequestBody)` Create the PortAlias entity
`GUIDResponse`	`createOrUpdatePortImplementation(String userId, String serverName, PortImplementationRequestBody portImplementationRequestBody)` Create the PortImplementation entity
`GUIDListResponse`	`createOrUpdateProcesses(String userId, String serverName, ProcessesRequestBody processesRequestBody)` Create or update the Process entities with ports, schema types and all needed relationships
`GUIDResponse`	`createOrUpdateSchemaType(String userId, String serverName, SchemaTypeRequestBody requestBody)` Create a SchemaType entity with schema attributes and relationships
`VoidResponse`	`deleteExternalDataEngine(String userId, String serverName, DeleteRequestBody requestBody)` Delete the external data engine
`VoidResponse`	`deletePortAliases(String userId, String serverName, DeleteRequestBody requestBody)` Delete the PortAlias entity
`VoidResponse`	`deletePortImplementation(String userId, String serverName, DeleteRequestBody requestBody)` Delete the PortImplementation entity
`VoidResponse`	`deleteProcesses(String userId, String serverName, ProcessesDeleteRequestBody requestBody)` Delete the Process
`VoidResponse`	`deleteSchemaType(String userId, String serverName, DeleteRequestBody requestBody)` Remove a SchemaType entity with all the needed relationships
`GUIDResponse`	`getExternalDataEngineByQualifiedName(String serverName, String userId, String qualifiedName)` Return the unique identifier of an external data engine from a software server capability definition.
`ConnectionResponse`	`getInTopicConnection(String serverName, String userId)` Get connection details used to access Data Engine OMAS input topic
`GUIDResponse`	`upsertDatabase(String userId, String serverName, DatabaseRequestBody requestBody)` Create a Database entity with all the needed relationships
`GUIDResponse`	`upsertDataFile(String serverName, String userId, DataFileRequestBody dataFileRequestBody)` Add a DataFile asset or any of its subtype
`GUIDResponse`	`upsertRelationalTable(String userId, String serverName, RelationalTableRequestBody requestBody)` Create a RelationalTable entity with all the needed relationships

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- DataEngineResource
```
public DataEngineResource()
```
  Default Constructor

Method Detail

createExternalDataEngine

@PostMapping(path="/registration")
public GUIDResponse createExternalDataEngine(@PathVariable(value="serverName")
                                                                                String serverName,
                                                                                @PathVariable(value="userId")
                                                                                String userId,
                                                                                @RequestBody
                                                                                DataEngineRegistrationRequestBody requestBody)

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(value="userId")
                                                                                  String userId,
                                                                                  @PathVariable(value="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 port implementation
Returns:: unique identifier of the created port implementation

createOrUpdateSchemaType

@PostMapping(path="/schema-types")
public GUIDResponse createOrUpdateSchemaType(@PathVariable(value="userId")
                                                                                String userId,
                                                                                @PathVariable(value="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(value="userId")
                                                                          String userId,
                                                                          @PathVariable(value="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:: unique identifier of the created entity

createOrUpdatePortImplementation

@PostMapping(path="/port-implementations")
public GUIDResponse createOrUpdatePortImplementation(@PathVariable(value="userId")
                                                                                                String userId,
                                                                                                @PathVariable(value="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(value="userId")
                                                                                          String userId,
                                                                                          @PathVariable(value="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:: unique identifier of the created port implementation

createOrUpdatePortAlias

@PostMapping(path="/port-aliases")
public GUIDResponse createOrUpdatePortAlias(@PathVariable(value="userId")
                                                                               String userId,
                                                                               @PathVariable(value="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(value="userId")
                                                                           String userId,
                                                                           @PathVariable(value="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:: unique identifier of the created port alias

addProcessHierarchy

@PostMapping(path="/process-hierarchies")
public GUIDResponse addProcessHierarchy(@PathVariable(value="userId")
                                                                                  String userId,
                                                                                  @PathVariable(value="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

createOrUpdateProcesses

@PostMapping(path="/processes")
public GUIDListResponse createOrUpdateProcesses(@PathVariable(value="userId")
                                                                                String userId,
                                                                                @PathVariable(value="serverName")
                                                                                String serverName,
                                                                                @RequestBody
                                                                                ProcessesRequestBody processesRequestBody)

Create or update the Process entities with ports, schema types and all needed relationships

Parameters:: serverName - name of server instance to call; userId - the name of the calling user; processesRequestBody - properties of the process
Returns:: unique identifier of the created process

deleteProcesses

@DeleteMapping(path="/processes")
public VoidResponse deleteProcesses(@PathVariable(value="userId")
                                                                      String userId,
                                                                      @PathVariable(value="serverName")
                                                                      String serverName,
                                                                      @RequestBody
                                                                      ProcessesDeleteRequestBody 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:: unique identifier of the created process

addLineageMappings

@PostMapping(path="/lineage-mappings")
public VoidResponse addLineageMappings(@PathVariable(value="userId")
                                                                              String userId,
                                                                              @PathVariable(value="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(value="userId")
                                                                   String userId,
                                                                   @PathVariable(value="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

upsertRelationalTable

@PostMapping(path="/relational-tables")
public GUIDResponse upsertRelationalTable(@PathVariable(value="userId")
                                                                                  String userId,
                                                                                  @PathVariable(value="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 schema type
Returns:: unique identifier of the created entity

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:: file guid

Class DataEngineResource

Constructor Summary