Class SemanticField

All Implemented Interfaces:
IAsset, ICatalog, IReferenceable, ISemantic, ISemanticField, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2") public class SemanticField extends Asset implements ISemanticField, ISemantic, ICatalog, IAsset, IReferenceable
Base class for semantic fields (measures, dimensions, entities) across different sources.
See Also:
  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      @Deprecated public static SemanticField appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a SemanticField, without replacing existing Atlan tags linked to the SemanticField. Note: this operation must make two API calls — one to retrieve the SemanticField'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 SemanticField
      qualifiedName - of the SemanticField
      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 SemanticField
      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 SemanticField.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove an Atlan tag from a SemanticField
      qualifiedName - of the SemanticField
      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 SemanticField
    • _internal

      public static SemanticField.SemanticFieldBuilder<?,?> _internal()
    • toBuilder

      public SemanticField.SemanticFieldBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference
    • getInputToAirflowTasks

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

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

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface ISemantic
      Specified by:
      getInputToSparkJobs in interface ISemanticField
    • getModelImplementedAttributes

      public SortedSet<IModelAttribute> getModelImplementedAttributes()
      Attributes implemented by this asset.
      Specified by:
      getModelImplementedAttributes in interface ICatalog
      Specified by:
      getModelImplementedAttributes in interface ISemantic
      Specified by:
      getModelImplementedAttributes in interface ISemanticField
    • getModelImplementedEntities

      public SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
      Specified by:
      getModelImplementedEntities in interface ICatalog
      Specified by:
      getModelImplementedEntities in interface ISemantic
      Specified by:
      getModelImplementedEntities in interface ISemanticField
    • getOutputFromAirflowTasks

      public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
      Tasks from which this asset is output.
      Specified by:
      getOutputFromAirflowTasks in interface ICatalog
      Specified by:
      getOutputFromAirflowTasks in interface ISemantic
      Specified by:
      getOutputFromAirflowTasks in interface ISemanticField
    • 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 ISemantic
      Specified by:
      getOutputFromProcesses in interface ISemanticField
    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface ISemantic
      Specified by:
      getOutputFromSparkJobs in interface ISemanticField
    • getPartialChildFields

      public SortedSet<IPartialField> getPartialChildFields()
      Partial fields contained in the asset.
      Specified by:
      getPartialChildFields in interface ICatalog
      Specified by:
      getPartialChildFields in interface ISemantic
      Specified by:
      getPartialChildFields in interface ISemanticField
    • getPartialChildObjects

      public SortedSet<IPartialObject> getPartialChildObjects()
      Partial objects contained in the asset.
      Specified by:
      getPartialChildObjects in interface ICatalog
      Specified by:
      getPartialChildObjects in interface ISemantic
      Specified by:
      getPartialChildObjects in interface ISemanticField
    • getSemanticAccessModifier

      public String getSemanticAccessModifier()
      Access level for the semantic field (e.g., public_access/private_access).
      Specified by:
      getSemanticAccessModifier in interface ISemanticField
    • getSemanticDataType

      public String getSemanticDataType()
      Data type of the semantic field.
      Specified by:
      getSemanticDataType in interface ISemanticField
    • getSemanticExpression

      public String getSemanticExpression()
      Column name or SQL expression for the semantic field.
      Specified by:
      getSemanticExpression in interface ISemanticField
    • getSemanticLabels

      public SortedSet<String> getSemanticLabels()
      Labels associated with the semantic field.
      Specified by:
      getSemanticLabels in interface ISemanticField
    • getSemanticSampleValues

      public SortedSet<String> getSemanticSampleValues()
      Sample values for the semantic field.
      Specified by:
      getSemanticSampleValues in interface ISemanticField
    • getSemanticSynonyms

      public SortedSet<String> getSemanticSynonyms()
      Alternative names or terms for the semantic field.
      Specified by:
      getSemanticSynonyms in interface ISemanticField
    • getSemanticType

      public String getSemanticType()
      Detailed type of the semantic field (e.g., type of measure, type of dimension, or type of entity).
      Specified by:
      getSemanticType in interface ISemanticField
    • 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 SemanticFields.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface IReferenceable
      Specified by:
      getTypeName in interface ISemantic
      Specified by:
      getTypeName in interface ISemanticField
      Overrides:
      getTypeName in class Reference