Package com.azure.analytics.purview.datamap.models

Class AtlasAttributeDef

java.lang.Object
com.azure.analytics.purview.datamap.models.AtlasAttributeDef
All Implemented Interfaces:
com.azure.json.JsonSerializable<AtlasAttributeDef>
public final class AtlasAttributeDef extends Object implements com.azure.json.JsonSerializable<AtlasAttributeDef>
class that captures details of a struct-attribute.

  • Constructor Details

    • AtlasAttributeDef

      public AtlasAttributeDef()
      Creates an instance of AtlasAttributeDef class.

  • Method Details

    • getCardinality

      public CardinalityValue getCardinality()
      Get the cardinality property: single-valued attribute or multi-valued attribute.
      Returns:
      the cardinality value.

    • setCardinality

      public AtlasAttributeDef setCardinality(CardinalityValue cardinality)
      Set the cardinality property: single-valued attribute or multi-valued attribute.
      Parameters:
      cardinality - the cardinality value to set.
      Returns:
      the AtlasAttributeDef object itself.

    • getConstraints

      public List<AtlasConstraintDef> getConstraints()
      Get the constraints property: An array of constraints.
      Returns:
      the constraints value.

    • setConstraints

      public AtlasAttributeDef setConstraints(List<AtlasConstraintDef> constraints)
      Set the constraints property: An array of constraints.
      Parameters:
      constraints - the constraints value to set.
      Returns:
      the AtlasAttributeDef object itself.

    • getDefaultValue

      public String getDefaultValue()
      Get the defaultValue property: The default value of the attribute.
      Returns:
      the defaultValue value.

    • setDefaultValue

      public AtlasAttributeDef setDefaultValue(String defaultValue)
      Set the defaultValue property: The default value of the attribute.
      Parameters:
      defaultValue - the defaultValue value to set.
      Returns:
      the AtlasAttributeDef object itself.

    • getDescription

      public String getDescription()
      Get the description property: The description of the attribute.
      Returns:
      the description value.

    • setDescription

      public AtlasAttributeDef setDescription(String description)
      Set the description property: The description of the attribute.
      Parameters:
      description - the description value to set.
      Returns:
      the AtlasAttributeDef object itself.

    • isIncludeInNotification

      public Boolean isIncludeInNotification()
      Get the includeInNotification property: Determines if it is included in notification.
      Returns:
      the includeInNotification value.

    • setIncludeInNotification

      public AtlasAttributeDef setIncludeInNotification(Boolean includeInNotification)
      Set the includeInNotification property: Determines if it is included in notification.
      Parameters:
      includeInNotification - the includeInNotification value to set.
      Returns:
      the AtlasAttributeDef object itself.

    • isIndexable

      public Boolean isIndexable()
      Get the isIndexable property: Determines if it is indexable.
      Returns:
      the isIndexable value.

    • setIsIndexable

      public AtlasAttributeDef setIsIndexable(Boolean isIndexable)
      Set the isIndexable property: Determines if it is indexable.
      Parameters:
      isIndexable - the isIndexable value to set.
      Returns:
      the AtlasAttributeDef object itself.

    • isOptional

      public Boolean isOptional()
      Get the isOptional property: Determines if it is optional.
      Returns:
      the isOptional value.

    • setIsOptional

      public AtlasAttributeDef setIsOptional(Boolean isOptional)
      Set the isOptional property: Determines if it is optional.
      Parameters:
      isOptional - the isOptional value to set.
      Returns:
      the AtlasAttributeDef object itself.

    • isUnique

      public Boolean isUnique()
      Get the isUnique property: Determines if it unique.
      Returns:
      the isUnique value.

    • setIsUnique

      public AtlasAttributeDef setIsUnique(Boolean isUnique)
      Set the isUnique property: Determines if it unique.
      Parameters:
      isUnique - the isUnique value to set.
      Returns:
      the AtlasAttributeDef object itself.

    • getName

      public String getName()
      Get the name property: The name of the attribute.
      Returns:
      the name value.

    • setName

      public AtlasAttributeDef setName(String name)
      Set the name property: The name of the attribute.
      Parameters:
      name - the name value to set.
      Returns:
      the AtlasAttributeDef object itself.

    • getOptions

      public Map<String,String> getOptions()
      Get the options property: The options for the attribute.
      Returns:
      the options value.

    • setOptions

      public AtlasAttributeDef setOptions(Map<String,String> options)
      Set the options property: The options for the attribute.
      Parameters:
      options - the options value to set.
      Returns:
      the AtlasAttributeDef object itself.

    • getTypeName

      public String getTypeName()
      Get the typeName property: The name of the type.
      Returns:
      the typeName value.

    • setTypeName

      public AtlasAttributeDef setTypeName(String typeName)
      Set the typeName property: The name of the type.
      Parameters:
      typeName - the typeName value to set.
      Returns:
      the AtlasAttributeDef object itself.

    • getValuesMaxCount

      public Integer getValuesMaxCount()
      Get the valuesMaxCount property: The maximum count of the values.
      Returns:
      the valuesMaxCount value.

    • setValuesMaxCount

      public AtlasAttributeDef setValuesMaxCount(Integer valuesMaxCount)
      Set the valuesMaxCount property: The maximum count of the values.
      Parameters:
      valuesMaxCount - the valuesMaxCount value to set.
      Returns:
      the AtlasAttributeDef object itself.

    • getValuesMinCount

      public Integer getValuesMinCount()
      Get the valuesMinCount property: The minimum count of the values.
      Returns:
      the valuesMinCount value.

    • setValuesMinCount

      public AtlasAttributeDef setValuesMinCount(Integer valuesMinCount)
      Set the valuesMinCount property: The minimum count of the values.
      Parameters:
      valuesMinCount - the valuesMinCount value to set.
      Returns:
      the AtlasAttributeDef object itself.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<AtlasAttributeDef>
      Throws:
      IOException

    • fromJson

      public static AtlasAttributeDef fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AtlasAttributeDef from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AtlasAttributeDef if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the AtlasAttributeDef.