java.lang.Object
- org.odpi.openmetadata.frameworks.discovery.DiscoveryEngine

```
public abstract class DiscoveryEngine
extends Object
```
DiscoveryEngine provides the interface for a discovery engine. The discovery engine runs inside a discovery server. The discovery server provides the server runtime environment for the discovery engine along with the interfaces for configuring the discovery engine.

Constructor Summary

Constructors
Constructor Description

DiscoveryEngine()

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`abstract String`	`discoverAsset(String userId, String assetGUID, String assetDiscoveryType)`	Request the execution of a discovery service to explore a specific asset.
`abstract String`	`discoverAsset(String userId, String assetGUID, String assetDiscoveryType, Map<String,String> analysisParameters)`	Request the execution of a discovery service to explore a specific asset.
`abstract String`	`discoverAsset(String userId, String assetGUID, String assetDiscoveryType, Map<String,String> analysisParameters, List<String> annotationTypes)`	Request the execution of a discovery service to explore a specific asset.
`abstract Annotation`	`getAnnotation(String userId, String annotationGUID)`	Retrieve a single annotation by unique identifier.
`abstract DiscoveryAnalysisReport`	`getDiscoveryReport(String userId, String discoveryRequestGUID)`	Request the discovery report for a discovery request that has completed.
`abstract List<Annotation>`	`getDiscoveryReportAnnotations(String userId, String discoveryRequestGUID, int startingFrom, int maximumResults)`	Return the annotations linked direction to the report.
`abstract DiscoveryRequestStatus`	`getDiscoveryStatus(String userId, String discoveryRequestGUID)`	Request the status of an executing discovery request.
`abstract List<Annotation>`	`getExtendedAnnotations(String userId, String annotationGUID, int startingFrom, int maximumResults)`	Return any annotations attached to this annotation.
`abstract void`	`scanAllAssets(String userId, String assetDiscoveryType, Map<String,String> analysisParameters, List<String> annotationTypes)`	Explore each of the assets in the asset store.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- DiscoveryEngine
```
public DiscoveryEngine()
```

Method Detail

discoverAsset
```
public abstract String discoverAsset(String userId,
                                     String assetGUID,
                                     String assetDiscoveryType)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     DiscoveryEngineException
```
Request the execution of a discovery service to explore a specific asset.

Parameters:

userId - identifier of calling user

assetGUID - identifier of the asset to analyze.

assetDiscoveryType - identifier of the type of analysis - this determines which discovery service to run.

Returns:

unique id for the discovery request.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

DiscoveryEngineException - there was a problem detected by the discovery engine.

discoverAsset

public abstract String discoverAsset(String userId,
                                     String assetGUID,
                                     String assetDiscoveryType,
                                     Map<String,String> analysisParameters)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     DiscoveryEngineException

Request the execution of a discovery service to explore a specific asset.

Parameters:: userId - identifier of calling user; assetGUID - identifier of the asset to analyze.; assetDiscoveryType - identifier of the type of analysis - this determines which discovery service to run.; analysisParameters - name value properties to control the analysis
Returns:: unique id for the discovery request.
Throws:: InvalidParameterException - one of the parameters is null or invalid.; UserNotAuthorizedException - user not authorized to issue this request.; DiscoveryEngineException - there was a problem detected by the discovery engine.

discoverAsset

public abstract String discoverAsset(String userId,
                                     String assetGUID,
                                     String assetDiscoveryType,
                                     Map<String,String> analysisParameters,
                                     List<String> annotationTypes)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     DiscoveryEngineException

Request the execution of a discovery service to explore a specific asset.

Parameters:: userId - identifier of calling user; assetGUID - identifier of the asset to analyze.; assetDiscoveryType - identifier of the type of analysis - this determines which discovery service to run.; analysisParameters - name value properties to control the analysis; annotationTypes - list of the types of annotations to produce (and no others)
Returns:: unique id for the discovery request.
Throws:: InvalidParameterException - one of the parameters is null or invalid.; UserNotAuthorizedException - user not authorized to issue this request.; DiscoveryEngineException - there was a problem detected by the discovery engine.

scanAllAssets
```
public abstract void scanAllAssets(String userId,
                                   String assetDiscoveryType,
                                   Map<String,String> analysisParameters,
                                   List<String> annotationTypes)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   DiscoveryEngineException
```
Explore each of the assets in the asset store. A new instance of the discovery service is started for each retrieved asset.

Parameters:

userId - identifier of calling user

assetDiscoveryType - identifier of the type of analysis - this determines which discovery service to run.

analysisParameters - name value properties to control the analysis

annotationTypes - list of the types of annotations to produce (and no others)

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

DiscoveryEngineException - there was a problem detected by the discovery engine.

getDiscoveryStatus

public abstract DiscoveryRequestStatus getDiscoveryStatus(String userId,
                                                          String discoveryRequestGUID)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          DiscoveryEngineException

Request the status of an executing discovery request.

Parameters:: userId - identifier of calling user; discoveryRequestGUID - identifier of the discovery request.
Returns:: status enum
Throws:: InvalidParameterException - one of the parameters is null or invalid.; UserNotAuthorizedException - user not authorized to issue this request.; DiscoveryEngineException - there was a problem detected by the discovery engine.

getDiscoveryReport

public abstract DiscoveryAnalysisReport getDiscoveryReport(String userId,
                                                           String discoveryRequestGUID)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           DiscoveryEngineException

Request the discovery report for a discovery request that has completed.

Parameters:: userId - identifier of calling user; discoveryRequestGUID - identifier of the discovery request.
Returns:: discovery report
Throws:: InvalidParameterException - one of the parameters is null or invalid.; UserNotAuthorizedException - user not authorized to issue this request.; DiscoveryEngineException - there was a problem detected by the discovery engine.

getDiscoveryReportAnnotations

public abstract List<Annotation> getDiscoveryReportAnnotations(String userId,
                                                               String discoveryRequestGUID,
                                                               int startingFrom,
                                                               int maximumResults)
                                                        throws InvalidParameterException,
                                                               UserNotAuthorizedException,
                                                               DiscoveryEngineException

Return the annotations linked direction to the report.

Parameters:: userId - identifier of calling user; discoveryRequestGUID - identifier of the discovery request.; startingFrom - initial position in the stored list.; maximumResults - maximum number of definitions to return on this call.
Returns:: list of annotations
Throws:: InvalidParameterException - one of the parameters is null or invalid.; UserNotAuthorizedException - user not authorized to issue this request.; DiscoveryEngineException - there was a problem detected by the discovery engine.

getExtendedAnnotations

public abstract List<Annotation> getExtendedAnnotations(String userId,
                                                        String annotationGUID,
                                                        int startingFrom,
                                                        int maximumResults)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        DiscoveryEngineException

Return any annotations attached to this annotation.

Parameters:: userId - identifier of calling user; annotationGUID - anchor annotation; startingFrom - starting position in the list; maximumResults - maximum number of annotations that can be returned.
Returns:: list of Annotation objects
Throws:: InvalidParameterException - one of the parameters is null or invalid.; UserNotAuthorizedException - user not authorized to issue this request.; DiscoveryEngineException - there was a problem detected by the discovery engine.

getAnnotation
```
public abstract Annotation getAnnotation(String userId,
                                         String annotationGUID)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         DiscoveryEngineException
```
Retrieve a single annotation by unique identifier. This call is typically used to retrieve the latest values for an annotation.

Parameters:

userId - identifier of calling user

annotationGUID - unique identifier of the annotation

Returns:

Annotation object

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

DiscoveryEngineException - there was a problem detected by the discovery engine.

Class DiscoveryEngine

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DiscoveryEngine

Method Detail

discoverAsset

discoverAsset

discoverAsset

scanAllAssets

getDiscoveryStatus

getDiscoveryReport

getDiscoveryReportAnnotations

getExtendedAnnotations

getAnnotation