public final class PurviewCatalogBaseClient extends Object
Modifier and Type | Method and Description |
---|---|
DynamicRequest |
getLineageGraph(String guid,
String direction)
Get lineage info of the entity specified by GUID.
|
DynamicRequest |
invoke()
Create an empty DynamicRequest with the serializer and pipeline initialized for this client.
|
DynamicRequest |
nextPageLineage(String guid,
String direction)
Return immediate next page lineage info about entity with pagination.
|
public DynamicRequest getLineageGraph(String guid, String direction)
Optional Query Parameters
Name | Type | Description |
---|---|---|
depth | Integer | The number of hops for lineage. |
width | Integer | The number of max expanding width in lineage. |
includeParent | Boolean | True to include the parent chain in the response. |
getDerivedLineage | Boolean | True to include derived lineage in the response |
Response Body Schema
{
baseEntityGuid: String
guidEntityMap: {
String: {
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
classificationNames: [
String
]
classifications: [
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
entityGuid: String
entityStatus: String(ACTIVE/DELETED)
removePropagationsOnEntityDelete: Boolean
validityPeriods: [
{
endTime: String
startTime: String
timeZone: String
}
]
source: String
sourceDetails: {
String: Object
}
}
]
displayText: String
guid: String
meaningNames: [
String
]
meanings: [
{
confidence: Integer
createdBy: String
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
status: String(ACTIVE/DELETED)
}
}
widthCounts: {
String: {
String: Object
}
}
lineageDepth: Integer
lineageWidth: Integer
includeParent: Boolean
childrenCount: Integer
lineageDirection: String(INPUT/OUTPUT/BOTH)
parentRelations: [
{
childEntityId: String
relationshipId: String
parentEntityId: String
}
]
relations: [
{
fromEntityId: String
relationshipId: String
toEntityId: String
}
]
}
guid
- The globally unique identifier of the entity.direction
- The direction of the lineage, which could be INPUT, OUTPUT or BOTH.public DynamicRequest nextPageLineage(String guid, String direction)
Optional Query Parameters
Name | Type | Description |
---|---|---|
getDerivedLineage | Boolean | True to include derived lineage in the response |
offset | Integer | The offset for pagination purpose. |
limit | Integer | The page size - by default there is no paging. |
Response Body Schema
{
baseEntityGuid: String
guidEntityMap: {
String: {
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
classificationNames: [
String
]
classifications: [
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
entityGuid: String
entityStatus: String(ACTIVE/DELETED)
removePropagationsOnEntityDelete: Boolean
validityPeriods: [
{
endTime: String
startTime: String
timeZone: String
}
]
source: String
sourceDetails: {
String: Object
}
}
]
displayText: String
guid: String
meaningNames: [
String
]
meanings: [
{
confidence: Integer
createdBy: String
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
status: String(ACTIVE/DELETED)
}
}
widthCounts: {
String: {
String: Object
}
}
lineageDepth: Integer
lineageWidth: Integer
includeParent: Boolean
childrenCount: Integer
lineageDirection: String(INPUT/OUTPUT/BOTH)
parentRelations: [
{
childEntityId: String
relationshipId: String
parentEntityId: String
}
]
relations: [
{
fromEntityId: String
relationshipId: String
toEntityId: String
}
]
}
guid
- The globally unique identifier of the entity.direction
- The direction of the lineage, which could be INPUT, OUTPUT or BOTH.public DynamicRequest invoke()
Copyright © 2021. All rights reserved.