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

Interface AssetOnboardingCSVFileInterface

  • All Known Implementing Classes:
    CSVFileAssetOwner
    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

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

    • Method Detail

      • addCSVFileToCatalog

        java.util.List<java.lang.String> addCSVFileToCatalog​(java.lang.String userId,
                                                     java.lang.String displayName,
                                                     java.lang.String description,
                                                     java.lang.String fullPath)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     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:
        InvalidParameterException - full path or userId is null
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem

      • addCSVFileToCatalog

        java.util.List<java.lang.String> addCSVFileToCatalog​(java.lang.String userId,
                                                     java.lang.String displayName,
                                                     java.lang.String description,
                                                     java.lang.String fullPath,
                                                     java.util.List<java.lang.String> columnHeaders,
                                                     java.lang.Character delimiterCharacter,
                                                     java.lang.Character quoteCharacter)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     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:
        InvalidParameterException - full path or userId is null
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem