org.odpi.openmetadata.accessservices.dataplatform

Interface DataPlatformInterface

All Known Implementing Classes:

DataPlatformClient

public interface DataPlatformInterface

DataPlatformInterface provides the interface for managing information about data assets hosted on a data platform. The DataInfrastructureInterface provides methods for describing the infrastructure of the data platform.

Method Summary

Modifier and Type	Method and Description
GUIDResponse	createDeployedDatabaseSchema(String userId, DeployedDatabaseSchema deployedDatabaseSchema) Create deployed database schema asset.
GUIDResponse	createExternalDataPlatform(String userId, SoftwareServerCapability softwareServerCapability) Create the software server capability entity for registering data platforms as external source.

Method Detail

createExternalDataPlatform

GUIDResponse createExternalDataPlatform(String userId,
                                        SoftwareServerCapability softwareServerCapability)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Create the software server capability entity for registering data platforms as external source.

Parameters:

userId - the name of the calling user

softwareServerCapability - the software server capability bean

Returns:

unique identifier of the server in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

createDeployedDatabaseSchema

GUIDResponse createDeployedDatabaseSchema(String userId,
                                          DeployedDatabaseSchema deployedDatabaseSchema)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

Create deployed database schema asset.

Parameters:

userId - the user id

deployedDatabaseSchema - the deployed database schema

Returns:

the string

Throws:

InvalidParameterException - the invalid parameter exception

UserNotAuthorizedException - the user not authorized exception

PropertyServerException - the property server exception