Package org.odpi.openmetadata.accessservices.assetowner.api

Interface AssetOnboardingCSVFileInterface

public interface AssetOnboardingCSVFileInterface

AssetOnboardingCSVFileInterface provides the client-side interface for an asset owner to set up the metadata about a CSV file asset. This includes defining its name, source and license.

Method Summary

Modifier and Type	Method	Description
List<String>	addCSVFileToCatalog(String userId, String displayName, String description, String fullPath)	Add a simple asset description linked to a connection object for a CSV file.
List<String>	addCSVFileToCatalog(String userId, String displayName, String description, String fullPath, List<String> columnHeaders, Character delimiterCharacter, Character quoteCharacter)	Add a simple asset description linked to a connection object for a CSV file.

Method Details

addCSVFileToCatalog

List<String> addCSVFileToCatalog(String userId,
 String displayName,
 String description,
 String fullPath)
                          throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException

Add a simple asset description linked to a connection object for a CSV file.

Parameters:

userId - calling user (assumed to be the owner)

displayName - display name for the file in the catalog

description - description of the file in the catalog

fullPath - full path of the file - used to access the file through the connector

Returns:

list of GUIDs from the top level to the root of the pathname

Throws:

org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - full path or userId is null

org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

addCSVFileToCatalog

List<String> addCSVFileToCatalog(String userId,
 String displayName,
 String description,
 String fullPath,
 List<String> columnHeaders,
 Character delimiterCharacter,
 Character quoteCharacter)
                          throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException

Add a simple asset description linked to a connection object for a CSV file.

Parameters:

userId - calling user (assumed to be the owner)

displayName - display name for the file in the catalog

description - description of the file in the catalog

fullPath - full path of the file - used to access the file through the connector

columnHeaders - does the first line of the file contain the column names. If not pass the list of column headers.

delimiterCharacter - what is the delimiter character - null for default of comma

quoteCharacter - what is the character to group a field that contains delimiter characters

Returns:

list of GUIDs from the top level to the root of the pathname

Throws:

org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - full path or userId is null

org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem