Class TableauWorkbook

All Implemented Interfaces:
IAsset, IBI, ICatalog, IReferenceable, ITableau, ITableauWorkbook, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2") public class TableauWorkbook extends Asset implements ITableauWorkbook, ITableau, IBI, ICatalog, IAsset, IReferenceable
Instance of a Tableau workbook in Atlan. These contain one or more worksheets, datasources or dashboards.
See Also:
  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      public static TableauWorkbook.TableauWorkbookBuilder<?,?> _internal()
    • toBuilder

      public TableauWorkbook.TableauWorkbookBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference
    • getApplicationContainer

      public IApplicationContainer getApplicationContainer()
      ApplicationContainer asset containing this Catalog asset.
      Specified by:
      getApplicationContainer in interface IBI
      Specified by:
      getApplicationContainer in interface ICatalog
      Specified by:
      getApplicationContainer in interface ITableau
      Specified by:
      getApplicationContainer in interface ITableauWorkbook
    • getAssetApplicationQualifiedName

      public String getAssetApplicationQualifiedName()
      Qualified name of the Application Container that contains this asset.
      Specified by:
      getAssetApplicationQualifiedName in interface IBI
      Specified by:
      getAssetApplicationQualifiedName in interface ICatalog
      Specified by:
      getAssetApplicationQualifiedName in interface ITableau
      Specified by:
      getAssetApplicationQualifiedName in interface ITableauWorkbook
    • getDashboards

      public SortedSet<ITableauDashboard> getDashboards()
      Dashboards that exist within this workbook.
      Specified by:
      getDashboards in interface ITableauWorkbook
    • getDatasources

      public SortedSet<ITableauDatasource> getDatasources()
      Datasources that exist within this workbook.
      Specified by:
      getDatasources in interface ITableauWorkbook
    • getInputToAirflowTasks

      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 ITableau
      Specified by:
      getInputToAirflowTasks in interface ITableauWorkbook
    • getInputToProcesses

      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 ITableau
      Specified by:
      getInputToProcesses in interface ITableauWorkbook
    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface IBI
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface ITableau
      Specified by:
      getInputToSparkJobs in interface ITableauWorkbook
    • getModelImplementedEntities

      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 ITableau
      Specified by:
      getModelImplementedEntities in interface ITableauWorkbook
    • getOutputFromAirflowTasks

      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 ITableau
      Specified by:
      getOutputFromAirflowTasks in interface ITableauWorkbook
    • getOutputFromProcesses

      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 ITableau
      Specified by:
      getOutputFromProcesses in interface ITableauWorkbook
    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface IBI
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface ITableau
      Specified by:
      getOutputFromSparkJobs in interface ITableauWorkbook
    • getProject

      public ITableauProject getProject()
      Project in which this workbook exists.
      Specified by:
      getProject in interface ITableauWorkbook
    • getProjectHierarchy

      public List<Map<String,String>> getProjectHierarchy()
      List of top-level projects with their nested child projects.
      Specified by:
      getProjectHierarchy in interface ITableauWorkbook
    • getProjectQualifiedName

      public String getProjectQualifiedName()
      Unique name of the project in which this workbook exists.
      Specified by:
      getProjectQualifiedName in interface ITableauWorkbook
    • getSiteQualifiedName

      public String getSiteQualifiedName()
      Unique name of the site in which this workbook exists.
      Specified by:
      getSiteQualifiedName in interface ITableauWorkbook
    • getTopLevelProjectName

      public String getTopLevelProjectName()
      Simple name of the top-level project in which this workbook exists.
      Specified by:
      getTopLevelProjectName in interface ITableauWorkbook
    • getTopLevelProjectQualifiedName

      public String getTopLevelProjectQualifiedName()
      Unique name of the top-level project in which this workbook exists.
      Specified by:
      getTopLevelProjectQualifiedName in interface ITableauWorkbook
    • getWorksheets

      public SortedSet<ITableauWorksheet> getWorksheets()
      Worksheets that exist within this workbook.
      Specified by:
      getWorksheets in interface ITableauWorkbook
    • 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 TableauWorkbooks.
      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 ITableau
      Specified by:
      getTypeName in interface ITableauWorkbook
      Overrides:
      getTypeName in class Reference