Class AssetLineageGraphRequestBody
java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.search.BasicOptions
org.odpi.openmetadata.frameworks.openmetadata.search.GetOptions
org.odpi.openmetadata.frameworks.openmetadata.search.PagingOptions
org.odpi.openmetadata.frameworks.openmetadata.search.QueryOptions
org.odpi.openmetadata.commonservices.ffdc.rest.AssetLineageGraphRequestBody
- All Implemented Interfaces:
RequestIdService
AssetLineageGraphRequestBody provides the request body payload for an asset lineage graph.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe number of lineage relationships followed away from the starting asset, in each direction, when the request does not say. -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructorCopy/clone constructor -
Method Summary
Modifier and TypeMethodDescriptionbooleanEquals method that returns true if containing properties are the same.booleanReturn whether all anchors should be added - or just those to known nodes? Default is false.Return whether a particular information supply chain should be highlighted.Return whether the returned results should just show a particular information supply chain.intReturn the maximum number of lineage relationships to follow away from the starting asset, upstream and downstream.inthashCode()Return hash code for this objectvoidsetAllAnchors(boolean allAnchors) Set up whether all anchors should be added - or just those to known nodes? Default is false.voidsetHighlightISCQualifiedName(String highlightISCQualifiedName) Set up whether a particular information supply chain should be highlighted.voidsetLimitToISCQualifiedName(String limitToISCQualifiedName) Set up whether the returned results should just show a particular information supply chain.voidsetMaxHops(int maxHops) Set up the maximum number of lineage relationships to follow away from the starting asset, upstream and downstream.toString()JSON-style toString.Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.QueryOptions
getAnchorDomainName, getAnchorGUID, getAnchorScopeGUID, getGovernanceZoneFilter, getIncludeOnlyClassifiedElements, getLimitResultsByStatus, getMetadataElementSubtypeNames, getSequencingOrder, getSequencingProperty, getSkipClassifiedElements, getSkipSubtypes, setAnchorDomainName, setAnchorGUID, setAnchorScopeGUID, setGovernanceZoneFilter, setIncludeOnlyClassifiedElements, setLimitResultsByStatus, setMetadataElementSubtypeNames, setSequencingOrder, setSequencingProperty, setSkipClassifiedElements, setSkipSubtypesMethods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.PagingOptions
getPageSize, getStartFrom, setPageSize, setStartFromMethods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.GetOptions
getAsOfTime, getGraphQueryDepth, getIncludeOnlyRelationships, getMaxMermaidNodeCount, getMetadataElementTypeName, getRelationshipsPageSize, getSkipRelationships, getViewElementGUID, setAsOfTime, setGraphQueryDepth, setIncludeOnlyRelationships, setMaxMermaidNodeCount, setMetadataElementTypeName, setRelationshipsPageSize, setSkipRelationships, setViewElementGUIDMethods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.BasicOptions
getEffectiveTime, getForDuplicateProcessing, getForLineage, getRequestId, setEffectiveTime, setForDuplicateProcessing, setForLineage, setRequestId
-
Field Details
-
DEFAULT_MAX_HOPS
public static final int DEFAULT_MAX_HOPSThe number of lineage relationships followed away from the starting asset, in each direction, when the request does not say. A complete lineage graph can reach across much of an estate and take minutes to retrieve.- See Also:
-
-
Constructor Details
-
AssetLineageGraphRequestBody
public AssetLineageGraphRequestBody()Default constructor -
AssetLineageGraphRequestBody
Copy/clone constructor- Parameters:
template- object to copy
-
-
Method Details
-
getLimitToISCQualifiedName
Return whether the returned results should just show a particular information supply chain. This supply chain has to be connected to the starting asset to show.- Returns:
- qualified name
-
setLimitToISCQualifiedName
Set up whether the returned results should just show a particular information supply chain. This supply chain has to be connected to the starting asset to show.- Parameters:
limitToISCQualifiedName- qualified name
-
getHighlightISCQualifiedName
Return whether a particular information supply chain should be highlighted.- Returns:
- qualified name
-
setHighlightISCQualifiedName
Set up whether a particular information supply chain should be highlighted.- Parameters:
highlightISCQualifiedName- qualified name
-
getAllAnchors
public boolean getAllAnchors()Return whether all anchors should be added - or just those to known nodes? Default is false.- Returns:
- flag
-
setAllAnchors
public void setAllAnchors(boolean allAnchors) Set up whether all anchors should be added - or just those to known nodes? Default is false.- Parameters:
allAnchors- flag
-
getMaxHops
public int getMaxHops()Return the maximum number of lineage relationships to follow away from the starting asset, upstream and downstream. The default isDEFAULT_MAX_HOPS. Zero means there is no limit.- Returns:
- number of hops
-
setMaxHops
public void setMaxHops(int maxHops) Set up the maximum number of lineage relationships to follow away from the starting asset, upstream and downstream. The default isDEFAULT_MAX_HOPS. Zero means there is no limit.- Parameters:
maxHops- number of hops
-
toString
JSON-style toString.- Overrides:
toStringin classQueryOptions- Returns:
- list of properties and their values.
-
equals
Equals method that returns true if containing properties are the same.- Overrides:
equalsin classQueryOptions- Parameters:
objectToCompare- object to compare- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()Return hash code for this object- Overrides:
hashCodein classQueryOptions- Returns:
- int hash code
-