Package com.atlan.model.typedefs
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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
AttributeDefOptions.AttributeDefOptionsBuilder<C extends AttributeDefOptions,
B extends AttributeDefOptions.AttributeDefOptionsBuilder<C, B>> Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject
AtlanObject.AtlanObjectBuilder<C extends AtlanObject,
B extends AtlanObject.AtlanObjectBuilder<C, B>> -
Field Summary
Modifier and TypeFieldDescriptionFields inherited from class com.atlan.model.core.AtlanObject
rawJsonObject
-
Constructor Summary
ModifierConstructorDescriptionprotected
-
Method Summary
Modifier and TypeMethodDescriptionappend
(AttributeDefOptions options) Append the provided set of attribute definition options onto this attribute definition.static AttributeDefOptions.AttributeDefOptionsBuilder<?,
?> builder()
protected boolean
boolean
Whether this attribute should appear in the filterable facets of discovery (true) or not (false).Whether the attribute should be searchable (true) or not (false).Asset type names to which to restrict the attribute.Qualified names of connections to which to restrict the attribute.Qualified names of domains to which to restrict the attribute.Data product type names to which to restrict the attribute.Set of entities on which this attribute can be applied.Qualified names of glossaries to which to restrict the attribute.Glossary type names to which to restrict the attribute.Any other asset type names to which to restrict the attribute.When the attribute was deleted.User who deleted the attribute.Deprecated.Indicates the version of the custom metadata structure.Used for Atlan-specific types likeusers
,groups
,url
, andSQL
.Optional description of the attribute.Name of the enumeration (options), when the attribute is an enumeration.If true for a date attribute, then time-level precision is also available in the UI (otherwise only date-level)TBCWhether the attribute has been deleted (true) or is still active (false).Whether the attribute is deprecated ("true") or not (null or "false").Whether the attribute is an enumeration (true) or not (false).TBCMaximum length allowed for a string value.Whether this attribute can have multiple values (true) or only a single value (false).Primitive type of the attribute.Whether users will see this attribute in the overview tab of the sidebar (true) or not (false).int
hashCode()
static AttributeDefOptions
of
(AtlanCustomAttributePrimitiveType type, String optionsName) Instantiate a new set of attribute options from the provided parameters.static AttributeDefOptions
of
(AtlanCustomAttributePrimitiveType type, String optionsName, AttributeDefOptions options) Instantiate a new set of attribute options from the provided parameters.toString()
Methods inherited from class com.atlan.model.core.AtlanObject
getRawJsonObject, setRawJsonObject, toJson
-
Field Details
-
ALL_ASSET_TYPES
-
ALL_GLOSSARY_TYPES
-
ALL_DOMAIN_TYPES
-
ALL_OTHER_TYPES
-
ALL_DOMAINS
-
-
Constructor Details
-
AttributeDefOptions
-
-
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 attributeoptionsName
- 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 attributeoptionsName
- 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
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 setupof(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
-
toBuilder
-
getCustomMetadataVersion
Indicates the version of the custom metadata structure. This determines which other options are available and used. -
getDescription
Optional description of the attribute. -
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 ofapplicableAssetTypes
,applicableGlossaryTypes
, orapplicableOtherAssetTypes
. -
getCustomApplicableEntityTypes
Deprecated.seeapplicableAssetTypes
,applicableGlossaryTypes
,applicableOtherAssetTypes
insteadSet of entities on which this attribute should appear. Note: this is only used when customMetadataVersion is less than v2. -
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, seeapplicableAssetTypes
. -
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, seeapplicableGlossaryTypes
. -
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, seeapplicableDomainTypes
. -
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, seeapplicableConnections
. -
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, seeapplicableGlossaries
. -
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
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
Whether the attribute should be searchable (true) or not (false). -
getMaxStrLength
Maximum length allowed for a string value. -
getAllowFiltering
Whether this attribute should appear in the filterable facets of discovery (true) or not (false). -
getMultiValueSelect
Whether this attribute can have multiple values (true) or only a single value (false). -
getShowInOverview
Whether users will see this attribute in the overview tab of the sidebar (true) or not (false). -
getIsDeprecated
Whether the attribute is deprecated ("true") or not (null or "false"). -
getPrimitiveType
Primitive type of the attribute. -
getIsEnum
Whether the attribute is an enumeration (true) or not (false). -
getEnumType
Name of the enumeration (options), when the attribute is an enumeration. -
getCustomType
Used for Atlan-specific types likeusers
,groups
,url
, andSQL
. -
getHasTimePrecision
If true for a date attribute, then time-level precision is also available in the UI (otherwise only date-level) -
getIsArchived
Whether the attribute has been deleted (true) or is still active (false). -
getArchivedAt
When the attribute was deleted. -
getArchivedBy
User who deleted the attribute. -
getIsSoftReference
TBC -
getIsAppendOnPartialUpdate
TBC -
equals
- Overrides:
equals
in classAtlanObject
-
canEqual
- Overrides:
canEqual
in classAtlanObject
-
hashCode
public int hashCode()- Overrides:
hashCode
in classAtlanObject
-
toString
Description copied from class:AtlanObject
- Overrides:
toString
in classAtlanObject
-
applicableAssetTypes
,applicableGlossaryTypes
,applicableOtherAssetTypes
instead