Package com.atlan.model.typedefs

Class AttributeDefOptions.AttributeDefOptionsBuilder<C extends AttributeDefOptions,B extends AttributeDefOptions.AttributeDefOptionsBuilder<C,B>>

java.lang.Object
com.atlan.model.core.AtlanObject.AtlanObjectBuilder<C,B>
com.atlan.model.typedefs.AttributeDefOptions.AttributeDefOptionsBuilder<C,B>
Enclosing class:
AttributeDefOptions
public abstract static class AttributeDefOptions.AttributeDefOptionsBuilder<C extends AttributeDefOptions,B extends AttributeDefOptions.AttributeDefOptionsBuilder<C,B>> extends AtlanObject.AtlanObjectBuilder<C,B>

  • Constructor Details

    • AttributeDefOptionsBuilder

      public AttributeDefOptionsBuilder()

  • Method Details

    • $fillValuesFrom

      protected B $fillValuesFrom(C instance)
      Overrides:
      $fillValuesFrom in class AtlanObject.AtlanObjectBuilder<C extends AttributeDefOptions,B extends AttributeDefOptions.AttributeDefOptionsBuilder<C,B>>

    • customMetadataVersion

      public B customMetadataVersion(String customMetadataVersion)
      Indicates the version of the custom metadata structure. This determines which other options are available and used.
      Returns:
      this.

    • description

      public B description(String description)
      Optional description of the attribute.
      Returns:
      this.

    • applicableEntityTypes

      public B applicableEntityTypes(Set<String> applicableEntityTypes)
      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.
      Returns:
      this.

    • customApplicableEntityTypes

      @Deprecated public B customApplicableEntityTypes(Set<String> customApplicableEntityTypes)
      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.
      Returns:
      this.

    • applicableConnection

      public B applicableConnection(String applicableConnection)

    • applicableConnections

      public B applicableConnections(Collection<? extends String> applicableConnections)

    • clearApplicableConnections

      public B clearApplicableConnections()

    • applicableGlossary

      public B applicableGlossary(String applicableGlossary)

    • applicableGlossaries

      public B applicableGlossaries(Collection<? extends String> applicableGlossaries)

    • clearApplicableGlossaries

      public B clearApplicableGlossaries()

    • applicableDomain

      public B applicableDomain(String applicableDomain)

    • applicableDomains

      public B applicableDomains(Collection<? extends String> applicableDomains)

    • clearApplicableDomains

      public B clearApplicableDomains()

    • applicableAssetType

      public B applicableAssetType(String applicableAssetType)

    • applicableAssetTypes

      public B applicableAssetTypes(Collection<? extends String> applicableAssetTypes)

    • clearApplicableAssetTypes

      public B clearApplicableAssetTypes()

    • applicableGlossaryType

      public B applicableGlossaryType(String applicableGlossaryType)

    • applicableGlossaryTypes

      public B applicableGlossaryTypes(Collection<? extends String> applicableGlossaryTypes)

    • clearApplicableGlossaryTypes

      public B clearApplicableGlossaryTypes()

    • applicableDomainType

      public B applicableDomainType(String applicableDomainType)

    • applicableDomainTypes

      public B applicableDomainTypes(Collection<? extends String> applicableDomainTypes)

    • clearApplicableDomainTypes

      public B clearApplicableDomainTypes()

    • applicableOtherAssetType

      public B applicableOtherAssetType(String applicableOtherAssetType)

    • applicableOtherAssetTypes

      public B applicableOtherAssetTypes(Collection<? extends String> applicableOtherAssetTypes)

    • clearApplicableOtherAssetTypes

      public B clearApplicableOtherAssetTypes()

    • allowSearch

      public B allowSearch(Boolean allowSearch)
      Whether the attribute should be searchable (true) or not (false).
      Returns:
      this.

    • maxStrLength

      public B maxStrLength(String maxStrLength)
      Maximum length allowed for a string value.
      Returns:
      this.

    • allowFiltering

      public B allowFiltering(Boolean allowFiltering)
      Whether this attribute should appear in the filterable facets of discovery (true) or not (false).
      Returns:
      this.

    • multiValueSelect

      public B multiValueSelect(Boolean multiValueSelect)
      Whether this attribute can have multiple values (true) or only a single value (false).
      Returns:
      this.

    • showInOverview

      public B showInOverview(Boolean showInOverview)
      Whether users will see this attribute in the overview tab of the sidebar (true) or not (false).
      Returns:
      this.

    • isDeprecated

      public B isDeprecated(String isDeprecated)
      Whether the attribute is deprecated ("true") or not (null or "false").
      Returns:
      this.

    • primitiveType

      public B primitiveType(AtlanCustomAttributePrimitiveType primitiveType)
      Primitive type of the attribute.
      Returns:
      this.

    • isEnum

      public B isEnum(Boolean isEnum)
      Whether the attribute is an enumeration (true) or not (false).
      Returns:
      this.

    • enumType

      public B enumType(String enumType)
      Name of the enumeration (options), when the attribute is an enumeration.
      Returns:
      this.

    • customType

      public B customType(String customType)
      Used for Atlan-specific types like users, groups, url, and SQL.
      Returns:
      this.

    • hasTimePrecision

      public B hasTimePrecision(Boolean hasTimePrecision)
      If true for a date attribute, then time-level precision is also available in the UI (otherwise only date-level)
      Returns:
      this.

    • isArchived

      public B isArchived(Boolean isArchived)
      Whether the attribute has been deleted (true) or is still active (false).
      Returns:
      this.

    • archivedAt

      public B archivedAt(Long archivedAt)
      When the attribute was deleted.
      Returns:
      this.

    • archivedBy

      public B archivedBy(String archivedBy)
      User who deleted the attribute.
      Returns:
      this.

    • isSoftReference

      public B isSoftReference(String isSoftReference)
      TBC
      Returns:
      this.

    • isAppendOnPartialUpdate

      public B isAppendOnPartialUpdate(String isAppendOnPartialUpdate)
      TBC
      Returns:
      this.

    • self

      protected abstract B self()
      Specified by:
      self in class AtlanObject.AtlanObjectBuilder<C extends AttributeDefOptions,B extends AttributeDefOptions.AttributeDefOptionsBuilder<C,B>>

    • build

      public abstract C build()
      Specified by:
      build in class AtlanObject.AtlanObjectBuilder<C extends AttributeDefOptions,B extends AttributeDefOptions.AttributeDefOptionsBuilder<C,B>>

    • toString

      public String toString()
      Overrides:
      toString in class AtlanObject.AtlanObjectBuilder<C extends AttributeDefOptions,B extends AttributeDefOptions.AttributeDefOptionsBuilder<C,B>>