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 Details

    • LineageListRequestBuilder

      public LineageListRequestBuilder()
  • Method Details

    • $fillValuesFrom

      protected B $fillValuesFrom(C instance)
      Overrides:
      $fillValuesFrom in class AtlanObject.AtlanObjectBuilder<C extends LineageListRequest,B extends LineageListRequest.LineageListRequestBuilder<C,B>>
    • guid

      public B guid(String guid)
      Unique identifier of the asset for which to retrieve lineage.
      Returns:
      this.
    • depth

      public B depth(Integer depth)
      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.)
      Returns:
      this.
    • direction

      public B direction(AtlanLineageDirection direction)
      Indicates whether to fetch upstream lineage only, downstream lineage only, or both.
      Returns:
      this.
    • entityFilters

      public B entityFilters(FilterList entityFilters)
      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).
      Returns:
      this.
    • entityTraversalFilters

      public B entityTraversalFilters(FilterList 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

      public B relationshipTraversalFilters(FilterList 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

      public B attribute(String attribute)
    • attributes

      public B attributes(Collection<? extends String> attributes)
    • clearAttributes

      public B clearAttributes()
    • relationAttribute

      public B relationAttribute(String relationAttribute)
    • relationAttributes

      public B relationAttributes(Collection<? extends String> relationAttributes)
    • clearRelationAttributes

      public B clearRelationAttributes()
    • from

      public B from(Integer from)
      Starting point for pagination.
      Returns:
      this.
    • size

      public B size(Integer size)
      How many results to include in each page of results.
      Returns:
      this.
    • excludeMeanings

      public B excludeMeanings(Boolean excludeMeanings)
      Whether to include assigned terms for assets (false) or not (true).
      Returns:
      this.
    • excludeAtlanTags

      public B excludeAtlanTags(Boolean excludeAtlanTags)
      Whether to include Atlan tags for assets (false) or not (true).
      Returns:
      this.
    • immediateNeighbors

      public B immediateNeighbors(Boolean immediateNeighbors)
      Whether to include immediate neighbors of the starting asset in the response.
      Returns:
      this.
    • self

      protected abstract B self()
      Specified by:
      self in class AtlanObject.AtlanObjectBuilder<C extends LineageListRequest,B extends LineageListRequest.LineageListRequestBuilder<C,B>>
    • build

      public abstract C build()
      Specified by:
      build in class AtlanObject.AtlanObjectBuilder<C extends LineageListRequest,B extends LineageListRequest.LineageListRequestBuilder<C,B>>
    • toString

      public String toString()
      Overrides:
      toString in class AtlanObject.AtlanObjectBuilder<C extends LineageListRequest,B extends LineageListRequest.LineageListRequestBuilder<C,B>>