Package com.atlan.model.lineage
Class LineageListRequest.LineageListRequestBuilder<C extends LineageListRequest,B extends LineageListRequest.LineageListRequestBuilder<C,B>>
java.lang.Object
com.atlan.model.core.AtlanObject.AtlanObjectBuilder<C,B>
com.atlan.model.lineage.LineageListRequest.LineageListRequestBuilder<C,B>
- Enclosing class:
- LineageListRequest
public abstract static class LineageListRequest.LineageListRequestBuilder<C extends LineageListRequest,B extends LineageListRequest.LineageListRequestBuilder<C,B>>
extends AtlanObject.AtlanObjectBuilder<C,B>
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected B
$fillValuesFrom
(C instance) attributes
(Collection<? extends String> attributes) abstract C
build()
Number of degrees of separation (hops) across which lineage should be fetched.direction
(AtlanLineageDirection direction) Indicates whether to fetch upstream lineage only, downstream lineage only, or both.entityFilters
(FilterList entityFilters) Filters to apply on entities.entityTraversalFilters
(FilterList entityTraversalFilters) Filters to apply for skipping traversal based on entities.excludeAtlanTags
(Boolean excludeAtlanTags) Whether to include Atlan tags for assets (false) or not (true).excludeMeanings
(Boolean excludeMeanings) Whether to include assigned terms for assets (false) or not (true).Starting point for pagination.Unique identifier of the asset for which to retrieve lineage.immediateNeighbors
(Boolean immediateNeighbors) Whether to include immediate neighbors of the starting asset in the response.relationAttribute
(String relationAttribute) relationAttributes
(Collection<? extends String> relationAttributes) relationshipTraversalFilters
(FilterList relationshipTraversalFilters) Filters to apply for skipping traversal based on relationships.protected abstract B
self()
How many results to include in each page of results.toString()
Methods inherited from class com.atlan.model.core.AtlanObject.AtlanObjectBuilder
rawJsonObject
-
Constructor Details
-
LineageListRequestBuilder
public LineageListRequestBuilder()
-
-
Method Details
-
$fillValuesFrom
- Overrides:
$fillValuesFrom
in classAtlanObject.AtlanObjectBuilder<C extends LineageListRequest,
B extends LineageListRequest.LineageListRequestBuilder<C, B>>
-
guid
Unique identifier of the asset for which to retrieve lineage.- Returns:
this
.
-
depth
Number of degrees of separation (hops) across which lineage should be fetched. A depth of1
will fetch the immediate upstream and/or downstream assets, while2
will also fetch the immediate upstream and/or downstream assets of those assets, and so on. A large integer value (for example, 1000000) will therefore in effect fetch all upstream and/or downstream assets. (BEWARE! This could take a long time and result in a very large response payload.)- Returns:
this
.
-
direction
Indicates whether to fetch upstream lineage only, downstream lineage only, or both.- Returns:
this
.
-
entityFilters
Filters to apply on entities. Note that if the values in the properties ofentityFilters
are not valid, then the filter will not be applied and you will receive all values in the response. If your filter seems to be ignored, check that it is valid (if it is invalid it WILL be ignored).- Returns:
this
.
-
entityTraversalFilters
Filters to apply for skipping traversal based on entities. Any sub-graphs beyond the entities filtered out by these filters will not be included in the lineage result.- Returns:
this
.
-
relationshipTraversalFilters
Filters to apply for skipping traversal based on relationships. Any sub-graphs beyond the relationships filtered out by these filters will not be included in the lineage result.- Returns:
this
.
-
attribute
-
attributes
-
clearAttributes
-
relationAttribute
-
relationAttributes
-
clearRelationAttributes
-
from
Starting point for pagination.- Returns:
this
.
-
size
How many results to include in each page of results.- Returns:
this
.
-
excludeMeanings
Whether to include assigned terms for assets (false) or not (true).- Returns:
this
.
-
excludeAtlanTags
Whether to include Atlan tags for assets (false) or not (true).- Returns:
this
.
-
immediateNeighbors
Whether to include immediate neighbors of the starting asset in the response.- Returns:
this
.
-
self
- Specified by:
self
in classAtlanObject.AtlanObjectBuilder<C extends LineageListRequest,
B extends LineageListRequest.LineageListRequestBuilder<C, B>>
-
build
- Specified by:
build
in classAtlanObject.AtlanObjectBuilder<C extends LineageListRequest,
B extends LineageListRequest.LineageListRequestBuilder<C, B>>
-
toString
- Overrides:
toString
in classAtlanObject.AtlanObjectBuilder<C extends LineageListRequest,
B extends LineageListRequest.LineageListRequestBuilder<C, B>>
-