Class SisenseDatamodel

All Implemented Interfaces:
IAsset, IBI, ICatalog, IReferenceable, ISisense, ISisenseDatamodel, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2") public class SisenseDatamodel extends Asset implements ISisenseDatamodel, ISisense, IBI, ICatalog, IAsset, IReferenceable
Instance of a Sisense datamodel in Atlan. These group tables together that you can use to build dashboards.
See Also:
  • Field Details Link icon

  • Constructor Details Link icon

  • Method Details Link icon

    • trimToReference Link icon

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

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

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

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

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

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

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

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

      public static SisenseDatamodel get(AtlanClient client, String id, boolean includeAllRelationships) throws AtlanException
      Retrieves a SisenseDatamodel 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 SisenseDatamodel to retrieve, either its GUID or its full qualifiedName
      includeAllRelationships - if true, all the asset's relationships will also be retrieved; if false, no relationships will be retrieved
      Returns:
      the requested full SisenseDatamodel, optionally complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the SisenseDatamodel does not exist or the provided GUID is not a SisenseDatamodel
    • get Link icon

      public static SisenseDatamodel get(AtlanClient client, String id, Collection<AtlanField> attributes) throws AtlanException
      Retrieves a SisenseDatamodel by one of its identifiers, with only the requested attributes (and relationships).
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the SisenseDatamodel to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the SisenseDatamodel, including any relationships
      Returns:
      the requested SisenseDatamodel, with only its minimal information and the requested attributes (and relationships)
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the SisenseDatamodel does not exist or the provided GUID is not a SisenseDatamodel
    • get Link icon

      public static SisenseDatamodel get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated) throws AtlanException
      Retrieves a SisenseDatamodel by one of its identifiers, with only the requested attributes (and relationships).
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the SisenseDatamodel to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the SisenseDatamodel, including any relationships
      attributesOnRelated - to retrieve on each relationship retrieved for the SisenseDatamodel
      Returns:
      the requested SisenseDatamodel, with only its minimal information and the requested attributes (and relationships)
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the SisenseDatamodel does not exist or the provided GUID is not a SisenseDatamodel
    • restore Link icon

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

      public static SisenseDatamodel.SisenseDatamodelBuilder<?,?> updater(String qualifiedName, String name)
      Builds the minimal object necessary to update a SisenseDatamodel.
      Parameters:
      qualifiedName - of the SisenseDatamodel
      name - of the SisenseDatamodel
      Returns:
      the minimal request necessary to update the SisenseDatamodel, as a builder
    • trimToRequired Link icon

      Builds the minimal object necessary to apply an update to a SisenseDatamodel, from a potentially more-complete SisenseDatamodel object.
      Overrides:
      trimToRequired in class Asset
      Returns:
      the minimal object necessary to update the SisenseDatamodel, as a builder
      Throws:
      InvalidRequestException - if any of the minimal set of required properties for SisenseDatamodel are not found in the initial object
    • removeDescription Link icon

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

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

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

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

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

      public static SisenseDatamodel updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a SisenseDatamodel.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the SisenseDatamodel's announcement
      qualifiedName - of the SisenseDatamodel
      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 Link icon

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

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

      @Deprecated public static SisenseDatamodel appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Link additional terms to the SisenseDatamodel, without replacing existing terms linked to the SisenseDatamodel. Note: this operation must make two API calls — one to retrieve the SisenseDatamodel'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 SisenseDatamodel
      qualifiedName - for the SisenseDatamodel
      terms - the list of terms to append to the SisenseDatamodel
      Returns:
      the SisenseDatamodel that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems
    • removeTerms Link icon

      @Deprecated public static SisenseDatamodel removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Remove terms from a SisenseDatamodel, without replacing all existing terms linked to the SisenseDatamodel. Note: this operation must make two API calls — one to retrieve the SisenseDatamodel'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 SisenseDatamodel
      qualifiedName - for the SisenseDatamodel
      terms - the list of terms to remove from the SisenseDatamodel, which must be referenced by GUID
      Returns:
      the SisenseDatamodel that was updated (note that it will NOT contain details of the resulting terms)
      Throws:
      AtlanException - on any API problems
    • appendAtlanTags Link icon

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

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

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

      public static SisenseDatamodel.SisenseDatamodelBuilder<?,?> _internal()
    • toBuilder Link icon

      Overrides:
      toBuilder in class Reference
    • getInputToAirflowTasks Link icon

      public SortedSet<IAirflowTask> getInputToAirflowTasks()
      Tasks to which this asset provides input.
      Specified by:
      getInputToAirflowTasks in interface IBI
      Specified by:
      getInputToAirflowTasks in interface ICatalog
      Specified by:
      getInputToAirflowTasks in interface ISisense
      Specified by:
      getInputToAirflowTasks in interface ISisenseDatamodel
    • getInputToProcesses Link icon

      public SortedSet<ILineageProcess> getInputToProcesses()
      Processes to which this asset provides input.
      Specified by:
      getInputToProcesses in interface IBI
      Specified by:
      getInputToProcesses in interface ICatalog
      Specified by:
      getInputToProcesses in interface ISisense
      Specified by:
      getInputToProcesses in interface ISisenseDatamodel
    • getInputToSparkJobs Link icon

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface IBI
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface ISisense
      Specified by:
      getInputToSparkJobs in interface ISisenseDatamodel
    • getModelImplementedAttributes Link icon

      public SortedSet<IModelAttribute> getModelImplementedAttributes()
      Attributes implemented by this asset.
      Specified by:
      getModelImplementedAttributes in interface IBI
      Specified by:
      getModelImplementedAttributes in interface ICatalog
      Specified by:
      getModelImplementedAttributes in interface ISisense
      Specified by:
      getModelImplementedAttributes in interface ISisenseDatamodel
    • getModelImplementedEntities Link icon

      public SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
      Specified by:
      getModelImplementedEntities in interface IBI
      Specified by:
      getModelImplementedEntities in interface ICatalog
      Specified by:
      getModelImplementedEntities in interface ISisense
      Specified by:
      getModelImplementedEntities in interface ISisenseDatamodel
    • getOutputFromAirflowTasks Link icon

      public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
      Tasks from which this asset is output.
      Specified by:
      getOutputFromAirflowTasks in interface IBI
      Specified by:
      getOutputFromAirflowTasks in interface ICatalog
      Specified by:
      getOutputFromAirflowTasks in interface ISisense
      Specified by:
      getOutputFromAirflowTasks in interface ISisenseDatamodel
    • getOutputFromProcesses Link icon

      public SortedSet<ILineageProcess> getOutputFromProcesses()
      Processes from which this asset is produced as output.
      Specified by:
      getOutputFromProcesses in interface IBI
      Specified by:
      getOutputFromProcesses in interface ICatalog
      Specified by:
      getOutputFromProcesses in interface ISisense
      Specified by:
      getOutputFromProcesses in interface ISisenseDatamodel
    • getOutputFromSparkJobs Link icon

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface IBI
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface ISisense
      Specified by:
      getOutputFromSparkJobs in interface ISisenseDatamodel
    • getSisenseDashboards Link icon

      public SortedSet<ISisenseDashboard> getSisenseDashboards()
      TBC
      Specified by:
      getSisenseDashboards in interface ISisenseDatamodel
    • getSisenseDatamodelLastBuildTime Link icon

      public Long getSisenseDatamodelLastBuildTime()
      Time (epoch) when this datamodel was last built, in milliseconds.
      Specified by:
      getSisenseDatamodelLastBuildTime in interface ISisenseDatamodel
    • getSisenseDatamodelLastPublishTime Link icon

      public Long getSisenseDatamodelLastPublishTime()
      Time (epoch) when this datamodel was last published, in milliseconds.
      Specified by:
      getSisenseDatamodelLastPublishTime in interface ISisenseDatamodel
    • getSisenseDatamodelLastSuccessfulBuildTime Link icon

      public Long getSisenseDatamodelLastSuccessfulBuildTime()
      Time (epoch) when this datamodel was last built successfully, in milliseconds.
      Specified by:
      getSisenseDatamodelLastSuccessfulBuildTime in interface ISisenseDatamodel
    • getSisenseDatamodelRelationType Link icon

      public String getSisenseDatamodelRelationType()
      Default relation type for this datamodel. 'extract' type Datamodels have regular relations by default. 'live' type Datamodels have direct relations by default.
      Specified by:
      getSisenseDatamodelRelationType in interface ISisenseDatamodel
    • getSisenseDatamodelRevision Link icon

      public String getSisenseDatamodelRevision()
      Revision of this datamodel.
      Specified by:
      getSisenseDatamodelRevision in interface ISisenseDatamodel
    • getSisenseDatamodelServer Link icon

      public String getSisenseDatamodelServer()
      Hostname of the server on which this datamodel was created.
      Specified by:
      getSisenseDatamodelServer in interface ISisenseDatamodel
    • getSisenseDatamodelTableCount Link icon

      public Long getSisenseDatamodelTableCount()
      Number of tables in this datamodel.
      Specified by:
      getSisenseDatamodelTableCount in interface ISisenseDatamodel
    • getSisenseDatamodelTables Link icon

      public SortedSet<ISisenseDatamodelTable> getSisenseDatamodelTables()
      Datamodel tables that exist within this datamodel.
      Specified by:
      getSisenseDatamodelTables in interface ISisenseDatamodel
    • getSisenseDatamodelType Link icon

      public String getSisenseDatamodelType()
      Type of this datamodel, for example: 'extract' or 'custom'.
      Specified by:
      getSisenseDatamodelType in interface ISisenseDatamodel
    • equals Link icon

      public boolean equals(Object o)
      Overrides:
      equals in class Asset
    • canEqual Link icon

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class Asset
    • hashCode Link icon

      public int hashCode()
      Overrides:
      hashCode in class Asset
    • toString Link icon

      public String toString()
      Description copied from class: AtlanObject
      Overrides:
      toString in class Asset
    • getTypeName Link icon

      public String getTypeName()
      Fixed typeName for SisenseDatamodels.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface IBI
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface IReferenceable
      Specified by:
      getTypeName in interface ISisense
      Specified by:
      getTypeName in interface ISisenseDatamodel
      Overrides:
      getTypeName in class Reference