org.odpi.openmetadata.accessservices.assetlineage.server.spring

Class AssetLineageResource

java.lang.Object

org.odpi.openmetadata.accessservices.assetlineage.server.spring.AssetLineageResource

@RestController
 @RequestMapping(value="/servers/{serverName}/open-metadata/access-services/asset-lineage/users/{userId}/")
public class AssetLineageResource
extends Object

Constructor Summary

Constructors

Constructor and Description
AssetLineageResource()

Method Summary

Modifier and Type	Method and Description
GUIDListResponse	publishAssetContext(String serverName, String userId, String guid, String entityType) Find the entity by guid and publish the asset context for it.
GUIDListResponse	publishEntities(String serverName, String userId, String entityType, LocalDateTime updatedAfterDate, List<String> entitySubtypeGUIDs, List<InstanceStatus> limitResultsByStatus, SearchClassifications searchClassifications, String sequencingProperty, SequencingOrder sequencingOrder) Scan the cohort based on the given entity type and publish the contexts for the found entities to the out topic
GUIDListResponse	publishEntity(String serverName, String userId, String guid, String entityType) Find the entity by guid and publish the context for it

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AssetLineageResource

public AssetLineageResource()

Method Detail

publishEntities

@GetMapping(path="/publish-entities/{entityType}")
public GUIDListResponse publishEntities(@PathVariable
                                                                                           String serverName,
                                                                                           @PathVariable
                                                                                           String userId,
                                                                                           @PathVariable
                                                                                           String entityType,
                                                                                           @RequestParam(required=false) @DateTimeFormat(iso=DATE_TIME)
                                                                                           LocalDateTime updatedAfterDate,
                                                                                           @RequestParam(required=false)
                                                                                           List<String> entitySubtypeGUIDs,
                                                                                           @RequestParam(required=false)
                                                                                           List<InstanceStatus> limitResultsByStatus,
                                                                                           @RequestParam(required=false)
                                                                                           SearchClassifications searchClassifications,
                                                                                           @RequestParam(required=false)
                                                                                           String sequencingProperty,
                                                                                           @RequestParam(required=false)
                                                                                           SequencingOrder sequencingOrder)

Scan the cohort based on the given entity type and publish the contexts for the found entities to the out topic

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

entityType - the name of the relationship type

updatedAfterDate - match entities updated starting from this date forward. The date must be provided in the ISO format

entitySubtypeGUIDs - optional list of the unique identifiers (guids) for subtypes of the entityTypeGUID to include in the search results. Null means all subtypes.

limitResultsByStatus - By default, entities in all statuses are returned. However, it is possible to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all status values.

searchClassifications - Optional list of entity classifications to match.

sequencingProperty - String name of the entity property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

Returns:

a list of unique identifiers (guids) of the available entities with the given type provided as a response

publishEntity

@GetMapping(path="/publish-entity/{entityType}/{guid}")
public GUIDListResponse publishEntity(@PathVariable
                                                                                              String serverName,
                                                                                              @PathVariable
                                                                                              String userId,
                                                                                              @PathVariable
                                                                                              String guid,
                                                                                              @PathVariable
                                                                                              String entityType)

Find the entity by guid and publish the context for it

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

guid - the guid of the entity to build context

entityType - the name of the relationship type

Returns:

a list of unique identifiers (guids) of the available entity with the given type provided as a response

publishAssetContext

@GetMapping(path="/publish-context/{entityType}/{guid}")
public GUIDListResponse publishAssetContext(@PathVariable
                                                                                                     String serverName,
                                                                                                     @PathVariable
                                                                                                     String userId,
                                                                                                     @PathVariable
                                                                                                     String guid,
                                                                                                     @PathVariable
                                                                                                     String entityType)

Find the entity by guid and publish the asset context for it. It applies for data tables and files.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

guid - the guid of the entity to build context

entityType - the name of the relationship type

Returns:

a list of unique identifiers (guids) of the available entities that exist in the published context