Package com.atlan.model.discovery

Class LinkableQuery.LinkableQueryBuilder<C extends LinkableQuery,B extends LinkableQuery.LinkableQueryBuilder<C,B>>

java.lang.Object
com.atlan.model.discovery.LinkableQuery.LinkableQueryBuilder<C,B>
Enclosing class:
LinkableQuery
public abstract static class LinkableQuery.LinkableQueryBuilder<C extends LinkableQuery,B extends LinkableQuery.LinkableQueryBuilder<C,B>> extends Object

  • Constructor Details

    • LinkableQueryBuilder

      public LinkableQueryBuilder()

  • Method Details

    • forConnection

      public B forConnection(Connection connection)
      Limit assets to a given connection.
      Parameters:
      connection - for which to limit assets
      Returns:
      the query builder, limited to assets from the specific connection

    • forPrefix

      public B forPrefix(String qualifiedNamePrefix, String denormalizedAttributeName)
      Limit assets to a specified subset of those in a connection.
      Parameters:
      qualifiedNamePrefix - full qualifiedName prefix that all assets in the subset should start with
      denormalizedAttributeName - name of the denormalized attribute where the prefix can be found on all assets (for example, schemaQualifiedName)
      Returns:
      the query builder, limited to a subset of assets in a connection

    • withTag

      public B withTag(String tagName)
      Limit assets to those with a particular Atlan tag assigned.
      Parameters:
      tagName - human-readable name of the Atlan tag
      Returns:
      the query builder, limited to assets with the Atlan tag assigned

    • withTagValue

      public B withTagValue(String tagName, String value)
      Limit assets to those with a particular source tag assigned, with a particular value.
      Parameters:
      tagName - human-readable name of the Atlan tag mapped to a source tag
      value - of the source tag
      Returns:
      the query builder, limited to assets with the Atlan tag assigned with a particular value

    • withoutOwners

      public B withoutOwners()
      Limit assets to those without any owners defined (individuals or groups).
      Returns:
      the query builder, limited to assets without any owners assigned

    • withOwners

      public B withOwners(List<String> usernames, List<String> groups) throws AtlanException
      Limit assets to those with any of the specified owners.
      Parameters:
      usernames - (optional) list of usernames to match as owners
      groups - (optional) list of internal group names to match as owners
      Returns:
      the query builder, limited to assets with any of the specified owners assigned
      Throws:
      AtlanException - if there are problems confirming any of the provided owners

    • withAnyOf

      public B withAnyOf(List<GlossaryTerm> terms)
      Limit assets to those with any of the specified terms assigned.
      Parameters:
      terms - minimal details about the terms, which must include at least GUID, qualifiedName, and name
      Returns:
      the query builder, limited to assets with any of the specified terms assigned

    • withAll

      public B withAll(List<GlossaryTerm> terms)
      Limit assets to those with all the specified terms assigned.
      Parameters:
      terms - minimal details about the terms, which must include at least GUID, qualifiedName, and name
      Returns:
      the query builder, limited to assets with all the specified terms assigned

    • withNoneOf

      public B withNoneOf(List<GlossaryTerm> terms)
      Limit assets to those with none of the specified terms assigned.
      Parameters:
      terms - minimal details about the terms, which must include at least GUID, qualifiedName, and name
      Returns:
      the query builder, limited to assets with none of the specified terms assigned

    • withoutTerms

      public B withoutTerms()
      Limit assets to those with no terms assigned.
      Returns:
      the query builder, limited to assets without any terms assigned

    • withAnyTerm

      public B withAnyTerm()
      Limit assets to those with any terms assigned.
      Returns:
      the query builder, limited to assets with any terms assigned

    • toUrl

      public String toUrl()
      Convert this linkable query into an actual link (URL).
      Returns:
      the URL (without tenant domain / hostname) for accessing this limited set of assets

    • toFullUrl

      public String toFullUrl()
      Convert this linkable query into an actual link (URL). Note: this will not work if the code is running in the tenant itself (e.g. via a custom package).
      Returns:
      the full URL (including tenant domain) for accessing this limited set of assets in the tenant

    • client

      public B client(AtlanClient client)
      Returns:
      this.

    • certificateStatus

      public B certificateStatus(CertificateStatus certificateStatus)

    • certificateStatuses

      public B certificateStatuses(Collection<? extends CertificateStatus> certificateStatuses)

    • clearCertificateStatuses

      public B clearCertificateStatuses()

    • hierarchy

      public B hierarchy(com.atlan.model.discovery.LinkableQuery.AssetHierarchy hierarchy)
      Asset hierarchy (connector type, connection qualifiedName) to limit assets.
      Returns:
      this.

    • owners

      public B owners(com.atlan.model.discovery.LinkableQuery.Owners owners)
      Owners by which to limit assets.
      Returns:
      this.

    • property

      public B property(DiscoveryFilter property)

    • properties

      public B properties(Collection<? extends DiscoveryFilter> properties)

    • clearProperties

      public B clearProperties()

    • tag

      public B tag(TagFilter tag)

    • tags

      public B tags(Collection<? extends TagFilter> tags)

    • clearTags

      public B clearTags()

    • terms

      public B terms(com.atlan.model.discovery.LinkableQuery.Terms terms)
      Terms by which to limit assets.
      Returns:
      this.

    • typeName

      public B typeName(String typeName)

    • typeNames

      public B typeNames(Collection<? extends String> typeNames)

    • clearTypeNames

      public B clearTypeNames()

    • self

      protected abstract B self()

    • build

      public abstract C build()

    • toString

      public String toString()
      Overrides:
      toString in class Object