Index (Discovery Engine OMAS Client 1.3 API)

A C D F G L O R S U

A

addAnnotationToAnnotation(String, Annotation) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAnnotationStoreClient: Add a new annotation and link it to an existing annotation.
addAnnotationToDataField(String, Annotation) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAnnotationStoreClient: Add a new annotation and link it to an existing data field.
addAnnotationToDiscoveryReport(Annotation) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAnnotationStoreClient: Add a new annotation to the annotation store as a top level annotation linked directly off of the report.
addDataFieldToDataField(String, DataField) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAnnotationStoreClient: Add a new data field and link it to an existing data field.
addDataFieldToDiscoveryReport(String, DataField) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAnnotationStoreClient: Add a new data field to the Annotation store linked off of an annotation (typically SchemaAnalysisAnnotation).

C

createDiscoveryAnalysisReport(String, String, String, String, Date, Map<String, String>, DiscoveryRequestStatus, String, String, String, Map<String, String>, List<Classification>) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryEngineClient: Create a new discovery analysis report and chain it to its asset, discovery engine and discovery service.
createDiscoveryEngine(String, String, String, String) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryConfigurationClient: Create a new discovery engine definition.
createDiscoveryService(String, String, String, String, Connection) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryConfigurationClient: Create a discovery service definition.

D

deleteAnnotation(String) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAnnotationStoreClient: Remove an annotation from the annotation store.
deleteDataField(String) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAnnotationStoreClient: Remove a data field from the annotation store.
deleteDiscoveryEngine(String, String, String) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryConfigurationClient: Remove the properties of the discovery engine.
deleteDiscoveryService(String, String, String) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryConfigurationClient: Remove the properties of the discovery service.
DiscoveryAnnotationStoreClient - Class in org.odpi.openmetadata.accessservices.discoveryengine.client: DiscoveryAnnotationStoreClient provides a client-side implementation of the ODF DiscoveryAnnotationStore that is backed by calls to the Discovery Engine OMAS.
DiscoveryAnnotationStoreClient(String, String, DiscoveryReportClient, DiscoveryEngineClient) - Constructor for class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAnnotationStoreClient: Constructor sets up the key parameters for accessing the annotations store.
DiscoveryAssetCatalogStoreClient - Class in org.odpi.openmetadata.accessservices.discoveryengine.client: DiscoveryAssetCatalogStoreClient is the open metadata default implementation of the Open Discovery Framework (ODF) DiscoveryAssetCatalogStore.
DiscoveryAssetCatalogStoreClient(String, DiscoveryEngineClient, int) - Constructor for class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAssetCatalogStoreClient: Create a discovery asset catalog store that call call the discovery engine client.
DiscoveryAssetStoreClient - Class in org.odpi.openmetadata.accessservices.discoveryengine.client: DiscoveryAssetStoreClient provides the client-side library for the Open Discovery Framework (ODF)'s Discovery Asset Store that provides a Discovery service with access to the connector for the asset to be discovered.
DiscoveryAssetStoreClient(String, String, DiscoveryEngineClient) - Constructor for class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAssetStoreClient: Constructor sets up the key parameters for accessing the asset store.
DiscoveryConfigurationClient - Class in org.odpi.openmetadata.accessservices.discoveryengine.client
DiscoveryConfigurationClient(String, String) - Constructor for class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryConfigurationClient: Create a new client with no authentication embedded in the HTTP request.
DiscoveryConfigurationClient(String, String, String, String) - Constructor for class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryConfigurationClient: Create a new client that passes userId and password in each HTTP request.
DiscoveryConfigurationClient(String, String, ODFRESTClient, int) - Constructor for class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryConfigurationClient: Create a new client that passes userId and password in each HTTP request.
DiscoveryEngineClient - Class in org.odpi.openmetadata.accessservices.discoveryengine.client: DiscoveryEngineClient provides the client-side operational REST APIs for a running Discovery Engine.
DiscoveryEngineClient(String, String, ODFRESTClient) - Constructor for class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryEngineClient: Constructor sets up the key parameters for accessing the asset store.
DiscoveryReportClient - Class in org.odpi.openmetadata.accessservices.discoveryengine.client: DiscoveryReportClient is the client interface for managing the values in a Discovery Analysis Report using the Discovery Engine OMAS services.
DiscoveryReportClient(String, DiscoveryRequestStatus, String, Map<String, String>, String, String, String, String, String, DiscoveryEngineClient) - Constructor for class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryReportClient

F

findAssets(String, int, int) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAssetCatalogStoreClient: Return the list of assets that have the search string somewhere in their properties.
findAssets(String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryEngineClient: Return a list of assets with the requested search string in their name, qualified name or description.
findAssetsByEndpoint(String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryEngineClient: Return the list of assets that have the same endpoint address.

G

getAllDiscoveryEngines(String, int, int) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryConfigurationClient: Return the list of discovery engine definitions that are stored.
getAllDiscoveryServices(String, int, int) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryConfigurationClient: Return the list of discovery services definitions that are stored.
getAnnotation(String) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAnnotationStoreClient: Return a specific annotation stored in the annotation store (previous or new).
getAnnotation(String, String, String) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryEngineClient: Retrieve a single annotation by unique identifier.
getAssetProperties() - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAssetStoreClient: Returns a comprehensive collection of properties about the requested asset.
getAssets(int, int) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAssetCatalogStoreClient: Return the next set of assets to process.
getAssets(String, int, int) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryEngineClient: Return the next set of assets to process.
getAssetsByEndpoint(String, int, int) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAssetCatalogStoreClient: Return the list of assets that have the same endpoint address.
getAssetsByName(String, int, int) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAssetCatalogStoreClient: Return the list of matching assets that have the supplied name as either the qualified name or display name.
getAssetsByName(String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryEngineClient: Return the list of matching assets that have the supplied name as either the qualified name or display name.
getAssetsByQualifiedName(String, int, int) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAssetCatalogStoreClient: Return the assets with the same qualified name.
getAssetsByQualifiedName(String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryEngineClient: Return the assets with the same qualified name.
getConnectionForAsset() - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAssetStoreClient: Return the connection information for the asset.
getConnectorByConnection(Connection) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAssetStoreClient: Returns the connector corresponding to the supplied connection.
getConnectorForConnection(String, Connection) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryEngineClient: Returns the connector corresponding to the supplied connection.
getDataField(String) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAnnotationStoreClient: Return a specific data field stored in the annotation store (previous or new).
getDiscoveryAnalysisReport(String, String) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryEngineClient: Request the discovery report for a discovery request that has completed.
getDiscoveryEngineByGUID(String, String) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryConfigurationClient: Return the properties from a discovery engine definition.
getDiscoveryEngineByName(String, String) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryConfigurationClient: Return the properties from a discovery engine definition.
getDiscoveryReportAnnotations(String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryEngineClient: Return the annotations linked directly to the report.
getDiscoveryRequestStatus() - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryReportClient: Return the current status of the discovery request - this is stored in the report.
getDiscoveryServiceByGUID(String, String) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryConfigurationClient: Return the properties from a discovery service definition.
getDiscoveryServiceByName(String, String) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryConfigurationClient: Return the properties from a discovery service definition.
getDiscoveryServiceRegistrations(String, String) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryConfigurationClient: Return the list of discovery engines that a specific discovery service is registered with.
getDiscoveryStatus(String, String) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryEngineClient: Request the status of an executing discovery request.
getExtendedAnnotations(String, int, int) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAnnotationStoreClient: Return any annotations attached to this annotation.
getExtendedAnnotations(String, String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryEngineClient: Return any annotations attached to this annotation.
getNestedDataFields(String, int, int) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAnnotationStoreClient: Return any annotations attached to this annotation.
getNewAnnotationsForAsset(int, int) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAnnotationStoreClient: Return the current list of annotations for this discovery run.
getNewDataFieldsForAsset(int, int) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAnnotationStoreClient: Return the current list of data fields for this discovery run.
getPreviousAnnotationsForAsset(int, int) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAnnotationStoreClient: Return the list of Annotations created for the asset by previous runs of the discovery service.
getPreviousAnnotationsForAsset(AnnotationStatus, int, int) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAnnotationStoreClient: Return the list of annotations from previous runs of the discovery service that are set to a specific status.
getPreviousDataFieldsForAsset(int, int) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAnnotationStoreClient: Return the list of data fields from previous runs of the discovery service.
getRegisteredDiscoveryService(String, String, String) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryConfigurationClient: Retrieve a specific discovery service registered with a discovery engine.
getRegisteredDiscoveryServices(String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryConfigurationClient: Retrieve the identifiers of the discovery services registered with a discovery engine.

L

linkAnnotation(String, String) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAnnotationStoreClient: Link an existing annotation to another object.
logAssetAuditMessage(String, String) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAssetStoreClient: Log an audit message about this asset.
logAssetAuditMessage(String, String, String, String) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryEngineClient: Log an audit message about this asset.

O

org.odpi.openmetadata.accessservices.discoveryengine.client - package org.odpi.openmetadata.accessservices.discoveryengine.client

R

registerDiscoveryServiceWithEngine(String, String, String, List<String>) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryConfigurationClient: Register a discovery service with a specific discovery engine.

S

setDiscoveryRequestStatus(DiscoveryRequestStatus) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryReportClient: Set up the current status of the discovery request - this is stored in the report so it can be monitored by the originator of the request.
setDiscoveryStatus(String, String, DiscoveryRequestStatus) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryEngineClient: Request the status of an executing discovery request.

U

unlinkAnnotation(String, String) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAnnotationStoreClient: Remove the relationship between an annotation and another object.
unregisterDiscoveryServiceFromEngine(String, String, String) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryConfigurationClient: Unregister a discovery service from the discovery engine.
updateAnnotation(Annotation) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAnnotationStoreClient: Replace the current properties of an annotation.
updateDataField(DataField) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAnnotationStoreClient: Replace the current properties of a data field.
updateDiscoveryAnalysisReport(String, DiscoveryAnalysisReport) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryEngineClient: Update the properties of the discovery analysis report.
updateDiscoveryEngine(String, String, String, String, String, String, String, String, String, Map<String, String>, Map<String, Object>) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryConfigurationClient: Update the properties of an existing discovery engine definition.
updateDiscoveryService(String, String, String, String, String, String, String, OwnerType, List<String>, String, Connection, Map<String, String>, Map<String, Object>) - Method in class org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryConfigurationClient: Update the properties of an existing discovery service definition.

A C D F G L O R S U