AtlasRelationshipAttributeDef Data Type

class that captures details of a struct-attribute.

Properties
name data type constraints description
isLegacyAttribute boolean required
relationshipTypeName string  
Properties inherited from AtlasAttributeDef
cardinality Cardinality  
constraints array of AtlasConstraintDef  
defaultValue string  
description string  
displayName string  
includeInNotification boolean required
indexType IndexType  
isIndexable boolean required
isOptional boolean required
isUnique boolean required
name string  
options map of string  
searchWeight number required
typeName string  
valuesMaxCount number required
valuesMinCount number required

Example

{
  "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
}