Package org.odpi.openmetadata.commonservices.ffdc.rest

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

public class AssetLineageGraphRequestBody
extends QueryOptions

AssetLineageGraphRequestBody provides the request body payload for an asset lineage graph.

Constructor Summary

Constructors

Constructor	Description
AssetLineageGraphRequestBody()	Default constructor
AssetLineageGraphRequestBody(AssetLineageGraphRequestBody template)	Copy/clone constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Equals method that returns true if containing properties are the same.
boolean	getAllAnchors()	Return whether all anchors should be added - or just those to known nodes? Default is false.
String	getHighlightISCQualifiedName()	Return whether a particular information supply chain should be highlighted.
String	getLimitToISCQualifiedName()	Return whether the returned results should just show a particular information supply chain.
int	hashCode()	Return hash code for this object
void	setAllAnchors(boolean allAnchors)	Set up whether all anchors should be added - or just those to known nodes? Default is false.
void	setHighlightISCQualifiedName(String highlightISCQualifiedName)	Set up whether a particular information supply chain should be highlighted.
void	setLimitToISCQualifiedName(String limitToISCQualifiedName)	Set up whether the returned results should just show a particular information supply chain.
String	toString()	JSON-style toString.

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.QueryOptions

getAnchorDomainName, getAnchorGUID, getAnchorScopeGUID, getLimitResultsByStatus, getSequencingOrder, getSequencingProperty, setAnchorDomainName, setAnchorGUID, setAnchorScopeGUID, setLimitResultsByStatus, setSequencingOrder, setSequencingProperty

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.PagingOptions

getPageSize, getStartFrom, setPageSize, setStartFrom

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.GetOptions

getAsOfTime, getGraphQueryDepth, getIncludeOnlyClassifiedElements, getIncludeOnlyRelationships, getMetadataElementSubtypeNames, getMetadataElementTypeName, getRelationshipsPageSize, getSkipClassifiedElements, getSkipRelationships, setAsOfTime, setGraphQueryDepth, setIncludeOnlyClassifiedElements, setIncludeOnlyRelationships, setMetadataElementSubtypeNames, setMetadataElementTypeName, setRelationshipsPageSize, setSkipClassifiedElements, setSkipRelationships

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.BasicOptions

getEffectiveTime, getForDuplicateProcessing, getForLineage, getGovernanceZoneFilter, setEffectiveTime, setForDuplicateProcessing, setForLineage, setGovernanceZoneFilter

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AssetLineageGraphRequestBody

public AssetLineageGraphRequestBody()

Default constructor

AssetLineageGraphRequestBody

public AssetLineageGraphRequestBody(AssetLineageGraphRequestBody template)

Copy/clone constructor

Parameters:

template - object to copy

Method Details

getLimitToISCQualifiedName

public String 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

public void setLimitToISCQualifiedName(String limitToISCQualifiedName)

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

public String getHighlightISCQualifiedName()

Return whether a particular information supply chain should be highlighted.

Returns:

qualified name

setHighlightISCQualifiedName

public void setHighlightISCQualifiedName(String highlightISCQualifiedName)

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

toString

public String toString()

JSON-style toString.

Overrides:

toString in class QueryOptions

Returns:

list of properties and their values.

equals

public boolean equals(Object objectToCompare)

Equals method that returns true if containing properties are the same.

Overrides:

equals in class QueryOptions

Parameters:

objectToCompare - object to compare

Returns:

boolean result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class QueryOptions

Returns:

int hash code