Package com.atlan.model.assets

Class Insight

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.Insight
All Implemented Interfaces:
IAsset, ICatalog, IInsight, IReferenceable, AuditDetail, Serializable, Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2") public class Insight extends Asset implements IInsight, ICatalog, IAsset, IReferenceable
Base class for Insights assets in Atlan.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select()
      Start a fluent search that will return all Insight 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) Insight assets will be included.
      Returns:
      a fluent search that includes all Insight assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)
      Start a fluent search that will return all Insight 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) Insight assets will be included.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the assets
      Returns:
      a fluent search that includes all Insight assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(boolean includeArchived)
      Start a fluent search that will return all Insight 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) Insights will be included
      Returns:
      a fluent search that includes all Insight assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived)
      Start a fluent search that will return all Insight 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) Insights will be included
      Returns:
      a fluent search that includes all Insight assets

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

      public static Insight get(AtlanClient client, String id) throws AtlanException
      Retrieves a Insight 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 Insight to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full Insight, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the Insight does not exist or the provided GUID is not a Insight

    • get

      public static Insight get(AtlanClient client, String id, boolean includeRelationships) throws AtlanException
      Retrieves a Insight 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 Insight 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 Insight, optionally complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the Insight does not exist or the provided GUID is not a Insight

    • restore

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

    • updater

      public static Insight.InsightBuilder<?,?> updater(String qualifiedName, String name)
      Builds the minimal object necessary to update a Insight.
      Parameters:
      qualifiedName - of the Insight
      name - of the Insight
      Returns:
      the minimal request necessary to update the Insight, as a builder

    • trimToRequired

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

    • removeDescription

      public static Insight removeDescription(String qualifiedName, String name) throws AtlanException
      Remove the system description from a Insight.
      Parameters:
      qualifiedName - of the Insight
      name - of the Insight
      Returns:
      the updated Insight, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeDescription

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

    • removeUserDescription

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

    • removeUserDescription

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

    • removeOwners

      public static Insight removeOwners(String qualifiedName, String name) throws AtlanException
      Remove the owners from a Insight.
      Parameters:
      qualifiedName - of the Insight
      name - of the Insight
      Returns:
      the updated Insight, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeOwners

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

    • updateCertificate

      public static Insight updateCertificate(String qualifiedName, CertificateStatus certificate, String message) throws AtlanException
      Update the certificate on a Insight.
      Parameters:
      qualifiedName - of the Insight
      certificate - to use
      message - (optional) message, or null if no message
      Returns:
      the updated Insight, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • updateCertificate

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

    • removeCertificate

      public static Insight removeCertificate(String qualifiedName, String name) throws AtlanException
      Remove the certificate from a Insight.
      Parameters:
      qualifiedName - of the Insight
      name - of the Insight
      Returns:
      the updated Insight, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeCertificate

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

    • updateAnnouncement

      public static Insight updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a Insight.
      Parameters:
      qualifiedName - of the Insight
      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 result of the update, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • updateAnnouncement

      public static Insight updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a Insight.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the Insight's announcement
      qualifiedName - of the Insight
      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 result of the update, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • removeAnnouncement

      public static Insight removeAnnouncement(String qualifiedName, String name) throws AtlanException
      Remove the announcement from a Insight.
      Parameters:
      qualifiedName - of the Insight
      name - of the Insight
      Returns:
      the updated Insight, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeAnnouncement

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

    • replaceTerms

      public static Insight replaceTerms(String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException
      Replace the terms linked to the Insight.
      Parameters:
      qualifiedName - for the Insight
      name - human-readable name of the Insight
      terms - the list of terms to replace on the Insight, or null to remove all terms from the Insight
      Returns:
      the Insight that was updated (note that it will NOT contain details of the replaced terms)
      Throws:
      AtlanException - on any API problems

    • replaceTerms

      public static Insight replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException
      Replace the terms linked to the Insight.
      Parameters:
      client - connectivity to the Atlan tenant on which to replace the Insight's assigned terms
      qualifiedName - for the Insight
      name - human-readable name of the Insight
      terms - the list of terms to replace on the Insight, or null to remove all terms from the Insight
      Returns:
      the Insight that was updated (note that it will NOT contain details of the replaced terms)
      Throws:
      AtlanException - on any API problems

    • appendTerms

      public static Insight appendTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Link additional terms to the Insight, without replacing existing terms linked to the Insight. Note: this operation must make two API calls — one to retrieve the Insight's existing terms, and a second to append the new terms.
      Parameters:
      qualifiedName - for the Insight
      terms - the list of terms to append to the Insight
      Returns:
      the Insight that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems

    • appendTerms

      public static Insight appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Link additional terms to the Insight, without replacing existing terms linked to the Insight. Note: this operation must make two API calls — one to retrieve the Insight's existing terms, and a second to append the new terms.
      Parameters:
      client - connectivity to the Atlan tenant on which to append terms to the Insight
      qualifiedName - for the Insight
      terms - the list of terms to append to the Insight
      Returns:
      the Insight that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems

    • removeTerms

      public static Insight removeTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Remove terms from a Insight, without replacing all existing terms linked to the Insight. Note: this operation must make two API calls — one to retrieve the Insight's existing terms, and a second to remove the provided terms.
      Parameters:
      qualifiedName - for the Insight
      terms - the list of terms to remove from the Insight, which must be referenced by GUID
      Returns:
      the Insight that was updated (note that it will NOT contain details of the resulting terms)
      Throws:
      AtlanException - on any API problems

    • removeTerms

      public static Insight removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Remove terms from a Insight, without replacing all existing terms linked to the Insight. Note: this operation must make two API calls — one to retrieve the Insight's existing terms, and a second to remove the provided terms.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove terms from the Insight
      qualifiedName - for the Insight
      terms - the list of terms to remove from the Insight, which must be referenced by GUID
      Returns:
      the Insight that was updated (note that it will NOT contain details of the resulting terms)
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

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

    • appendAtlanTags

      public static Insight appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Add Atlan tags to a Insight, without replacing existing Atlan tags linked to the Insight. Note: this operation must make two API calls — one to retrieve the Insight'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 Insight
      qualifiedName - of the Insight
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated Insight
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static Insight appendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a Insight, without replacing existing Atlan tags linked to the Insight. Note: this operation must make two API calls — one to retrieve the Insight's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      qualifiedName - of the Insight
      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 Insight
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static Insight appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a Insight, without replacing existing Atlan tags linked to the Insight. Note: this operation must make two API calls — one to retrieve the Insight'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 Insight
      qualifiedName - of the Insight
      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 Insight
      Throws:
      AtlanException - on any API problems

    • removeAtlanTag

      public static void removeAtlanTag(String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a Insight.
      Parameters:
      qualifiedName - of the Insight
      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 Insight

    • removeAtlanTag

      public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a Insight.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove an Atlan tag from a Insight
      qualifiedName - of the Insight
      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 Insight

    • _internal

      public static Insight.InsightBuilder<?,?> _internal()

    • toBuilder

      public Insight.InsightBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getApplicationContainer

      public IApplicationContainer getApplicationContainer()
      ApplicationContainer asset containing this Catalog asset.
      Specified by:
      getApplicationContainer in interface ICatalog
      Specified by:
      getApplicationContainer in interface IInsight

    • getAssetApplicationQualifiedName

      public String getAssetApplicationQualifiedName()
      Qualified name of the Application Container that contains this asset.
      Specified by:
      getAssetApplicationQualifiedName in interface ICatalog
      Specified by:
      getAssetApplicationQualifiedName in interface IInsight

    • getInputToAirflowTasks

      public SortedSet<IAirflowTask> getInputToAirflowTasks()
      Tasks to which this asset provides input.
      Specified by:
      getInputToAirflowTasks in interface ICatalog
      Specified by:
      getInputToAirflowTasks in interface IInsight

    • getInputToProcesses

      public SortedSet<ILineageProcess> getInputToProcesses()
      Processes to which this asset provides input.
      Specified by:
      getInputToProcesses in interface ICatalog
      Specified by:
      getInputToProcesses in interface IInsight

    • getInputToSparkJobs

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

    • getModelImplementedEntities

      public SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
      Specified by:
      getModelImplementedEntities in interface ICatalog
      Specified by:
      getModelImplementedEntities in interface IInsight

    • getOutputFromAirflowTasks

      public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
      Tasks from which this asset is output.
      Specified by:
      getOutputFromAirflowTasks in interface ICatalog
      Specified by:
      getOutputFromAirflowTasks in interface IInsight

    • getOutputFromProcesses

      public SortedSet<ILineageProcess> getOutputFromProcesses()
      Processes from which this asset is produced as output.
      Specified by:
      getOutputFromProcesses in interface ICatalog
      Specified by:
      getOutputFromProcesses in interface IInsight

    • getOutputFromSparkJobs

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

    • 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 Insights.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface IInsight
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference