Class AtlasEntity

java.lang.Object
com.azure.analytics.purview.datamap.models.AtlasEntity
All Implemented Interfaces:
com.azure.json.JsonSerializable<AtlasEntity>

public final class AtlasEntity extends Object implements com.azure.json.JsonSerializable<AtlasEntity>
An instance of an entity - like hive_table, hive_database.
  • Constructor Details

    • AtlasEntity

      public AtlasEntity()
      Creates an instance of AtlasEntity class.
  • Method Details

    • getAttributes

      public Map<String,com.azure.core.util.BinaryData> getAttributes()
      Get the attributes property: The attributes of the struct.
      Returns:
      the attributes value.
    • setAttributes

      public AtlasEntity setAttributes(Map<String,com.azure.core.util.BinaryData> attributes)
      Set the attributes property: The attributes of the struct.
      Parameters:
      attributes - the attributes value to set.
      Returns:
      the AtlasEntity object itself.
    • getTypeName

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

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

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

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

      public Map<String,com.azure.core.util.BinaryData> getBusinessAttributes()
      Get the businessAttributes property: Business attributes.
      Returns:
      the businessAttributes value.
    • setBusinessAttributes

      public AtlasEntity setBusinessAttributes(Map<String,com.azure.core.util.BinaryData> businessAttributes)
      Set the businessAttributes property: Business attributes.
      Parameters:
      businessAttributes - the businessAttributes value to set.
      Returns:
      the AtlasEntity object itself.
    • getClassifications

      public List<AtlasClassification> getClassifications()
      Get the classifications property: An array of classifications.
      Returns:
      the classifications value.
    • setClassifications

      public AtlasEntity setClassifications(List<AtlasClassification> classifications)
      Set the classifications property: An array of classifications.
      Parameters:
      classifications - the classifications value to set.
      Returns:
      the AtlasEntity object itself.
    • getCreateTime

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

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

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

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

      public Map<String,String> getCustomAttributes()
      Get the customAttributes property: Custom Attribute.
      Returns:
      the customAttributes value.
    • setCustomAttributes

      public AtlasEntity setCustomAttributes(Map<String,String> customAttributes)
      Set the customAttributes property: Custom Attribute.
      Parameters:
      customAttributes - the customAttributes value to set.
      Returns:
      the AtlasEntity object itself.
    • getGuid

      public String getGuid()
      Get the guid property: The GUID of the entity.
      Returns:
      the guid value.
    • setGuid

      public AtlasEntity setGuid(String guid)
      Set the guid property: The GUID of the entity.
      Parameters:
      guid - the guid value to set.
      Returns:
      the AtlasEntity object itself.
    • getHomeId

      public String getHomeId()
      Get the homeId property: The home ID of the entity.
      Returns:
      the homeId value.
    • setHomeId

      public AtlasEntity setHomeId(String homeId)
      Set the homeId property: The home ID of the entity.
      Parameters:
      homeId - the homeId value to set.
      Returns:
      the AtlasEntity object itself.
    • getCollectionId

      public String getCollectionId()
      Get the collectionId property: The collection ID of the entity.
      Returns:
      the collectionId value.
    • isIncomplete

      public Boolean isIncomplete()
      Get the isIncomplete property: Whether it is a shell entity.
      Returns:
      the isIncomplete value.
    • setIsIncomplete

      public AtlasEntity setIsIncomplete(Boolean isIncomplete)
      Set the isIncomplete property: Whether it is a shell entity.
      Parameters:
      isIncomplete - the isIncomplete value to set.
      Returns:
      the AtlasEntity object itself.
    • getLabels

      public List<String> getLabels()
      Get the labels property: labels.
      Returns:
      the labels value.
    • setLabels

      public AtlasEntity setLabels(List<String> labels)
      Set the labels property: labels.
      Parameters:
      labels - the labels value to set.
      Returns:
      the AtlasEntity object itself.
    • getMeanings

      public List<AtlasTermAssignmentHeader> getMeanings()
      Get the meanings property: An array of term assignment headers indicating the meanings of the entity.
      Returns:
      the meanings value.
    • setMeanings

      public AtlasEntity setMeanings(List<AtlasTermAssignmentHeader> meanings)
      Set the meanings property: An array of term assignment headers indicating the meanings of the entity.
      Parameters:
      meanings - the meanings value to set.
      Returns:
      the AtlasEntity object itself.
    • getProvenanceType

      public Integer getProvenanceType()
      Get the provenanceType property: Used to record the provenance of an instance of an entity or relationship.
      Returns:
      the provenanceType value.
    • setProvenanceType

      public AtlasEntity setProvenanceType(Integer provenanceType)
      Set the provenanceType property: Used to record the provenance of an instance of an entity or relationship.
      Parameters:
      provenanceType - the provenanceType value to set.
      Returns:
      the AtlasEntity object itself.
    • isProxy

      public Boolean isProxy()
      Get the proxy property: Determines if there's a proxy.
      Returns:
      the proxy value.
    • setProxy

      public AtlasEntity setProxy(Boolean proxy)
      Set the proxy property: Determines if there's a proxy.
      Parameters:
      proxy - the proxy value to set.
      Returns:
      the AtlasEntity object itself.
    • getRelationshipAttributes

      public Map<String,com.azure.core.util.BinaryData> getRelationshipAttributes()
      Get the relationshipAttributes property: The attributes of relationship.
      Returns:
      the relationshipAttributes value.
    • setRelationshipAttributes

      public AtlasEntity setRelationshipAttributes(Map<String,com.azure.core.util.BinaryData> relationshipAttributes)
      Set the relationshipAttributes property: The attributes of relationship.
      Parameters:
      relationshipAttributes - the relationshipAttributes value to set.
      Returns:
      the AtlasEntity object itself.
    • getStatus

      public EntityStatus getStatus()
      Get the status property: Status of the entity - can be active or deleted. Deleted entities are not removed.
      Returns:
      the status value.
    • setStatus

      public AtlasEntity setStatus(EntityStatus status)
      Set the status property: Status of the entity - can be active or deleted. Deleted entities are not removed.
      Parameters:
      status - the status value to set.
      Returns:
      the AtlasEntity object itself.
    • getUpdateTime

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

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

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

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

      public Long getVersion()
      Get the version property: The version of the entity.
      Returns:
      the version value.
    • setVersion

      public AtlasEntity setVersion(Long version)
      Set the version property: The version of the entity.
      Parameters:
      version - the version value to set.
      Returns:
      the AtlasEntity object itself.
    • getContacts

      public Map<String,List<ContactInfo>> getContacts()
      Get the contacts property: The dictionary of contacts for entities. Key could be Expert or Owner.
      Returns:
      the contacts value.
    • setContacts

      public AtlasEntity setContacts(Map<String,List<ContactInfo>> contacts)
      Set the contacts property: The dictionary of contacts for entities. Key could be Expert or Owner.
      Parameters:
      contacts - the contacts value to set.
      Returns:
      the AtlasEntity 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<AtlasEntity>
      Throws:
      IOException
    • fromJson

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