Package org.odpi.openmetadata.adminservices.spring

Class DataEngineProxyResource

java.lang.Object

org.odpi.openmetadata.adminservices.spring.DataEngineProxyResource

@RestController
@RequestMapping("/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	Description
DataEngineProxyResource()

Method Summary

Modifier and Type	Method	Description
org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse	deleteDataEngineProxy(String userId, String serverName)	Remove this Data Engine Proxy from the server configuration.
org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse	setDataEngineProxyConfig(String userId, String serverName, org.odpi.openmetadata.adminservices.configuration.properties.DataEngineProxyConfig dataEngineProxyConfig)	Store the provided Data Engine Proxy configuration

Methods inherited from class java.lang.Object

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

Constructor Details

DataEngineProxyResource

public DataEngineProxyResource()

Method Details

setDataEngineProxyConfig

@PostMapping(path="/configuration")
public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setDataEngineProxyConfig(@PathVariable
 String userId,
 @PathVariable
 String serverName,
 @RequestBody
 org.odpi.openmetadata.adminservices.configuration.properties.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 org.odpi.openmetadata.commonservices.ffdc.rest.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