Package org.odpi.openmetadata.accessservices.assetconsumer.api

Interface AssetConsumerAssetInterface

public interface AssetConsumerAssetInterface

AssetConsumerAssetInterface supports queries to retrieve information about an asset.

Method Summary

Modifier and Type	Method	Description
List<String>	findAssets(String userId, String searchString, int startFrom, int pageSize)	Return a list of assets with the requested search string in their name, qualified name or description.
String	getAssetForConnection(String userId, String connectionGUID)	Returns the unique identifier for the asset connected to the requested connection.
String	getAssetForConnectionName(String userId, String connectionName)	Returns the asset corresponding to the supplied connection name.
AssetUniverse	getAssetProperties(String userId, String assetGUID)	Returns a comprehensive collection of properties about the requested asset.
List<String>	getAssetsByName(String userId, String name, int startFrom, int pageSize)	Return a list of assets with the requested name.
List<String>	getAssetsByToken(String userId, String assetToken, int startFrom, int pageSize)	Returns a list of assets that match the token which may be the GUID or the qualified name.

Method Detail

findAssets

List<String> findAssets(String userId,
                        String searchString,
                        int startFrom,
                        int pageSize)
                 throws InvalidParameterException,
                        PropertyServerException,
                        UserNotAuthorizedException

Return a list of assets with the requested search string in their name, qualified name or description. The search string is interpreted as a regular expression (RegEx).

Parameters:

userId - calling user

searchString - string to search for in text

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

pageSize - maximum number of results to return

Returns:

list of unique identifiers (GUIDs) for the matching assets

Throws:

InvalidParameterException - the searchString is invalid

PropertyServerException - there is a problem access in the property server

UserNotAuthorizedException - the user does not have access to the properties

getAssetsByName

List<String> getAssetsByName(String userId,
                             String name,
                             int startFrom,
                             int pageSize)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Return a list of assets with the requested name.

Parameters:

userId - calling user

name - name to search for

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

pageSize - maximum number of results to return

Returns:

list of unique identifiers (GUIDs) of assets with matching name.

Throws:

InvalidParameterException - the name is invalid

PropertyServerException - there is a problem access in the property server

UserNotAuthorizedException - the user does not have access to the properties

getAssetsByToken

List<String> getAssetsByToken(String userId,
                              String assetToken,
                              int startFrom,
                              int pageSize)
                       throws InvalidParameterException,
                              PropertyServerException,
                              UserNotAuthorizedException

Returns a list of assets that match the token which may be the GUID or the qualified name.

Parameters:

userId - userId of user making request.

assetToken - token used to find the Asset - may be a name or GUID

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

pageSize - maximum number of results to return

Returns:

a list of unique identifiers (GUIDs) for the matching assets

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving the asset properties from the property servers).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getAssetForConnection

String getAssetForConnection(String userId,
                             String connectionGUID)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Returns the unique identifier for the asset connected to the requested connection.

Parameters:

userId - the userId of the requesting user.

connectionGUID - unique identifier for the connection.

Returns:

unique identifier (GUID) of asset.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getAssetForConnectionName

String getAssetForConnectionName(String userId,
                                 String connectionName)
                          throws InvalidParameterException,
                                 PropertyServerException,
                                 UserNotAuthorizedException

Returns the asset corresponding to the supplied connection name.

Parameters:

userId - userId of user making request.

connectionName - this may be the qualifiedName or displayName of the connection.

Returns:

unique identifier (GUID) of asset.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getAssetProperties

AssetUniverse getAssetProperties(String userId,
                                 String assetGUID)
                          throws InvalidParameterException,
                                 PropertyServerException,
                                 UserNotAuthorizedException

Returns a comprehensive collection of properties about the requested asset.

Parameters:

userId - userId of user making request.

assetGUID - unique identifier for asset.

Returns:

a comprehensive collection of properties about the asset.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving the asset properties from the property servers).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.