Support Questions
Find answers, ask questions, and share your expertise
Announcements
Alert: Welcome to the Unified Cloudera Community. Former HCC members be sure to read and learn how to activate your account here.

When to use the 'options' property for AtlasBaseTypeDefs

Solved Go to solution

When to use the 'options' property for AtlasBaseTypeDefs

Contributor

Could someone help me understand when I would use the 'options' property? It's part of the AtlasBaseTypeDefs and has a type of 'map of string'. In the below example I can create an entity type, but I don't know how to use the 'options' property and under what circumstances I would want to.

{
   "enumDefs":[],
   "structDefs":[],
   "classificationDefs":[],
   "entityDefs":[
      {
         "superTypes":[
           "DataSet"
         ],
	"name":"test_entity_3",
	"description":"test_entity_3",
	"createdBy": "admin",
	"updatedBy": "admin",
	"options" : 
	     {
                "property1" : "when_to_use_1",
                "property2" : "when_to_use_2"
             },
         "attributeDefs":[
            {
               "name":"test_3",
               "isOptional":true,
               "isUnique":false,
               "isIndexable":false,
               "typeName":"string",
               "valuesMaxCount":1,
               "cardinality":"SINGLE",
               "valuesMinCount":0
            }
         ]
         
      }
   ]
}
1 ACCEPTED SOLUTION

Accepted Solutions

Re: When to use the 'options' property for AtlasBaseTypeDefs

Expert Contributor

@Laura Ngo, "options" was added to AtlasBaseTypeDef to allow additional metadata properties to be included with the type definition. These properties allow users to specify any key/value property or constraint on the type definition e.g.

cluster = test_cluster

contains_all_primitive_attributes=true

The options map is not being used currently but added for future use cases.

2 REPLIES 2
Highlighted

Re: When to use the 'options' property for AtlasBaseTypeDefs

Rising Star

As per my knowledge these are only being used for UI rendering. It acts like additional metadata about the entity.

Re: When to use the 'options' property for AtlasBaseTypeDefs

Expert Contributor

@Laura Ngo, "options" was added to AtlasBaseTypeDef to allow additional metadata properties to be included with the type definition. These properties allow users to specify any key/value property or constraint on the type definition e.g.

cluster = test_cluster

contains_all_primitive_attributes=true

The options map is not being used currently but added for future use cases.