Class AttributeDefOptions

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.typedefs.AttributeDefOptions
All Implemented Interfaces:
Serializable

@Generated("com.atlan.generators.ModelGeneratorV2") public class AttributeDefOptions extends AtlanObject
Options that can be set on each attribute within a type definition.
See Also:
  • Field Details

    • ALL_ASSET_TYPES

      public static final Set<String> ALL_ASSET_TYPES
    • ALL_GLOSSARY_TYPES

      public static final Set<String> ALL_GLOSSARY_TYPES
    • ALL_DOMAIN_TYPES

      public static final Set<String> ALL_DOMAIN_TYPES
    • ALL_OTHER_TYPES

      public static final Set<String> ALL_OTHER_TYPES
    • ALL_DOMAINS

      public static final Set<String> ALL_DOMAINS
  • Constructor Details

  • Method Details

    • of

      public static AttributeDefOptions of(AtlanCustomAttributePrimitiveType type, String optionsName) throws AtlanException
      Instantiate a new set of attribute options from the provided parameters.
      Parameters:
      type - primitive type of the attribute
      optionsName - name of the options (enumeration) if the primitive type is an enumeration (can be null otherwise)
      Returns:
      the attribute options
      Throws:
      AtlanException - on any API issues looking up existing connections and glossaries
    • of

      public static AttributeDefOptions of(AtlanCustomAttributePrimitiveType type, String optionsName, AttributeDefOptions options) throws AtlanException
      Instantiate a new set of attribute options from the provided parameters.
      Parameters:
      type - primitive type of the attribute
      optionsName - name of the options (enumeration) if the primitive type is an enumeration (can be null otherwise)
      options - starting point of options on which to extend
      Returns:
      the attribute options
      Throws:
      AtlanException - on any API issues looking up existing connections and glossaries
    • append

      public AttributeDefOptions append(AttributeDefOptions options)
      Append the provided set of attribute definition options onto this attribute definition. Note that certain options are ignored by the append, specifically: primitiveType, isEnum, enumType, customType, multiValueSelect, isArchived, archivedAt, archivedBy. These should only be set by the appropriate initial setup of(AtlanCustomAttributePrimitiveType, String) or archival of an attribute definition.
      Parameters:
      options - to append to this set of attribute definition options
      Returns:
      the combined set of attribute definition options
    • builder

      public static AttributeDefOptions.AttributeDefOptionsBuilder<?,?> builder()
    • toBuilder

    • getCustomMetadataVersion

      public String getCustomMetadataVersion()
      Indicates the version of the custom metadata structure. This determines which other options are available and used.
    • getDescription

      public String getDescription()
      Optional description of the attribute.
    • getApplicableEntityTypes

      public Set<String> getApplicableEntityTypes()
      Set of entities on which this attribute can be applied. Note: generally this should be left as-is. Any overrides should instead be applied through one or more of applicableAssetTypes, applicableGlossaryTypes, or applicableOtherAssetTypes.
    • getCustomApplicableEntityTypes

      @Deprecated public Set<String> getCustomApplicableEntityTypes()
      Deprecated.
      see applicableAssetTypes, applicableGlossaryTypes, applicableOtherAssetTypes instead
      Set of entities on which this attribute should appear. Note: this is only used when customMetadataVersion is less than v2.
    • getApplicableConnections

      public Set<String> getApplicableConnections()
      Qualified names of connections to which to restrict the attribute. Only assets within one of these connections will have this attribute available. To further restrict the types of assets within the connections, see applicableAssetTypes.
    • getApplicableGlossaries

      public Set<String> getApplicableGlossaries()
      Qualified names of glossaries to which to restrict the attribute. Only glossary assets within one of these glossaries will have this attribute available. To further restrict the types of assets within the glossaries, see applicableGlossaryTypes.
    • getApplicableDomains

      public Set<String> getApplicableDomains()
      Qualified names of domains to which to restrict the attribute. Only domains and data products within one of these domains will have this attribute available. To further restrict the types of assets within the domains, see applicableDomainTypes.
    • getApplicableAssetTypes

      public Set<String> getApplicableAssetTypes()
      Asset type names to which to restrict the attribute. Only assets of one of these types will have this attribute available. To further restrict the assets for this custom metadata by connection, see applicableConnections.
    • getApplicableGlossaryTypes

      public Set<String> getApplicableGlossaryTypes()
      Glossary type names to which to restrict the attribute. Only glossary assets of one of these types will have this attribute available. To further restrict the glossary content for this custom metadata by glossary, see applicableGlossaries.
    • getApplicableDomainTypes

      public Set<String> getApplicableDomainTypes()
      Data product type names to which to restrict the attribute. These cover asset types in data products and data domains. Only assets of one of these types will have this attribute available.
    • getApplicableOtherAssetTypes

      public Set<String> getApplicableOtherAssetTypes()
      Any other asset type names to which to restrict the attribute. These cover any asset type that is not managed within a connection or a glossary. Only assets of one of these types will have this attribute available.
    • getAllowSearch

      public Boolean getAllowSearch()
      Whether the attribute should be searchable (true) or not (false).
    • getMaxStrLength

      public String getMaxStrLength()
      Maximum length allowed for a string value.
    • getAllowFiltering

      public Boolean getAllowFiltering()
      Whether this attribute should appear in the filterable facets of discovery (true) or not (false).
    • getMultiValueSelect

      public Boolean getMultiValueSelect()
      Whether this attribute can have multiple values (true) or only a single value (false).
    • getShowInOverview

      public Boolean getShowInOverview()
      Whether users will see this attribute in the overview tab of the sidebar (true) or not (false).
    • getIsDeprecated

      public String getIsDeprecated()
      Whether the attribute is deprecated ("true") or not (null or "false").
    • getPrimitiveType

      public AtlanCustomAttributePrimitiveType getPrimitiveType()
      Primitive type of the attribute.
    • getIsEnum

      public Boolean getIsEnum()
      Whether the attribute is an enumeration (true) or not (false).
    • getEnumType

      public String getEnumType()
      Name of the enumeration (options), when the attribute is an enumeration.
    • getCustomType

      public String getCustomType()
      Used for Atlan-specific types like users, groups, url, and SQL.
    • getHasTimePrecision

      public Boolean getHasTimePrecision()
      If true for a date attribute, then time-level precision is also available in the UI (otherwise only date-level)
    • getIsArchived

      public Boolean getIsArchived()
      Whether the attribute has been deleted (true) or is still active (false).
    • getArchivedAt

      public Long getArchivedAt()
      When the attribute was deleted.
    • getArchivedBy

      public String getArchivedBy()
      User who deleted the attribute.
    • getIsSoftReference

      public String getIsSoftReference()
      TBC
    • getIsAppendOnPartialUpdate

      public String getIsAppendOnPartialUpdate()
      TBC
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class AtlanObject
    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class AtlanObject
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class AtlanObject
    • toString

      public String toString()
      Description copied from class: AtlanObject
      Overrides:
      toString in class AtlanObject