Class TableauWorksheetField

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

@Generated("com.atlan.generators.ModelGeneratorV2") public class TableauWorksheetField extends Asset implements ITableauWorksheetField, ITableau, IBI, ICatalog, IAsset, IReferenceable
Instance of a Tableau worksheet field in Atlan.
See Also:
  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

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

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

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

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

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

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

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

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

      public static TableauWorksheetField get(AtlanClient client, String id, Collection<AtlanField> attributes) throws AtlanException
      Retrieves a TableauWorksheetField 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 TableauWorksheetField to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the TableauWorksheetField, including any relationships
      Returns:
      the requested TableauWorksheetField, 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 TableauWorksheetField does not exist or the provided GUID is not a TableauWorksheetField
    • get

      public static TableauWorksheetField get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated) throws AtlanException
      Retrieves a TableauWorksheetField 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 TableauWorksheetField to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the TableauWorksheetField, including any relationships
      attributesOnRelated - to retrieve on each relationship retrieved for the TableauWorksheetField
      Returns:
      the requested TableauWorksheetField, 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 TableauWorksheetField does not exist or the provided GUID is not a TableauWorksheetField
    • restore

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    • toBuilder

      Overrides:
      toBuilder in class Reference
    • 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 ITableauWorksheetField
    • 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 ITableauWorksheetField
    • 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 ITableauWorksheetField
    • getModelImplementedAttributes

      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 ITableau
      Specified by:
      getModelImplementedAttributes in interface ITableauWorksheetField
    • 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 ITableauWorksheetField
    • 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 ITableauWorksheetField
    • 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 ITableauWorksheetField
    • 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 ITableauWorksheetField
    • getTableauCalculatedField

      public ITableauCalculatedField getTableauCalculatedField()
      Calculated field this worksheet field uses.
      Specified by:
      getTableauCalculatedField in interface ITableauWorksheetField
    • getTableauDashboardField

      public ITableauDashboardField getTableauDashboardField()
      Worksheet field used by this dashboard field.
      Specified by:
      getTableauDashboardField in interface ITableauWorksheetField
    • getTableauDatasourceField

      public ITableauDatasourceField getTableauDatasourceField()
      Datasource field this worksheet field uses.
      Specified by:
      getTableauDatasourceField in interface ITableauWorksheetField
    • getTableauFullyQualifiedName

      public String getTableauFullyQualifiedName()
      Name used internally in Tableau to uniquely identify this field.
      Specified by:
      getTableauFullyQualifiedName in interface ITableauWorksheetField
    • getTableauProjectHierarchy

      public List<Map<String,String>> getTableauProjectHierarchy()
      List of top-level projects and their nested child projects.
      Specified by:
      getTableauProjectHierarchy in interface ITableauWorksheetField
    • getTableauProjectQualifiedName

      public String getTableauProjectQualifiedName()
      Unique name of the project in which this worksheet field exists.
      Specified by:
      getTableauProjectQualifiedName in interface ITableauWorksheetField
    • getTableauSiteQualifiedName

      public String getTableauSiteQualifiedName()
      Unique name of the site in which this worksheet field exists.
      Specified by:
      getTableauSiteQualifiedName in interface ITableauWorksheetField
    • getTableauTopLevelProjectQualifiedName

      public String getTableauTopLevelProjectQualifiedName()
      Unique name of the top-level project in which this worksheet field exists.
      Specified by:
      getTableauTopLevelProjectQualifiedName in interface ITableauWorksheetField
    • getTableauWorkbookQualifiedName

      public String getTableauWorkbookQualifiedName()
      Unique name of the workbook in which this worksheet field exists.
      Specified by:
      getTableauWorkbookQualifiedName in interface ITableauWorksheetField
    • getTableauWorksheet

      public ITableauWorksheet getTableauWorksheet()
      Worksheet in which this field exists.
      Specified by:
      getTableauWorksheet in interface ITableauWorksheetField
    • getTableauWorksheetFieldBinSize

      public String getTableauWorksheetFieldBinSize()
      Bin size of this field.
      Specified by:
      getTableauWorksheetFieldBinSize in interface ITableauWorksheetField
    • getTableauWorksheetFieldDataCategory

      public String getTableauWorksheetFieldDataCategory()
      Data category of this field.
      Specified by:
      getTableauWorksheetFieldDataCategory in interface ITableauWorksheetField
    • getTableauWorksheetFieldDataType

      public String getTableauWorksheetFieldDataType()
      Data type of this field.
      Specified by:
      getTableauWorksheetFieldDataType in interface ITableauWorksheetField
    • getTableauWorksheetFieldFormula

      public String getTableauWorksheetFieldFormula()
      Formula for this field.
      Specified by:
      getTableauWorksheetFieldFormula in interface ITableauWorksheetField
    • getTableauWorksheetFieldRole

      public String getTableauWorksheetFieldRole()
      Role of this field, for example: 'dimension', 'measure', or 'unknown'.
      Specified by:
      getTableauWorksheetFieldRole in interface ITableauWorksheetField
    • getTableauWorksheetFieldType

      public String getTableauWorksheetFieldType()
      Type of this worksheet field.
      Specified by:
      getTableauWorksheetFieldType in interface ITableauWorksheetField
    • getTableauWorksheetFieldUpstreamColumns

      public List<Map<String,String>> getTableauWorksheetFieldUpstreamColumns()
      Columns upstream to this field.
      Specified by:
      getTableauWorksheetFieldUpstreamColumns in interface ITableauWorksheetField
    • getTableauWorksheetFieldUpstreamFields

      public List<Map<String,String>> getTableauWorksheetFieldUpstreamFields()
      Fields upstream to this field.
      Specified by:
      getTableauWorksheetFieldUpstreamFields in interface ITableauWorksheetField
    • getTableauWorksheetFieldUpstreamTables

      public List<Map<String,String>> getTableauWorksheetFieldUpstreamTables()
      Tables upstream to this worksheet field.
      Specified by:
      getTableauWorksheetFieldUpstreamTables in interface ITableauWorksheetField
    • getTableauWorksheetQualifiedName

      public String getTableauWorksheetQualifiedName()
      Unique name of the datasource in which this worksheet field exists.
      Specified by:
      getTableauWorksheetQualifiedName in interface ITableauWorksheetField
    • 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 TableauWorksheetFields.
      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 ITableauWorksheetField
      Overrides:
      getTypeName in class Reference