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	createArtifact(String serverName, String userId, String serverCapability, String artifact) Create assets in repository defined by artifact (body of the request).
AnalyticsModelingOMASAPIResponse	getDatabases(String serverName, String userId, @PositiveOrZero(message="startFrom should be a positive number") Integer startFrom, @PositiveOrZero(message="pageSize should be a positive number") Integer pageSize) Get list of databases.
AnalyticsModelingOMASAPIResponse	getPhysicalModule(String serverName, String userId, String database, String catalog, String schema, ModuleTableFilter request) Get physical module of a given database, catalog and schema.
AnalyticsModelingOMASAPIResponse	getSchemas(String serverName, String userId, String database, @PositiveOrZero(message="startFrom should be a positive number") Integer startFrom, @PositiveOrZero(message="pageSize should be a positive number") Integer pageSize) Get list of schemas of a given database.
AnalyticsModelingOMASAPIResponse	getTables(String serverName, String userId, String database, String catalog, String schema, Object request) Get list of tables of a given database, 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,
                                                                                    @PositiveOrZero(message="startFrom should be a positive number") @RequestParam
                                                                                    @PositiveOrZero(message="startFrom should be a positive number") Integer startFrom,
                                                                                    @PositiveOrZero(message="pageSize should be a positive number") @RequestParam
                                                                                    @PositiveOrZero(message="pageSize should be a positive number") Integer pageSize)

Get list of databases.

Parameters:

serverName - unique identifier for requested server.

userId - the unique identifier for the user

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

Returns:

Analytics Modeling response contains list of databases.

getSchemas

@GetMapping(path="/{databaseGUID}/schemas")
public AnalyticsModelingOMASAPIResponse getSchemas(@PathVariable(value="serverName")
                                                                                               String serverName,
                                                                                               @PathVariable(value="userId")
                                                                                               String userId,
                                                                                               @PathVariable(value="databaseGUID")
                                                                                               String database,
                                                                                               @PositiveOrZero(message="startFrom should be a positive number") @RequestParam
                                                                                               @PositiveOrZero(message="startFrom should be a positive number") Integer startFrom,
                                                                                               @PositiveOrZero(message="pageSize should be a positive number") @RequestParam
                                                                                               @PositiveOrZero(message="pageSize should be a positive number") Integer pageSize)

Get list of schemas of a given database.

Parameters:

serverName - unique identifier for requested server.

userId - the unique identifier for the user

database - database GUID.

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

Returns:

Analytics Modeling response contains list of database schemas.

getTables

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

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

Parameters:

serverName - unique identifier for requested server.

userId - the unique identifier for the user

database - 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="/{databaseGUID}/physicalModule")
public AnalyticsModelingOMASAPIResponse getPhysicalModule(@PathVariable(value="serverName")
                                                                                                              String serverName,
                                                                                                              @PathVariable(value="userId")
                                                                                                              String userId,
                                                                                                              @PathVariable(value="databaseGUID")
                                                                                                              String database,
                                                                                                              @RequestParam(required=false)
                                                                                                              String catalog,
                                                                                                              @RequestParam(required=true)
                                                                                                              String schema,
                                                                                                              @RequestBody(required=false)
                                                                                                              ModuleTableFilter request)

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

Parameters:

serverName - unique identifier for requested server.

userId - the unique identifier for the user

database - database guid.

catalog - of the db.

schema - of the db.

request - body.

Returns:

Analytics Modeling module for the database schema.

createArtifact

@PostMapping(path="/sync")
public AnalyticsModelingOMASAPIResponse createArtifact(@PathVariable(value="serverName")
                                                                                  String serverName,
                                                                                  @PathVariable(value="userId")
                                                                                  String userId,
                                                                                  @RequestParam(required=true)
                                                                                  String serverCapability,
                                                                                  @RequestBody(required=true)
                                                                                  String artifact)

Create assets in repository defined by artifact (body of the request).

Parameters:

serverName - unique identifier for requested server.

userId - request user

serverCapability - where the artifact is stored.

artifact - definition json.

Returns:

errors or list of created assets.