Class DataEngineResource
java.lang.Object
org.odpi.openmetadata.accessservices.dataengine.server.spring.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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionorg.odpi.openmetadata.commonservices.ffdc.rest.VoidResponseaddDataFlows(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.DataFlowsRequestBody dataFlowsRequestBody) Add DataFlow relationshipsorg.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponseaddProcessHierarchy(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.ProcessHierarchyRequestBody processHierarchyRequestBody) Add a ProcessHierarchy relationship between Process entitiesorg.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponsecreateExternalDataEngine(String serverName, String userId, org.odpi.openmetadata.accessservices.dataengine.rest.DataEngineRegistrationRequestBody requestBody) Register external data engine as source of metadata by creating an engine entityorg.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponsecreateOrUpdatePortImplementation(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.PortImplementationRequestBody portImplementationRequestBody) Create the PortImplementation entityorg.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponsecreateOrUpdateProcess(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.ProcessRequestBody processRequestBody) Create or update the Process entity with ports, schema types and all needed relationshipsorg.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponsecreateOrUpdateSchemaType(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.SchemaTypeRequestBody requestBody) Create a SchemaType entity with schema attributes and relationshipsorg.odpi.openmetadata.commonservices.ffdc.rest.VoidResponsedeleteConnection(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Deletes the connectionorg.odpi.openmetadata.commonservices.ffdc.rest.VoidResponsedeleteDatabase(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Deletes the databaseorg.odpi.openmetadata.commonservices.ffdc.rest.VoidResponsedeleteDatabaseSchema(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Deletes the database schemaorg.odpi.openmetadata.commonservices.ffdc.rest.VoidResponsedeleteDataFile(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Deletes the data file with columnsorg.odpi.openmetadata.commonservices.ffdc.rest.VoidResponsedeleteEndpoint(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Deletes the connectionorg.odpi.openmetadata.commonservices.ffdc.rest.VoidResponsedeleteEventType(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Deletes the topicorg.odpi.openmetadata.commonservices.ffdc.rest.VoidResponsedeleteExternalDataEngine(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Delete the external data engineorg.odpi.openmetadata.commonservices.ffdc.rest.VoidResponsedeleteFolder(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Deletes the folderorg.odpi.openmetadata.commonservices.ffdc.rest.VoidResponsedeletePortImplementation(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Delete the PortImplementation entityorg.odpi.openmetadata.commonservices.ffdc.rest.VoidResponsedeleteProcess(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Delete the Processorg.odpi.openmetadata.commonservices.ffdc.rest.VoidResponsedeleteRelationalTable(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Deletes the relational table with columnsorg.odpi.openmetadata.commonservices.ffdc.rest.VoidResponsedeleteSchemaType(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Remove a SchemaType entity with all the needed relationshipsorg.odpi.openmetadata.commonservices.ffdc.rest.VoidResponsedeleteTopic(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Deletes the topicorg.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponsegetExternalDataEngineByQualifiedName(String serverName, String userId, String qualifiedName) Return the unique identifier of an external data engine from an engine definition.org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.rest.ConnectionResponsegetInTopicConnection(String serverName, String userId) Get connection details used to access Data Engine OMAS input topicorg.odpi.openmetadata.commonservices.ffdc.rest.PropertiesResponsegetProcessingState(String userId, String serverName, String externalSourceName) Get the data engine's processing state classification propertiesorg.odpi.openmetadata.commonservices.ffdc.rest.GUIDListResponsesearch(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.FindRequestBody findRequestBody) Find assetsorg.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponseupsertDatabase(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.DatabaseRequestBody requestBody) Create a Database entity with all the needed relationshipsorg.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponseupsertDatabaseSchema(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.DatabaseSchemaRequestBody requestBody) Create a Database Schema entity with all the a relationship to a database, if provided and not virtualorg.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponseupsertDataFile(String serverName, String userId, org.odpi.openmetadata.accessservices.dataengine.rest.DataFileRequestBody dataFileRequestBody) Add a DataFile asset or any of its subtypeorg.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponseupsertEventType(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.EventTypeRequestBody requestBody) Create or update a Event Type entity with all the needed relationshipsorg.odpi.openmetadata.commonservices.ffdc.rest.VoidResponseupsertProcessingState(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.ProcessingStateRequestBody requestBody) Create or update a processing state entity with the provided propertiesorg.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponseupsertRelationalTable(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.RelationalTableRequestBody requestBody) Create a RelationalTable entity with all the needed relationshipsorg.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponseupsertTopic(String userId, String serverName, org.odpi.openmetadata.accessservices.dataengine.rest.TopicRequestBody requestBody) Create or update a Topic entity with all the needed relationships
-
Constructor Details
-
DataEngineResource
public DataEngineResource()Default Constructor
-
-
Method Details
-
createExternalDataEngine
@PostMapping(path="/registration") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createExternalDataEngine(@PathVariable("serverName") String serverName, @PathVariable("userId") String userId, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.DataEngineRegistrationRequestBody requestBody) Register external data engine as source of metadata by creating an engine entity- Parameters:
serverName- name of server instance to calluserId- the name of the calling userrequestBody- properties of the entity- Returns:
- unique identifier of the engine
-
getExternalDataEngineByQualifiedName
@GetMapping(path="/registration/{qualifiedName}") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse getExternalDataEngineByQualifiedName(@PathVariable String serverName, @PathVariable String userId, @PathVariable String qualifiedName) Return the unique identifier of an external data engine from an engine definition.- Parameters:
serverName- name of server instance to calluserId- identifier of calling userqualifiedName- qualified name of the engine- Returns:
- unique identified of the engine
-
deleteExternalDataEngine
@DeleteMapping(path="/registration") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deleteExternalDataEngine(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Delete the external data engine- Parameters:
serverName- name of server instance to calluserId- the name of the calling userrequestBody- properties of the data engine- Returns:
- void response
-
createOrUpdateSchemaType
@PostMapping(path="/schema-types") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createOrUpdateSchemaType(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.SchemaTypeRequestBody requestBody) Create a SchemaType entity with schema attributes and relationships- Parameters:
serverName- name of server instance to calluserId- the name of the calling userrequestBody- properties for the schema type- Returns:
- unique identifier of the created entity
-
deleteSchemaType
@DeleteMapping(path="/schema-types") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deleteSchemaType(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Remove a SchemaType entity with all the needed relationships- Parameters:
serverName- name of server instance to calluserId- the name of the calling userrequestBody- properties for the schema type- Returns:
- void response
-
createOrUpdatePortImplementation
@PostMapping(path="/port-implementations") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createOrUpdatePortImplementation(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.PortImplementationRequestBody portImplementationRequestBody) Create the PortImplementation entity- Parameters:
serverName- name of server instance to calluserId- the name of the calling userportImplementationRequestBody- properties of the port implementation- Returns:
- unique identifier of the created port implementation
-
deletePortImplementation
@DeleteMapping(path="/port-implementations") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deletePortImplementation(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Delete the PortImplementation entity- Parameters:
serverName- name of server instance to calluserId- the name of the calling userrequestBody- properties of the port implementation- Returns:
- void response
-
addProcessHierarchy
@PostMapping(path="/process-hierarchies") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse addProcessHierarchy(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.ProcessHierarchyRequestBody processHierarchyRequestBody) Add a ProcessHierarchy relationship between Process entities- Parameters:
serverName- name of server instance to calluserId- the name of the calling userprocessHierarchyRequestBody- 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 org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createOrUpdateProcess(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.ProcessRequestBody processRequestBody) Create or update the Process entity with ports, schema types and all needed relationships- Parameters:
serverName- name of server instance to calluserId- the name of the calling userprocessRequestBody- properties of the process- Returns:
- unique identifier of the created process
-
deleteProcess
@DeleteMapping(path="/processes") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deleteProcess(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Delete the Process- Parameters:
serverName- name of server instance to calluserId- the name of the calling userrequestBody- properties of the process- Returns:
- void response
-
addDataFlows
@PostMapping(path="/data-flows") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addDataFlows(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.DataFlowsRequestBody dataFlowsRequestBody) Add DataFlow relationships- Parameters:
serverName- name of server instance to calluserId- the name of the calling userdataFlowsRequestBody- properties of the data flows- Returns:
- unique identifier of the created entity
-
getInTopicConnection
@GetMapping(path="/topics/in-topic-connection") public org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.rest.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 calluserId- 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 org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse upsertDatabase(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.DatabaseRequestBody requestBody) Create a Database entity with all the needed relationships- Parameters:
serverName- name of server instance to calluserId- the name of the calling userrequestBody- properties for the database- Returns:
- unique identifier of the created entity
-
deleteDatabase
@DeleteMapping(path="/databases") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deleteDatabase(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Deletes the database- Parameters:
serverName- name of server instance to calluserId- the name of the calling userrequestBody- properties for the database- Returns:
- void response
-
upsertDatabaseSchema
@PostMapping(path="/database-schemas") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse upsertDatabaseSchema(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.DatabaseSchemaRequestBody requestBody) Create a Database Schema entity with all the a relationship to a database, if provided and not virtual- Parameters:
serverName- name of server instance to calluserId- the name of the calling userrequestBody- properties for the database- Returns:
- unique identifier of the created entity
-
deleteDatabaseSchema
@DeleteMapping(path="/database-schemas") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deleteDatabaseSchema(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Deletes the database schema- Parameters:
serverName- name of server instance to calluserId- the name of the calling userrequestBody- properties for the database- Returns:
- void response
-
upsertRelationalTable
@PostMapping(path="/relational-tables") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse upsertRelationalTable(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.RelationalTableRequestBody requestBody) Create a RelationalTable entity with all the needed relationships- Parameters:
serverName- name of server instance to calluserId- the name of the calling userrequestBody- properties for the relational table- Returns:
- unique identifier of the created entity
-
deleteRelationalTable
@DeleteMapping(path="/relational-tables") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deleteRelationalTable(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Deletes the relational table with columns- Parameters:
serverName- name of server instance to calluserId- the name of the calling userrequestBody- properties for the relational table- Returns:
- void response
-
upsertDataFile
@PostMapping(path="/data-files") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse upsertDataFile(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.DataFileRequestBody dataFileRequestBody) Add a DataFile asset or any of its subtype- Parameters:
serverName- name of server instance to calluserId- name of the calling userdataFileRequestBody- properties of data file- Returns:
- unique identifier of the created entity
-
deleteDataFile
@DeleteMapping(path="/data-files") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deleteDataFile(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Deletes the data file with columns- Parameters:
serverName- name of server instance to calluserId- the name of the calling userrequestBody- properties for the data file- Returns:
- void response
-
deleteFolder
@DeleteMapping(path="/folders") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deleteFolder(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Deletes the folder- Parameters:
serverName- name of server instance to calluserId- the name of the calling userrequestBody- properties for the folder- Returns:
- void response
-
deleteConnection
@DeleteMapping(path="/connections") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deleteConnection(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Deletes the connection- Parameters:
serverName- name of server instance to calluserId- the name of the calling userrequestBody- properties for the connection- Returns:
- void response
-
deleteEndpoint
@DeleteMapping(path="/endpoints") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deleteEndpoint(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Deletes the connection- Parameters:
serverName- name of server instance to calluserId- the name of the calling userrequestBody- properties for the connection- Returns:
- void response
-
search
@PostMapping(path="/find") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDListResponse search(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.FindRequestBody findRequestBody) Find assets- Parameters:
serverName- name of server instance to calluserId- the name of the calling userfindRequestBody- properties for the connection- Returns:
- asset if found
-
upsertTopic
@PostMapping(path="/topics") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse upsertTopic(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.TopicRequestBody requestBody) Create or update a Topic entity with all the needed relationships- Parameters:
serverName- name of server instance to calluserId- the name of the calling userrequestBody- properties for the topic- Returns:
- unique identifier of the created entity
-
deleteTopic
@DeleteMapping(path="/topics") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deleteTopic(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Deletes the topic- Parameters:
serverName- name of server instance to calluserId- the name of the calling userrequestBody- properties for the database- Returns:
- void response
-
upsertEventType
@PostMapping(path="/event-types") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse upsertEventType(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.EventTypeRequestBody requestBody) Create or update a Event Type entity with all the needed relationships- Parameters:
serverName- name of server instance to calluserId- the name of the calling userrequestBody- properties for the event type- Returns:
- unique identifier of the created entity
-
deleteEventType
@DeleteMapping(path="/event-types") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deleteEventType(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody requestBody) Deletes the topic- Parameters:
serverName- name of server instance to calluserId- the name of the calling userrequestBody- properties for the database- Returns:
- void response
-
upsertProcessingState
@PostMapping(path="/processing-state") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse upsertProcessingState(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestBody org.odpi.openmetadata.accessservices.dataengine.rest.ProcessingStateRequestBody requestBody) Create or update a processing state entity with the provided properties- Parameters:
serverName- name of server instance to calluserId- the name of the calling userrequestBody- properties of the processing state- Returns:
- void response
-
getProcessingState
@GetMapping(path="/processing-state") public org.odpi.openmetadata.commonservices.ffdc.rest.PropertiesResponse getProcessingState(@PathVariable("userId") String userId, @PathVariable("serverName") String serverName, @RequestParam("dataEngine") String externalSourceName) Get the data engine's processing state classification properties- Parameters:
serverName- name of server instance to calluserId- the name of the calling user- Returns:
- PropertiesResponse response
-