org.odpi.openmetadata.accessservices.dataplatform.server.spring

Class DataPlatformOMASResource

java.lang.Object

org.odpi.openmetadata.accessservices.dataplatform.server.spring.DataPlatformOMASResource

@RestController
 @RequestMapping(value="/servers/{serverName}/open-metadata/access-services/data-platform/users/{userId}")
public class DataPlatformOMASResource
extends Object

The type Data platform omas resource.

Constructor Summary

Constructors

Constructor and Description
DataPlatformOMASResource() Instantiates a new Data Platform omas resource.

Method Summary

Modifier and Type	Method and Description
GUIDResponse	createDeployedDatabaseSchema(String serverName, String userId, DeployedDatabaseSchemaRequestBody requestBody)
GUIDResponse	createExternalDataPlatform(String serverName, String userId, DataPlatformRegistrationRequestBody requestBody) Create a software server capability entity
DataPlatformRegistrationRequestBody	getExternalDataPlatformByQualifiedName(String serverName, String userId, String qualifiedName) Return the software server capability entity from an external data platform by qualified name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataPlatformOMASResource

public DataPlatformOMASResource()

Instantiates a new Data Platform omas resource.

Method Detail

createExternalDataPlatform

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

Create 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 created process

getExternalDataPlatformByQualifiedName

@GetMapping(path="/software-server-capability/{qualifiedName}")
public DataPlatformRegistrationRequestBody getExternalDataPlatformByQualifiedName(@PathVariable
                                                                                                                                                  String serverName,
                                                                                                                                                  @PathVariable
                                                                                                                                                  String userId,
                                                                                                                                                  @PathVariable
                                                                                                                                                  String qualifiedName)

Return the software server capability entity from an external data platform by qualified name.

Parameters:

serverName - the server name

userId - the user id

qualifiedName - the qualified name

Returns:

the software server capability by qualified name

createDeployedDatabaseSchema

@PostMapping(path="/deployed-database-schema")
public GUIDResponse createDeployedDatabaseSchema(@PathVariable(value="serverName")
                                                                                                String serverName,
                                                                                                @PathVariable(value="userId")
                                                                                                String userId,
                                                                                                @RequestBody
                                                                                                DeployedDatabaseSchemaRequestBody requestBody)