AtlasEntityDef Data Type

class that captures details of a entity-type.

Properties
name data type description
businessAttributeDefs map of array of AtlasAttributeDef
relationshipAttributeDefs array of AtlasRelationshipAttributeDef
subTypes array of string
superTypes array of string
Properties inherited from AtlasStructDef
attributeDefs array of AtlasAttributeDef
Properties inherited from AtlasBaseTypeDef
category TypeCategory
createTime number
createdBy string
dateFormatter DateFormat
description string
guid string
name string
options map of string
serviceType string
typeVersion string
updateTime number
updatedBy string
version number

Example

{
  "businessAttributeDefs" : {
    "property1" : [ {
      "cardinality" : "LIST",
      "constraints" : [ {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      }, {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      }, {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "property2" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      }, {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      }, {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ]
  },
  "relationshipAttributeDefs" : [ {
    "isLegacyAttribute" : true,
    "relationshipTypeName" : "...",
    "cardinality" : "SET",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "STRING",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  }, {
    "isLegacyAttribute" : true,
    "relationshipTypeName" : "...",
    "cardinality" : "SET",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "STRING",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  } ],
  "subTypes" : [ "...", "..." ],
  "superTypes" : [ "...", "..." ],
  "attributeDefs" : [ {
    "cardinality" : "LIST",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "DEFAULT",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  }, {
    "cardinality" : "SET",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "STRING",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  } ],
  "category" : "RELATIONSHIP",
  "createTime" : 12345,
  "createdBy" : "...",
  "dateFormatter" : {
    "availableLocales" : [ "...", "..." ],
    "calendar" : 12345,
    "dateInstance" : { },
    "dateTimeInstance" : { },
    "instance" : { },
    "lenient" : true,
    "numberFormat" : {
      "availableLocales" : [ "...", "..." ],
      "currency" : "...",
      "currencyInstance" : { },
      "groupingUsed" : true,
      "instance" : { },
      "integerInstance" : { },
      "maximumFractionDigits" : 12345,
      "maximumIntegerDigits" : 12345,
      "minimumFractionDigits" : 12345,
      "minimumIntegerDigits" : 12345,
      "numberInstance" : { },
      "parseIntegerOnly" : true,
      "percentInstance" : { },
      "roundingMode" : "HALF_UP"
    },
    "timeInstance" : { },
    "timeZone" : {
      "DSTSavings" : 12345,
      "ID" : "...",
      "availableIDs" : [ "...", "..." ],
      "default" : { },
      "displayName" : "...",
      "rawOffset" : 12345
    }
  },
  "description" : "...",
  "guid" : "...",
  "name" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "serviceType" : "...",
  "typeVersion" : "...",
  "updateTime" : 12345,
  "updatedBy" : "...",
  "version" : 12345
}