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

Class AtlasClassificationDef

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

  • Constructor Details

    • AtlasClassificationDef

      public AtlasClassificationDef()
      Creates an instance of AtlasClassificationDef class.

  • Method Details

    • getCategory

      public TypeCategory getCategory()
      Get the category property: The enum of type category.
      Returns:
      the category value.

    • setCategory

      public AtlasClassificationDef setCategory(TypeCategory category)
      Set the category property: The enum of type category.
      Parameters:
      category - the category value to set.
      Returns:
      the AtlasClassificationDef object itself.

    • getCreateTime

      public Long getCreateTime()
      Get the createTime property: The created time of the record.
      Returns:
      the createTime value.

    • setCreateTime

      public AtlasClassificationDef setCreateTime(Long createTime)
      Set the createTime property: The created time of the record.
      Parameters:
      createTime - the createTime value to set.
      Returns:
      the AtlasClassificationDef object itself.

    • getCreatedBy

      public String getCreatedBy()
      Get the createdBy property: The user who created the record.
      Returns:
      the createdBy value.

    • setCreatedBy

      public AtlasClassificationDef setCreatedBy(String createdBy)
      Set the createdBy property: The user who created the record.
      Parameters:
      createdBy - the createdBy value to set.
      Returns:
      the AtlasClassificationDef object itself.

    • getDateFormatter

      public DateFormat getDateFormatter()
      Get the dateFormatter property: The date format.
      Returns:
      the dateFormatter value.

    • setDateFormatter

      public AtlasClassificationDef setDateFormatter(DateFormat dateFormatter)
      Set the dateFormatter property: The date format.
      Parameters:
      dateFormatter - the dateFormatter value to set.
      Returns:
      the AtlasClassificationDef object itself.

    • getDescription

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

    • setDescription

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

    • getGuid

      public String getGuid()
      Get the guid property: The GUID of the type definition.
      Returns:
      the guid value.

    • setGuid

      public AtlasClassificationDef setGuid(String guid)
      Set the guid property: The GUID of the type definition.
      Parameters:
      guid - the guid value to set.
      Returns:
      the AtlasClassificationDef object itself.

    • getName

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

    • setName

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

    • getOptions

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

    • setOptions

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

    • getServiceType

      public String getServiceType()
      Get the serviceType property: The service type.
      Returns:
      the serviceType value.

    • setServiceType

      public AtlasClassificationDef setServiceType(String serviceType)
      Set the serviceType property: The service type.
      Parameters:
      serviceType - the serviceType value to set.
      Returns:
      the AtlasClassificationDef object itself.

    • getTypeVersion

      public String getTypeVersion()
      Get the typeVersion property: The version of the type.
      Returns:
      the typeVersion value.

    • setTypeVersion

      public AtlasClassificationDef setTypeVersion(String typeVersion)
      Set the typeVersion property: The version of the type.
      Parameters:
      typeVersion - the typeVersion value to set.
      Returns:
      the AtlasClassificationDef object itself.

    • getUpdateTime

      public Long getUpdateTime()
      Get the updateTime property: The update time of the record.
      Returns:
      the updateTime value.

    • setUpdateTime

      public AtlasClassificationDef setUpdateTime(Long updateTime)
      Set the updateTime property: The update time of the record.
      Parameters:
      updateTime - the updateTime value to set.
      Returns:
      the AtlasClassificationDef object itself.

    • getUpdatedBy

      public String getUpdatedBy()
      Get the updatedBy property: The user who updated the record.
      Returns:
      the updatedBy value.

    • setUpdatedBy

      public AtlasClassificationDef setUpdatedBy(String updatedBy)
      Set the updatedBy property: The user who updated the record.
      Parameters:
      updatedBy - the updatedBy value to set.
      Returns:
      the AtlasClassificationDef object itself.

    • getVersion

      public Long getVersion()
      Get the version property: The version of the record.
      Returns:
      the version value.

    • setVersion

      public AtlasClassificationDef setVersion(Long version)
      Set the version property: The version of the record.
      Parameters:
      version - the version value to set.
      Returns:
      the AtlasClassificationDef object itself.

    • getLastModifiedTS

      public String getLastModifiedTS()
      Get the lastModifiedTS property: ETag for concurrency control.
      Returns:
      the lastModifiedTS value.

    • setLastModifiedTS

      public AtlasClassificationDef setLastModifiedTS(String lastModifiedTS)
      Set the lastModifiedTS property: ETag for concurrency control.
      Parameters:
      lastModifiedTS - the lastModifiedTS value to set.
      Returns:
      the AtlasClassificationDef object itself.

    • getAttributeDefs

      public List<AtlasAttributeDef> getAttributeDefs()
      Get the attributeDefs property: An array of attribute definitions.
      Returns:
      the attributeDefs value.

    • setAttributeDefs

      public AtlasClassificationDef setAttributeDefs(List<AtlasAttributeDef> attributeDefs)
      Set the attributeDefs property: An array of attribute definitions.
      Parameters:
      attributeDefs - the attributeDefs value to set.
      Returns:
      the AtlasClassificationDef object itself.

    • getEntityTypes

      public List<String> getEntityTypes()
      Get the entityTypes property: Specifying a list of entityType names in the classificationDef, ensures that classifications can only be applied to those entityTypes. Any subtypes of the entity types inherit the restriction. Any classificationDef subtypes inherit the parents entityTypes restrictions. Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes. An empty entityTypes list when there are no parent restrictions means there are no restrictions. An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions. If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs.
      Returns:
      the entityTypes value.

    • setEntityTypes

      public AtlasClassificationDef setEntityTypes(List<String> entityTypes)
      Set the entityTypes property: Specifying a list of entityType names in the classificationDef, ensures that classifications can only be applied to those entityTypes. Any subtypes of the entity types inherit the restriction. Any classificationDef subtypes inherit the parents entityTypes restrictions. Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes. An empty entityTypes list when there are no parent restrictions means there are no restrictions. An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions. If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs.
      Parameters:
      entityTypes - the entityTypes value to set.
      Returns:
      the AtlasClassificationDef object itself.

    • getSubTypes

      public List<String> getSubTypes()
      Get the subTypes property: An array of sub types.
      Returns:
      the subTypes value.

    • setSubTypes

      public AtlasClassificationDef setSubTypes(List<String> subTypes)
      Set the subTypes property: An array of sub types.
      Parameters:
      subTypes - the subTypes value to set.
      Returns:
      the AtlasClassificationDef object itself.

    • getSuperTypes

      public List<String> getSuperTypes()
      Get the superTypes property: An array of super types.
      Returns:
      the superTypes value.

    • setSuperTypes

      public AtlasClassificationDef setSuperTypes(List<String> superTypes)
      Set the superTypes property: An array of super types.
      Parameters:
      superTypes - the superTypes value to set.
      Returns:
      the AtlasClassificationDef 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<AtlasClassificationDef>
      Throws:
      IOException

    • fromJson

      public static AtlasClassificationDef fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AtlasClassificationDef from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AtlasClassificationDef 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 AtlasClassificationDef.