A C D F G M O P R S U W

A

addDataFileToCatalog(String, String, DataFileRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Add a simple asset description linked to a connection object for a file and to the folder structure implied in the path name.

addDataFileToCatalogFromTemplate(String, String, String, TemplateRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Add an asset description a file based on the content of a template object.

addDataFolderAssetToCatalog(String, String, DataFolderRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Creates a new folder asset that is identified as a data asset.

addDataFolderToCatalogFromTemplate(String, String, String, TemplateRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Creates a new folder asset that is identified as a data asset using a template.

addForeignKeyRelationship(String, String, String, String, String, String, DatabaseForeignKeyProperties) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Create a foreign relationship between two columns.

archiveDataFileInCatalog(String, String, String, ArchiveRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Mark the file asset description in the catalog as archived.

archiveDataFolderInCatalog(String, String, String, ArchiveRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Mark the data folder asset description in the catalog as archived.

attachDataFileAssetToFolder(String, String, String, String, MetadataSourceRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Link an existing file asset to a folder.

attachFolderToFileSystem(String, String, String, String, MetadataSourceRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Links a folder to a file system.

C

createDatabase(String, String, String, String, DatabaseProperties) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Create a new metadata element to represent a database.

createDatabaseColumn(String, String, String, String, String, DatabaseColumnProperties) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Create a new metadata element to represent a database column.

createDatabaseColumnFromTemplate(String, String, String, String, String, String, TemplateProperties) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Create a new metadata element to represent a database column using an existing metadata element as a template.

createDatabaseFromTemplate(String, String, String, String, String, TemplateProperties) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Create a new metadata element to represent a database using an existing metadata element as a template.

createDatabaseManager(String, String, DatabaseManagerRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DataManagerOMASResource

Create information about the database manager (DBMS) that manages database schemas.

createDatabaseSchema(String, String, String, String, String, DatabaseSchemaProperties) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Create a new metadata element to represent a database schema.

createDatabaseSchemaFromTemplate(String, String, String, String, String, String, TemplateProperties) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Create a new metadata element to represent a database schema using an existing metadata element as a template.

createDatabaseTable(String, String, String, String, String, DatabaseTableProperties) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Create a new metadata element to represent a database table.

createDatabaseTableFromTemplate(String, String, String, String, String, String, TemplateProperties) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Create a new metadata element to represent a database table using an existing metadata element as a template.

createDatabaseView(String, String, String, String, String, DatabaseViewProperties) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Create a new metadata element to represent a database view.

createDatabaseViewFromTemplate(String, String, String, String, String, String, TemplateProperties) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Create a new metadata element to represent a database view using an existing metadata element as a template.

createFileManagerInCatalog(String, String, FileManagerRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DataManagerOMASResource

Files can be owned by a file manager.

createFileSystemInCatalog(String, String, FileSystemRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DataManagerOMASResource

Files live on a file system.

createFolderStructureInCatalog(String, String, String, PathNameRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Creates a new folder asset for each element in the pathName that is linked from the file server capability entity.

D

DatabaseManagerResource - Class in org.odpi.openmetadata.accessservices.datamanager.server.spring

DatabaseManagerRESTServices is the server-side implementation of the Data Manager OMAS's support for relational databases.

DatabaseManagerResource() - Constructor for class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Default constructor

DataManagerOMASResource - Class in org.odpi.openmetadata.accessservices.datamanager.server.spring

Server-side REST API support for data manager independent REST endpoints

DataManagerOMASResource() - Constructor for class org.odpi.openmetadata.accessservices.datamanager.server.spring.DataManagerOMASResource

Instantiates a new Data Manager OMAS resource.

deleteDataFileFromCatalog(String, String, String, PathNameRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Remove the file asset description from the catalog.

deleteDataFolderFromCatalog(String, String, String, PathNameRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Remove the data folder asset description from the catalog.

detachDataFileAssetFromFolder(String, String, String, String, MetadataSourceRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Remove a link between a file asset and a folder.

detachFolderFromFileSystem(String, String, String, String, MetadataSourceRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Removed the link between a folder and a file system.

F

FilesResource - Class in org.odpi.openmetadata.accessservices.datamanager.server.spring

FilesResource supports the server-side capture of REST calls to add new file-based asset definitions.

FilesResource() - Constructor for class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Default constructor

findDatabaseColumns(String, String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Retrieve the list of database column metadata elements that contain the search string.

findDatabases(String, String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Retrieve the list of database metadata elements that contain the search string.

findDatabaseSchemas(String, String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Retrieve the list of database schema metadata elements that contain the search string.

findDatabaseTables(String, String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Retrieve the list of database table metadata elements that contain the search string.

findDatabaseViews(String, String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Retrieve the list of database view metadata elements that contain the search string.

findDataFilesByPathName(String, String, int, int, PathNameRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Retrieve data files by the supplied wildcard name.

G

getColumnsForDatabaseTable(String, String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Retrieve the list of column for a database table (or view)

getDatabaseByGUID(String, String, String) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Retrieve the database metadata element with the supplied unique identifier.

getDatabaseColumnByGUID(String, String, String) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Retrieve the database column metadata element with the supplied unique identifier.

getDatabaseColumnsByName(String, String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Retrieve the list of database column metadata elements with a matching qualified or display name.

getDatabasesByName(String, String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Retrieve the list of database metadata elements with a matching qualified or display name.

getDatabaseSchemaByGUID(String, String, String) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Retrieve the database schema metadata element with the supplied unique identifier.

getDatabaseSchemasByName(String, String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Retrieve the list of database schema metadata elements with a matching qualified or display name.

getDatabasesForDatabaseManager(String, String, String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Retrieve the list of databases created by this database manager.

getDatabaseTableByGUID(String, String, String) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Retrieve the database table metadata element with the supplied unique identifier.

getDatabaseTablesByName(String, String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Retrieve the list of database table metadata elements with a matching qualified or display name.

getDatabaseViewByGUID(String, String, String) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Retrieve the database view metadata element with the supplied unique identifier.

getDatabaseViewsByName(String, String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Retrieve the list of database view metadata elements with a matching qualified or display name.

getDataFileByGUID(String, String, String) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Retrieve a data file asset by its unique identifier (GUID).

getDataFileByPathName(String, String, PathNameRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Retrieve a data file by its fully qualified path name.

getFileSystemByGUID(String, String, String) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Retrieve a FileSystemProperties asset by its unique identifier (GUID).

getFileSystemByUniqueName(String, String, String) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Retrieve a FileSystemProperties asset by its unique name.

getFileSystems(String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Retrieve a list of defined FileSystems assets.

getFolderByGUID(String, String, String) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Retrieve a folder asset by its unique identifier (GUID).

getFolderByPathName(String, String, PathNameRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Retrieve a folder by its fully qualified path name.

getFolderFiles(String, String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Get the files inside a folder - both those that are nested and those that are linked.

getMetadataSourceGUID(String, String, String) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DataManagerOMASResource

Retrieve the unique identifier of the software server capability representing a metadata source.

getNestedFolders(String, String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Return the list of folders nested inside a folder.

getOutTopicConnection(String, String, String) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DataManagerOMASResource

Return the connection object for the Data Manager OMAS's out topic.

getSchemasForDatabase(String, String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Return the list of schemas associated with a database.

getTablesForDatabaseSchema(String, String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Retrieve the list of database tables associated with a database schema.

getTopLevelFolders(String, String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Return the list of folders nested inside a folder.

getViewsForDatabaseSchema(String, String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Retrieve the list of database views associated with a database schema.

M

moveDataFileInCatalog(String, String, String, String, MetadataSourceRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Move a data file from its current parent folder to a new parent folder - this changes the file's qualified name but not its unique identifier (guid).

moveDataFolderInCatalog(String, String, String, String, MetadataSourceRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Move a data folder from its current parent folder to a new parent folder - this changes the folder's qualified name but not its unique identifier (guid).

O

org.odpi.openmetadata.accessservices.datamanager.server.spring - package org.odpi.openmetadata.accessservices.datamanager.server.spring

REST API operations and Swagger Annotations The data manager has 3 parts to its REST API.

P

publishDatabase(String, String, String, NullRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Update the zones for the database asset so that it becomes visible to consumers.

publishDatabaseSchema(String, String, String, NullRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Update the zones for the database asset so that it becomes visible to consumers.

R

removeDatabase(String, String, String, String, String, String, NullRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Remove the metadata element representing a database.

removeDatabaseColumn(String, String, String, String, String, String, NullRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Remove the metadata element representing a database column.

removeDatabaseSchema(String, String, String, String, String, String, NullRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Remove the metadata element representing a database schema.

removeDatabaseTable(String, String, String, String, String, String, NullRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Remove the metadata element representing a database table.

removeDatabaseView(String, String, String, String, String, String, NullRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Remove the metadata element representing a database table.

removeForeignKeyRelationship(String, String, String, String, String, String, NullRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Remove the foreign key relationship for the requested columns.

removePrimaryKeyFromColumn(String, String, String, String, String, NullRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Remove the classification that this column is a primary key.

S

setPrimaryKeyOnColumn(String, String, String, String, String, DatabasePrimaryKeyProperties) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Classify a column in a database table as the primary key.

U

updateDatabase(String, String, String, String, String, DatabaseProperties) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Update the metadata element representing a database.

updateDatabaseColumn(String, String, String, String, String, DatabaseColumnProperties) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Update the metadata element representing a database column.

updateDatabaseSchema(String, String, String, String, String, DatabaseSchemaProperties) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Update the metadata element representing a database schema.

updateDatabaseTable(String, String, String, String, String, DatabaseTableProperties) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Update the metadata element representing a database table.

updateDatabaseView(String, String, String, String, String, DatabaseViewProperties) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Update the metadata element representing a database table.

updateDataFileInCatalog(String, String, String, boolean, DataFileRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Update the file asset description in the catalog.

updateDataFolderInCatalog(String, String, String, boolean, DataFolderRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.FilesResource

Update the DataFolder asset description in the catalog.

W

withdrawDatabase(String, String, String, NullRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Update the zones for the database asset so that it is no longer visible to consumers.

withdrawDatabaseSchema(String, String, String, NullRequestBody) - Method in class org.odpi.openmetadata.accessservices.datamanager.server.spring.DatabaseManagerResource

Update the zones for the database asset so that it is no longer visible to consumers.

A C D F G M O P R S U W