Package com.atlan.model.assets

Class AtlanQuery

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.AtlanQuery
All Implemented Interfaces:
IAsset, IAtlanQuery, ICatalog, IReferenceable, ISQL, AuditDetail, Serializable, Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2") public class AtlanQuery extends Asset implements IAtlanQuery, ISQL, ICatalog, IAsset, IReferenceable
Instance of a query in Atlan.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

      public AtlanQuery trimToReference() throws InvalidRequestException
      Builds the minimal object necessary to create a relationship to a AtlanQuery, from a potentially more-complete AtlanQuery object.
      Overrides:
      trimToReference in class Asset
      Returns:
      the minimal object necessary to relate to the AtlanQuery
      Throws:
      InvalidRequestException - if any of the minimal set of required properties for a AtlanQuery relationship are not found in the initial object

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select()
      Start a fluent search that will return all AtlanQuery assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) AtlanQuery assets will be included.
      Returns:
      a fluent search that includes all AtlanQuery assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)
      Start a fluent search that will return all AtlanQuery assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) AtlanQuery assets will be included.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the assets
      Returns:
      a fluent search that includes all AtlanQuery assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(boolean includeArchived)
      Start a fluent search that will return all AtlanQuery assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.
      Parameters:
      includeArchived - when true, archived (soft-deleted) AtlanQuerys will be included
      Returns:
      a fluent search that includes all AtlanQuery assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived)
      Start a fluent search that will return all AtlanQuery assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the assets
      includeArchived - when true, archived (soft-deleted) AtlanQuerys will be included
      Returns:
      a fluent search that includes all AtlanQuery assets

    • refByGuid

      public static AtlanQuery refByGuid(String guid)
      Reference to a AtlanQuery by GUID. Use this to create a relationship to this AtlanQuery, where the relationship should be replaced.
      Parameters:
      guid - the GUID of the AtlanQuery to reference
      Returns:
      reference to a AtlanQuery that can be used for defining a relationship to a AtlanQuery

    • refByGuid

      public static AtlanQuery refByGuid(String guid, Reference.SaveSemantic semantic)
      Reference to a AtlanQuery by GUID. Use this to create a relationship to this AtlanQuery, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
      Parameters:
      guid - the GUID of the AtlanQuery to reference
      semantic - how to save this relationship (replace all with this, append it, or remove it)
      Returns:
      reference to a AtlanQuery that can be used for defining a relationship to a AtlanQuery

    • refByQualifiedName

      public static AtlanQuery refByQualifiedName(String qualifiedName)
      Reference to a AtlanQuery by qualifiedName. Use this to create a relationship to this AtlanQuery, where the relationship should be replaced.
      Parameters:
      qualifiedName - the qualifiedName of the AtlanQuery to reference
      Returns:
      reference to a AtlanQuery that can be used for defining a relationship to a AtlanQuery

    • refByQualifiedName

      public static AtlanQuery refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)
      Reference to a AtlanQuery by qualifiedName. Use this to create a relationship to this AtlanQuery, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
      Parameters:
      qualifiedName - the qualifiedName of the AtlanQuery to reference
      semantic - how to save this relationship (replace all with this, append it, or remove it)
      Returns:
      reference to a AtlanQuery that can be used for defining a relationship to a AtlanQuery

    • get

      public static AtlanQuery get(String id) throws AtlanException
      Retrieves a AtlanQuery by one of its identifiers, complete with all of its relationships.
      Parameters:
      id - of the AtlanQuery to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full AtlanQuery, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the AtlanQuery does not exist or the provided GUID is not a AtlanQuery

    • get

      public static AtlanQuery get(AtlanClient client, String id) throws AtlanException
      Retrieves a AtlanQuery by one of its identifiers, complete with all of its relationships.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the AtlanQuery to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full AtlanQuery, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the AtlanQuery does not exist or the provided GUID is not a AtlanQuery

    • get

      public static AtlanQuery get(AtlanClient client, String id, boolean includeRelationships) throws AtlanException
      Retrieves a AtlanQuery by one of its identifiers, optionally complete with all of its relationships.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the AtlanQuery to retrieve, either its GUID or its full qualifiedName
      includeRelationships - if true, all of the asset's relationships will also be retrieved; if false, no relationships will be retrieved
      Returns:
      the requested full AtlanQuery, optionally complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the AtlanQuery does not exist or the provided GUID is not a AtlanQuery

    • restore

      public static boolean restore(String qualifiedName) throws AtlanException
      Restore the archived (soft-deleted) AtlanQuery to active.
      Parameters:
      qualifiedName - for the AtlanQuery
      Returns:
      true if the AtlanQuery is now active, and false otherwise
      Throws:
      AtlanException - on any API problems

    • restore

      public static boolean restore(AtlanClient client, String qualifiedName) throws AtlanException
      Restore the archived (soft-deleted) AtlanQuery to active.
      Parameters:
      client - connectivity to the Atlan tenant on which to restore the asset
      qualifiedName - for the AtlanQuery
      Returns:
      true if the AtlanQuery is now active, and false otherwise
      Throws:
      AtlanException - on any API problems

    • creator

      public static AtlanQuery.AtlanQueryBuilder<?,?> creator(String name, Folder parentFolder) throws InvalidRequestException
      Builds the minimal object necessary to create a Query.
      Parameters:
      name - of the Query
      parentFolder - in which the Query should be created, which must have at least a qualifiedName
      Returns:
      the minimal request necessary to create the Query, as a builder
      Throws:
      InvalidRequestException - if the parentFolder provided is without a qualifiedName

    • creator

      public static AtlanQuery.AtlanQueryBuilder<?,?> creator(String name, AtlanCollection collection) throws InvalidRequestException
      Builds the minimal object necessary to create a Query.
      Parameters:
      name - of the Query
      collection - in which the Query should be created, which must have at least a qualifiedName
      Returns:
      the minimal request necessary to create the Query, as a builder
      Throws:
      InvalidRequestException - if the collection provided is without a qualifiedName

    • creator

      public static AtlanQuery.AtlanQueryBuilder<?,?> creator(String name, String collectionQualifiedName, String parentFolderQualifiedName)
      Builds the minimal object necessary to create a Query.
      Parameters:
      name - of the Query
      collectionQualifiedName - unique name of the AtlanCollection in which the Query should be created
      parentFolderQualifiedName - unique name of the Folder in which this Query should be created, or null if it should be created directly in the collection
      Returns:
      the minimal request necessary to create the Query, as a builder

    • generateQualifiedName

      public static String generateQualifiedName(String name, String parentQualifiedName)
      Generate a unique Query.
      Parameters:
      name - of the Query
      parentQualifiedName - unique name of the collection or folder in which this Query exists
      Returns:
      a unique name for the Query

    • updater

      public static AtlanQuery.AtlanQueryBuilder<?,?> updater(String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName)
      Builds the minimal object necessary to update a AtlanQuery.
      Parameters:
      qualifiedName - of the AtlanQuery
      name - of the AtlanQuery
      collectionQualifiedName - qualifiedName of the parent collection the query is contained within
      parentQualifiedName - qualifiedName of the parent collection or folder the query is contained within
      Returns:
      the minimal request necessary to update the AtlanQuery, as a builder

    • trimToRequired

      public AtlanQuery.AtlanQueryBuilder<?,?> trimToRequired() throws InvalidRequestException
      Builds the minimal object necessary to apply an update to a AtlanQuery, from a potentially more-complete AtlanQuery object.
      Overrides:
      trimToRequired in class Asset
      Returns:
      the minimal object necessary to update the AtlanQuery, as a builder
      Throws:
      InvalidRequestException - if any of the minimal set of required properties for AtlanQuery are not found in the initial object

    • findByName

      public static List<AtlanQuery> findByName(String name) throws AtlanException
      Find a query by its human-readable name. Only the bare minimum set of attributes and no relationships will be retrieved for the query, if found.
      Parameters:
      name - of the query
      Returns:
      all queries with that name, if found
      Throws:
      AtlanException - on any API problems
      NotFoundException - if the query does not exist

    • findByName

      public static List<AtlanQuery> findByName(String name, Collection<String> attributes) throws AtlanException
      Find a query by its human-readable name.
      Parameters:
      name - of the query
      attributes - an optional collection of attributes (unchecked) to retrieve for the query
      Returns:
      all queries with that name, if found
      Throws:
      AtlanException - on any API problems
      NotFoundException - if the query does not exist

    • findByName

      public static List<AtlanQuery> findByName(String name, List<AtlanField> attributes) throws AtlanException
      Find a query by its human-readable name.
      Parameters:
      name - of the query
      attributes - an optional collection of attributes (checked) to retrieve for the query
      Returns:
      all queries with that name, if found
      Throws:
      AtlanException - on any API problems
      NotFoundException - if the query does not exist

    • findByName

      public static List<AtlanQuery> findByName(AtlanClient client, String name) throws AtlanException
      Find a query by its human-readable name. Only the bare minimum set of attributes and no relationships will be retrieved for the query, if found.
      Parameters:
      client - connectivity to the Atlan tenant in which to search for the query
      name - of the query
      Returns:
      all queries with that name, if found
      Throws:
      AtlanException - on any API problems
      NotFoundException - if the query does not exist

    • findByName

      public static List<AtlanQuery> findByName(AtlanClient client, String name, Collection<String> attributes) throws AtlanException
      Find a query by its human-readable name.
      Parameters:
      client - connectivity to the Atlan tenant in which to search for the query
      name - of the query
      attributes - an optional collection of attributes to retrieve for the query
      Returns:
      all queries with that name, if found
      Throws:
      AtlanException - on any API problems
      NotFoundException - if the query does not exist

    • findByName

      public static List<AtlanQuery> findByName(AtlanClient client, String name, List<AtlanField> attributes) throws AtlanException
      Find a query by its human-readable name.
      Parameters:
      client - connectivity to the Atlan tenant in which to search for the query
      name - of the query
      attributes - an optional collection of attributes (checked) to retrieve for the query
      Returns:
      all queries with that name, if found
      Throws:
      AtlanException - on any API problems
      NotFoundException - if the query does not exist

    • removeDescription

      public static AtlanQuery removeDescription(String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName) throws AtlanException
      Remove the system description from a AtlanQuery.
      Parameters:
      qualifiedName - of the AtlanQuery
      name - of the AtlanQuery
      collectionQualifiedName - qualifiedName of the AtlanQuery's collection
      parentQualifiedName - qualifiedName of the AtlanQuery's parent namespace
      Returns:
      the updated AtlanQuery, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeDescription

      public static AtlanQuery removeDescription(AtlanClient client, String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName) throws AtlanException
      Remove the system description from a AtlanQuery.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the AtlanQuery's description
      qualifiedName - of the AtlanQuery
      name - of the AtlanQuery
      collectionQualifiedName - qualifiedName of the AtlanQuery's collection
      parentQualifiedName - qualifiedName of the AtlanQuery's parent namespace
      Returns:
      the updated AtlanQuery, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeUserDescription

      public static AtlanQuery removeUserDescription(String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName) throws AtlanException
      Remove the user's description from a AtlanQuery.
      Parameters:
      qualifiedName - of the AtlanQuery
      name - of the AtlanQuery
      collectionQualifiedName - qualifiedName of the AtlanQuery's collection
      parentQualifiedName - qualifiedName of the AtlanQuery's parent namespace
      Returns:
      the updated AtlanQuery, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeUserDescription

      public static AtlanQuery removeUserDescription(AtlanClient client, String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName) throws AtlanException
      Remove the user's description from a AtlanQuery.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the AtlanQuery's description
      qualifiedName - of the AtlanQuery
      name - of the AtlanQuery
      collectionQualifiedName - qualifiedName of the AtlanQuery's collection
      parentQualifiedName - qualifiedName of the AtlanQuery's parent namespace
      Returns:
      the updated AtlanQuery, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeOwners

      public static AtlanQuery removeOwners(String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName) throws AtlanException
      Remove the owners from a AtlanQuery.
      Parameters:
      qualifiedName - of the AtlanQuery
      name - of the AtlanQuery
      collectionQualifiedName - qualifiedName of the AtlanQuery's collection
      parentQualifiedName - qualifiedName of the AtlanQuery's parent namespace
      Returns:
      the updated AtlanQuery, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeOwners

      public static AtlanQuery removeOwners(AtlanClient client, String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName) throws AtlanException
      Remove the owners from a AtlanQuery.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the AtlanQuery's owners
      qualifiedName - of the AtlanQuery
      name - of the AtlanQuery
      collectionQualifiedName - qualifiedName of the AtlanQuery's collection
      parentQualifiedName - qualifiedName of the AtlanQuery's parent namespace
      Returns:
      the updated AtlanQuery, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • updateCertificate

      public static AtlanQuery updateCertificate(String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName, CertificateStatus certificate, String message) throws AtlanException
      Update the certificate on a AtlanQuery.
      Parameters:
      qualifiedName - of the AtlanQuery
      name - of the AtlanQuery
      collectionQualifiedName - qualifiedName of the AtlanQuery's collection
      parentQualifiedName - qualifiedName of the AtlanQuery's parent namespace
      certificate - to use
      message - (optional) message, or null if no message
      Returns:
      the updated AtlanQuery, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • updateCertificate

      public static AtlanQuery updateCertificate(AtlanClient client, String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName, CertificateStatus certificate, String message) throws AtlanException
      Update the certificate on a AtlanQuery.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the AtlanQuery's certificate
      qualifiedName - of the AtlanQuery
      name - of the AtlanQuery
      collectionQualifiedName - qualifiedName of the AtlanQuery's collection
      parentQualifiedName - qualifiedName of the AtlanQuery's parent namespace
      certificate - to use
      message - (optional) message, or null if no message
      Returns:
      the updated AtlanQuery, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • removeCertificate

      public static AtlanQuery removeCertificate(String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName) throws AtlanException
      Remove the certificate from a AtlanQuery.
      Parameters:
      qualifiedName - of the AtlanQuery
      name - of the AtlanQuery
      collectionQualifiedName - qualifiedName of the AtlanQuery's collection
      parentQualifiedName - qualifiedName of the AtlanQuery's parent namespace
      Returns:
      the updated AtlanQuery, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeCertificate

      public static AtlanQuery removeCertificate(AtlanClient client, String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName) throws AtlanException
      Remove the certificate from a AtlanQuery.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the AtlanQuery's certificate
      qualifiedName - of the AtlanQuery
      name - of the AtlanQuery
      collectionQualifiedName - qualifiedName of the AtlanQuery's collection
      parentQualifiedName - qualifiedName of the AtlanQuery's parent namespace
      Returns:
      the updated AtlanQuery, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • updateAnnouncement

      public static AtlanQuery updateAnnouncement(String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a AtlanQuery.
      Parameters:
      qualifiedName - of the AtlanQuery
      name - of the AtlanQuery
      collectionQualifiedName - qualifiedName of the AtlanQuery's collection
      parentQualifiedName - qualifiedName of the AtlanQuery's parent namespace
      type - type of announcement to set
      title - (optional) title of the announcement to set (or null for no title)
      message - (optional) message of the announcement to set (or null for no message)
      Returns:
      the updated AtlanQuery, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • updateAnnouncement

      public static AtlanQuery updateAnnouncement(AtlanClient client, String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a AtlanQuery.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the AtlanQuery's announcement
      qualifiedName - of the AtlanQuery
      name - of the AtlanQuery
      collectionQualifiedName - qualifiedName of the AtlanQuery's collection
      parentQualifiedName - qualifiedName of the AtlanQuery's parent namespace
      type - type of announcement to set
      title - (optional) title of the announcement to set (or null for no title)
      message - (optional) message of the announcement to set (or null for no message)
      Returns:
      the updated AtlanQuery, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • removeAnnouncement

      public static AtlanQuery removeAnnouncement(String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName) throws AtlanException
      Remove the announcement from a AtlanQuery.
      Parameters:
      qualifiedName - of the AtlanQuery
      name - of the AtlanQuery
      collectionQualifiedName - qualifiedName of the AtlanQuery's collection
      parentQualifiedName - qualifiedName of the AtlanQuery's parent namespace
      Returns:
      the updated AtlanQuery, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeAnnouncement

      public static AtlanQuery removeAnnouncement(AtlanClient client, String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName) throws AtlanException
      Remove the announcement from a AtlanQuery.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the AtlanQuery's announcement
      qualifiedName - of the AtlanQuery
      name - of the AtlanQuery
      collectionQualifiedName - qualifiedName of the AtlanQuery's collection
      parentQualifiedName - qualifiedName of the AtlanQuery's parent namespace
      Returns:
      the updated AtlanQuery, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static AtlanQuery appendAtlanTags(String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Add Atlan tags to a AtlanQuery, without replacing existing Atlan tags linked to the AtlanQuery. Note: this operation must make two API calls — one to retrieve the AtlanQuery's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      qualifiedName - of the AtlanQuery
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated AtlanQuery
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static AtlanQuery appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Add Atlan tags to a AtlanQuery, without replacing existing Atlan tags linked to the AtlanQuery. Note: this operation must make two API calls — one to retrieve the AtlanQuery's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      client - connectivity to the Atlan tenant on which to append Atlan tags to the AtlanQuery
      qualifiedName - of the AtlanQuery
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated AtlanQuery
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static AtlanQuery appendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a AtlanQuery, without replacing existing Atlan tags linked to the AtlanQuery. Note: this operation must make two API calls — one to retrieve the AtlanQuery's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      qualifiedName - of the AtlanQuery
      atlanTagNames - human-readable names of the Atlan tags to add
      propagate - whether to propagate the Atlan tag (true) or not (false)
      removePropagationsOnDelete - whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)
      restrictLineagePropagation - whether to avoid propagating through lineage (true) or do propagate through lineage (false)
      Returns:
      the updated AtlanQuery
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static AtlanQuery appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a AtlanQuery, without replacing existing Atlan tags linked to the AtlanQuery. Note: this operation must make two API calls — one to retrieve the AtlanQuery's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      client - connectivity to the Atlan tenant on which to append Atlan tags to the AtlanQuery
      qualifiedName - of the AtlanQuery
      atlanTagNames - human-readable names of the Atlan tags to add
      propagate - whether to propagate the Atlan tag (true) or not (false)
      removePropagationsOnDelete - whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)
      restrictLineagePropagation - whether to avoid propagating through lineage (true) or do propagate through lineage (false)
      Returns:
      the updated AtlanQuery
      Throws:
      AtlanException - on any API problems

    • removeAtlanTag

      public static void removeAtlanTag(String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a AtlanQuery.
      Parameters:
      qualifiedName - of the AtlanQuery
      atlanTagName - human-readable name of the Atlan tag to remove
      Throws:
      AtlanException - on any API problems, or if the Atlan tag does not exist on the AtlanQuery

    • removeAtlanTag

      public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a AtlanQuery.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove an Atlan tag from a AtlanQuery
      qualifiedName - of the AtlanQuery
      atlanTagName - human-readable name of the Atlan tag to remove
      Throws:
      AtlanException - on any API problems, or if the Atlan tag does not exist on the AtlanQuery

    • _internal

      public static AtlanQuery.AtlanQueryBuilder<?,?> _internal()

    • toBuilder

      public AtlanQuery.AtlanQueryBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getApplicationContainer

      public IApplicationContainer getApplicationContainer()
      TBC
      Specified by:
      getApplicationContainer in interface IAtlanQuery
      Specified by:
      getApplicationContainer in interface ICatalog
      Specified by:
      getApplicationContainer in interface ISQL

    • getAssetApplicationQualifiedName

      public String getAssetApplicationQualifiedName()
      TBC
      Specified by:
      getAssetApplicationQualifiedName in interface IAtlanQuery
      Specified by:
      getAssetApplicationQualifiedName in interface ICatalog
      Specified by:
      getAssetApplicationQualifiedName in interface ISQL

    • getCalculationViewName

      public String getCalculationViewName()
      TBC
      Specified by:
      getCalculationViewName in interface IAtlanQuery
      Specified by:
      getCalculationViewName in interface ISQL

    • getCalculationViewQualifiedName

      public String getCalculationViewQualifiedName()
      TBC
      Specified by:
      getCalculationViewQualifiedName in interface IAtlanQuery
      Specified by:
      getCalculationViewQualifiedName in interface ISQL

    • getCollectionQualifiedName

      public String getCollectionQualifiedName()
      TBC
      Specified by:
      getCollectionQualifiedName in interface IAtlanQuery

    • getColumns

      public SortedSet<IColumn> getColumns()
      TBC
      Specified by:
      getColumns in interface IAtlanQuery

    • getDatabaseName

      public String getDatabaseName()
      TBC
      Specified by:
      getDatabaseName in interface IAtlanQuery
      Specified by:
      getDatabaseName in interface ISQL

    • getDatabaseQualifiedName

      public String getDatabaseQualifiedName()
      TBC
      Specified by:
      getDatabaseQualifiedName in interface IAtlanQuery
      Specified by:
      getDatabaseQualifiedName in interface ISQL

    • getDbtModels

      public SortedSet<IDbtModel> getDbtModels()
      TBC
      Specified by:
      getDbtModels in interface IAtlanQuery
      Specified by:
      getDbtModels in interface ISQL

    • getDbtSources

      public SortedSet<IDbtSource> getDbtSources()
      TBC
      Specified by:
      getDbtSources in interface IAtlanQuery
      Specified by:
      getDbtSources in interface ISQL

    • getDbtTests

      public SortedSet<IDbtTest> getDbtTests()
      TBC
      Specified by:
      getDbtTests in interface IAtlanQuery
      Specified by:
      getDbtTests in interface ISQL

    • getDefaultDatabaseQualifiedName

      public String getDefaultDatabaseQualifiedName()
      TBC
      Specified by:
      getDefaultDatabaseQualifiedName in interface IAtlanQuery

    • getDefaultSchemaQualifiedName

      public String getDefaultSchemaQualifiedName()
      TBC
      Specified by:
      getDefaultSchemaQualifiedName in interface IAtlanQuery

    • getInputToAirflowTasks

      public SortedSet<IAirflowTask> getInputToAirflowTasks()
      TBC
      Specified by:
      getInputToAirflowTasks in interface IAtlanQuery
      Specified by:
      getInputToAirflowTasks in interface ICatalog
      Specified by:
      getInputToAirflowTasks in interface ISQL

    • getInputToProcesses

      public SortedSet<ILineageProcess> getInputToProcesses()
      TBC
      Specified by:
      getInputToProcesses in interface IAtlanQuery
      Specified by:
      getInputToProcesses in interface ICatalog
      Specified by:
      getInputToProcesses in interface ISQL

    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface IAtlanQuery
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface ISQL

    • getIsPrivate

      public Boolean getIsPrivate()
      TBC
      Specified by:
      getIsPrivate in interface IAtlanQuery

    • getIsProfiled

      public Boolean getIsProfiled()
      TBC
      Specified by:
      getIsProfiled in interface IAtlanQuery
      Specified by:
      getIsProfiled in interface ISQL

    • getIsSqlSnippet

      public Boolean getIsSqlSnippet()
      TBC
      Specified by:
      getIsSqlSnippet in interface IAtlanQuery

    • getIsVisualQuery

      public Boolean getIsVisualQuery()
      TBC
      Specified by:
      getIsVisualQuery in interface IAtlanQuery

    • getLastProfiledAt

      public Long getLastProfiledAt()
      TBC
      Specified by:
      getLastProfiledAt in interface IAtlanQuery
      Specified by:
      getLastProfiledAt in interface ISQL

    • getLongRawQuery

      public String getLongRawQuery()
      TBC
      Specified by:
      getLongRawQuery in interface IAtlanQuery

    • getModelImplementedEntities

      public SortedSet<IModelEntity> getModelImplementedEntities()
      TBC
      Specified by:
      getModelImplementedEntities in interface IAtlanQuery
      Specified by:
      getModelImplementedEntities in interface ICatalog
      Specified by:
      getModelImplementedEntities in interface ISQL

    • getOutputFromAirflowTasks

      public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
      TBC
      Specified by:
      getOutputFromAirflowTasks in interface IAtlanQuery
      Specified by:
      getOutputFromAirflowTasks in interface ICatalog
      Specified by:
      getOutputFromAirflowTasks in interface ISQL

    • getOutputFromProcesses

      public SortedSet<ILineageProcess> getOutputFromProcesses()
      TBC
      Specified by:
      getOutputFromProcesses in interface IAtlanQuery
      Specified by:
      getOutputFromProcesses in interface ICatalog
      Specified by:
      getOutputFromProcesses in interface ISQL

    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface IAtlanQuery
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface ISQL

    • getParent

      public INamespace getParent()
      TBC
      Specified by:
      getParent in interface IAtlanQuery

    • getParentQualifiedName

      public String getParentQualifiedName()
      TBC
      Specified by:
      getParentQualifiedName in interface IAtlanQuery

    • getQueryCount

      public Long getQueryCount()
      TBC
      Specified by:
      getQueryCount in interface IAtlanQuery
      Specified by:
      getQueryCount in interface ISQL

    • getQueryCountUpdatedAt

      public Long getQueryCountUpdatedAt()
      TBC
      Specified by:
      getQueryCountUpdatedAt in interface IAtlanQuery
      Specified by:
      getQueryCountUpdatedAt in interface ISQL

    • getQueryUserCount

      public Long getQueryUserCount()
      TBC
      Specified by:
      getQueryUserCount in interface IAtlanQuery
      Specified by:
      getQueryUserCount in interface ISQL

    • getQueryUserMap

      public Map<String,Long> getQueryUserMap()
      TBC
      Specified by:
      getQueryUserMap in interface IAtlanQuery
      Specified by:
      getQueryUserMap in interface ISQL

    • getRawQuery

      public String getRawQuery()
      TBC
      Specified by:
      getRawQuery in interface IAtlanQuery

    • getRawQueryText

      public String getRawQueryText()
      TBC
      Specified by:
      getRawQueryText in interface IAtlanQuery

    • getSchemaName

      public String getSchemaName()
      TBC
      Specified by:
      getSchemaName in interface IAtlanQuery
      Specified by:
      getSchemaName in interface ISQL

    • getSchemaQualifiedName

      public String getSchemaQualifiedName()
      TBC
      Specified by:
      getSchemaQualifiedName in interface IAtlanQuery
      Specified by:
      getSchemaQualifiedName in interface ISQL

    • getSqlDBTSources

      public SortedSet<IDbtSource> getSqlDBTSources()
      TBC
      Specified by:
      getSqlDBTSources in interface IAtlanQuery
      Specified by:
      getSqlDBTSources in interface ISQL

    • getSqlDbtModels

      public SortedSet<IDbtModel> getSqlDbtModels()
      TBC
      Specified by:
      getSqlDbtModels in interface IAtlanQuery
      Specified by:
      getSqlDbtModels in interface ISQL

    • getTableName

      public String getTableName()
      TBC
      Specified by:
      getTableName in interface IAtlanQuery
      Specified by:
      getTableName in interface ISQL

    • getTableQualifiedName

      public String getTableQualifiedName()
      TBC
      Specified by:
      getTableQualifiedName in interface IAtlanQuery
      Specified by:
      getTableQualifiedName in interface ISQL

    • getTables

      public SortedSet<ITable> getTables()
      TBC
      Specified by:
      getTables in interface IAtlanQuery

    • getVariablesSchemaBase64

      public String getVariablesSchemaBase64()
      TBC
      Specified by:
      getVariablesSchemaBase64 in interface IAtlanQuery

    • getViewName

      public String getViewName()
      TBC
      Specified by:
      getViewName in interface IAtlanQuery
      Specified by:
      getViewName in interface ISQL

    • getViewQualifiedName

      public String getViewQualifiedName()
      TBC
      Specified by:
      getViewQualifiedName in interface IAtlanQuery
      Specified by:
      getViewQualifiedName in interface ISQL

    • getViews

      public SortedSet<IView> getViews()
      TBC
      Specified by:
      getViews in interface IAtlanQuery

    • getVisualBuilderSchemaBase64

      public String getVisualBuilderSchemaBase64()
      TBC
      Specified by:
      getVisualBuilderSchemaBase64 in interface IAtlanQuery

    • equals

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

    • canEqual

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Asset

    • toString

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

    • getTypeName

      public String getTypeName()
      Fixed typeName for AtlanQuerys.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface IAtlanQuery
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface IReferenceable
      Specified by:
      getTypeName in interface ISQL
      Overrides:
      getTypeName in class Reference