org.odpi.openmetadata.adminservices.spring

Class DataEngineProxyResource

java.lang.Object

org.odpi.openmetadata.adminservices.spring.DataEngineProxyResource

@RestController
 @RequestMapping(value="/open-metadata/admin-services/users/{userId}/servers/{serverName}/data-engine-proxy-service")
public class DataEngineProxyResource
extends Object

DataEngineProxyResource provides the API for configuring a data engine proxy in an OMAG server.

Constructor Summary

Constructors

Constructor and Description
DataEngineProxyResource()

Method Summary

Modifier and Type	Method and Description
VoidResponse	deleteDataEngineProxy(String userId, String serverName) Remove this Data Engine Proxy from the server configuration.
VoidResponse	setDataEngineProxyConfig(String userId, String serverName, DataEngineProxyConfig dataEngineProxyConfig) Store the provided Data Engine Proxy configuration

Methods inherited from class java.lang.Object

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

Constructor Detail

DataEngineProxyResource

public DataEngineProxyResource()

Method Detail

setDataEngineProxyConfig

@PostMapping(path="/configuration")
public VoidResponse setDataEngineProxyConfig(@PathVariable
                                                                                 String userId,
                                                                                 @PathVariable
                                                                                 String serverName,
                                                                                 @RequestBody
                                                                                 DataEngineProxyConfig dataEngineProxyConfig)

Store the provided Data Engine Proxy configuration

Parameters:

userId - user that is issuing the request

serverName - local server name

dataEngineProxyConfig - configuration for the data engine proxy

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or accessServicesConfig parameter.

deleteDataEngineProxy

@DeleteMapping(path="")
public VoidResponse deleteDataEngineProxy(@PathVariable
                                                                  String userId,
                                                                  @PathVariable
                                                                  String serverName)

Remove this Data Engine Proxy from the server configuration.

Parameters:

userId - user that is issuing the request

serverName - local server name

Returns:

void response