org.odpi.openmetadata.accessservices.assetowner.api

Interface AssetOnboardingAvroFileInterface

public interface AssetOnboardingAvroFileInterface

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

Method Summary

Modifier and Type	Method and Description
List<String>	addAvroFileToCatalog(String userId, String displayName, String description, String fullPath) Add a simple asset description linked to a connection object for an Avro file.
void	refreshAvroSchemaInCatalog(String userId, String assetGUID) Ensure the schema associated with an Avro file is correct.

Method Detail

addAvroFileToCatalog

List<String> addAvroFileToCatalog(String userId,
                                  String displayName,
                                  String description,
                                  String fullPath)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Add a simple asset description linked to a connection object for an Avro 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

refreshAvroSchemaInCatalog

void refreshAvroSchemaInCatalog(String userId,
                                String assetGUID)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Ensure the schema associated with an Avro file is correct.

Parameters:

userId - calling user

assetGUID - unique identifier for the Avro file's asset in the catalog

Throws:

InvalidParameterException - full path or assetId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem