Package com.atlan.model.lineage

Class LineageListRequest

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.lineage.LineageListRequest
All Implemented Interfaces:
Serializable
public class LineageListRequest extends AtlanObject
See Also:

  • Constructor Details

  • Method Details

    • builder

      public static LineageListRequest.LineageListRequestBuilder<?,?> builder(Reference ref)
      Build a lineage list request starting from the provided GUID and using default options. (Searches for up to 1000000 downstream assets with minimal attributes and relationships, paging 10 asset at a time, excluding both assigned terms and Atlan tags.)
      Parameters:
      ref - an asset reference that contains at least a GUID, from which to start traversing lineage
      Returns:
      the lineage list request starting from that asset (reference)

    • builder

      public static LineageListRequest.LineageListRequestBuilder<?,?> builder(String guid)
      Build a lineage list request starting from the provided GUID and using default options. (Searches for up to 1000000 downstream assets with minimal attributes and relationships, paging 10 asset at a time, excluding both assigned terms and Atlan tags.)
      Parameters:
      guid - unique identifier (GUID) from which to start traversing lineage
      Returns:
      the lineage list request starting from that GUID

    • fetch

      public LineageListResponse fetch() throws AtlanException
      Fetch the lineage defined by this object.
      Returns:
      the results of the requested lineage
      Throws:
      AtlanException

    • fetch

      public LineageListResponse fetch(AtlanClient client) throws AtlanException
      Fetch the lineage defined by this object.
      Parameters:
      client - connectivity to the Atlan tenant from which to fetch the lineage
      Returns:
      the results of the requested lineage
      Throws:
      AtlanException

    • _internal

      public static LineageListRequest.LineageListRequestBuilder<?,?> _internal()

    • toBuilder

      public LineageListRequest.LineageListRequestBuilder<?,?> toBuilder()

    • getGuid

      public String getGuid()
      Unique identifier of the asset for which to retrieve lineage.

    • getDepth

      public Integer getDepth()
      Number of degrees of separation (hops) across which lineage should be fetched. A depth of 1 will fetch the immediate upstream and/or downstream assets, while 2 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.)

    • getDirection

      public AtlanLineageDirection getDirection()
      Indicates whether to fetch upstream lineage only, downstream lineage only, or both.

    • getEntityFilters

      public FilterList getEntityFilters()
      Filters to apply on entities. Note that if the values in the properties of entityFilters 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).

    • getEntityTraversalFilters

      public FilterList getEntityTraversalFilters()
      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.

    • getRelationshipTraversalFilters

      public FilterList getRelationshipTraversalFilters()
      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.

    • getAttributes

      public List<String> getAttributes()
      List of attributes to be returned for each asset.

    • getRelationAttributes

      public List<String> getRelationAttributes()
      List of attributes to be returned for each asset.

    • getFrom

      public Integer getFrom()
      Starting point for pagination.

    • getSize

      public Integer getSize()
      How many results to include in each page of results.

    • getExcludeMeanings

      public Boolean getExcludeMeanings()
      Whether to include assigned terms for assets (false) or not (true).

    • getExcludeAtlanTags

      public Boolean getExcludeAtlanTags()
      Whether to include Atlan tags for assets (false) or not (true).

    • getImmediateNeighbors

      public Boolean getImmediateNeighbors()
      Whether to include immediate neighbors of the starting asset in the response.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class AtlanObject

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class AtlanObject

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class AtlanObject

    • toString

      public String toString()
      Description copied from class: AtlanObject
      Overrides:
      toString in class AtlanObject