org.odpi.openmetadata.accessservices.analyticsmodeling.server.spring

Class AnalyticsModelingOMASResource

java.lang.Object

org.odpi.openmetadata.accessservices.analyticsmodeling.server.spring.AnalyticsModelingOMASResource

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

Constructor Summary

Constructors

Constructor and Description
AnalyticsModelingOMASResource()

Method Summary

Modifier and Type	Method and Description
AnalyticsModelingOMASAPIResponse	getDatabases(String serverName, String userId) Get list of databases.
AnalyticsModelingOMASAPIResponse	getPhysicalModule(String serverName, String userId, String dataSource, String catalog, String schema, Object request) Get physical module of a given dataSource, catalog and schema.
AnalyticsModelingOMASAPIResponse	getSchemas(String serverName, String userId, String dataSource) Get list of schemas of a given dataSource.
AnalyticsModelingOMASAPIResponse	getTables(String serverName, String userId, String dataSource, String catalog, String schema, Object request) Get list of tables of a given dataSource, catalog and schema.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalyticsModelingOMASResource

public AnalyticsModelingOMASResource()

Method Detail

getDatabases

@GetMapping(path="/databases")
public AnalyticsModelingOMASAPIResponse getDatabases(@PathVariable(value="serverName")
                                                                                    String serverName,
                                                                                    @PathVariable(value="userId")
                                                                                    String userId)

Get list of databases.

Parameters:

serverName - unique identifier for requested server.

userId - the unique identifier for the user

Returns:

Analytics Modeling response contains list of databases.

getSchemas

@GetMapping(path="/{dataSourceGUID}/schemas")
public AnalyticsModelingOMASAPIResponse getSchemas(@PathVariable(value="serverName")
                                                                                                 String serverName,
                                                                                                 @PathVariable(value="userId")
                                                                                                 String userId,
                                                                                                 @PathVariable(value="dataSourceGUID")
                                                                                                 String dataSource)

Get list of schemas of a given dataSource.

Parameters:

serverName - unique identifier for requested server.

userId - the unique identifier for the user

dataSource - data source GUID.

Returns:

Analytics Modeling response contains list of database schemas.

getTables

@PostMapping(path="/{dataSourceGUID}/tables")
public AnalyticsModelingOMASAPIResponse getTables(@PathVariable(value="serverName")
                                                                                                String serverName,
                                                                                                @PathVariable(value="userId")
                                                                                                String userId,
                                                                                                @PathVariable(value="dataSourceGUID")
                                                                                                String dataSource,
                                                                                                @RequestParam(required=false)
                                                                                                String catalog,
                                                                                                @RequestParam(required=true)
                                                                                                String schema,
                                                                                                @RequestBody(required=false)
                                                                                                Object request)

Get list of tables of a given dataSource, catalog and schema.

Parameters:

serverName - unique identifier for requested server.

userId - the unique identifier for the user

dataSource - data source id.

catalog - of the db.

schema - of the db.

request - body.

Returns:

Analytics Modeling response contains list of tables in the database schema.

getPhysicalModule

@PostMapping(path="/{dataSourceGUID}/physicalModule")
public AnalyticsModelingOMASAPIResponse getPhysicalModule(@PathVariable(value="serverName")
                                                                                                                String serverName,
                                                                                                                @PathVariable(value="userId")
                                                                                                                String userId,
                                                                                                                @PathVariable(value="dataSourceGUID")
                                                                                                                String dataSource,
                                                                                                                @RequestParam(required=false)
                                                                                                                String catalog,
                                                                                                                @RequestParam(required=true)
                                                                                                                String schema,
                                                                                                                @RequestBody(required=false)
                                                                                                                Object request)

Get physical module of a given dataSource, catalog and schema.

Parameters:

serverName - unique identifier for requested server.

userId - the unique identifier for the user

dataSource - data source id.

catalog - of the db.

schema - of the db.

request - body.

Returns:

Analytics Modeling module for the database schema.