Package com.atlan.model.typedefs

Class EntityDef

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.typedefs.TypeDef

com.atlan.model.typedefs.EntityDef

All Implemented Interfaces:

Serializable

public class EntityDef
extends TypeDef

Structural definition of an entity.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EntityDef.EntityDefBuilder<C extends EntityDef,B extends EntityDef.EntityDefBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.typedefs.TypeDef

TypeDef.TypeDefBuilder<C extends TypeDef,B extends TypeDef.TypeDefBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject

AtlanObject.AtlanObjectBuilder<C extends AtlanObject,B extends AtlanObject.AtlanObjectBuilder<C,B>>

Field Summary

Fields inherited from class com.atlan.model.core.AtlanObject

rawJsonObject

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EntityDef(EntityDef.EntityDefBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static EntityDef.EntityDefBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
static EntityDef.EntityDefBuilder<?,?>	creator(String name, List<AttributeDef> attributes)	Build up an entity definition from the provided parameters and default settings for all other parameters.
static EntityDef.EntityDefBuilder<?,?>	creator(String name, List<AttributeDef> attributes, List<String> superTypes)	Build up an entity definition from the provided parameters and default settings for all other parameters.
boolean	equals(Object o)
Map<String,Object>	getBusinessAttributeDefs()	Unused.
AtlanTypeCategory	getCategory()	Fixed category for entity typedefs.
List<RelationshipAttributeDef>	getRelationshipAttributeDefs()	Relationships that can exist for the entity.
List<String>	getSubTypes()	Subtypes of this entity type.
List<String>	getSuperTypes()	Supertypes of this entity type.
int	hashCode()
EntityDef.EntityDefBuilder<?,?>	toBuilder()
String	toString()

Methods inherited from class com.atlan.model.typedefs.TypeDef

getAttributeDefs, getCreatedBy, getCreateTime, getDescription, getDisplayName, getGuid, getName, getServiceType, getTypeVersion, getUpdatedBy, getUpdateTime, getVersion

Methods inherited from class com.atlan.model.core.AtlanObject

getRawJsonObject, setRawJsonObject, toJson

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

EntityDef

protected EntityDef(EntityDef.EntityDefBuilder<?,?> b)

Method Details

creator

public static EntityDef.EntityDefBuilder<?,?> creator(String name,
 List<AttributeDef> attributes)

Build up an entity definition from the provided parameters and default settings for all other parameters. NOTE: INTERNAL USE ONLY.

Parameters:

name - name of the entity definition

attributes - definitions for each attribute within the entity definition

Returns:

a builder for an entity definition

creator

public static EntityDef.EntityDefBuilder<?,?> creator(String name,
 List<AttributeDef> attributes,
 List<String> superTypes)

Build up an entity definition from the provided parameters and default settings for all other parameters. NOTE: INTERNAL USE ONLY.

Parameters:

name - name of the entity definition

attributes - definitions for each attribute within the entity definition

superTypes - names of the types that this entity definition should inherit from

Returns:

a builder for an entity definition

builder

public static EntityDef.EntityDefBuilder<?,?> builder()

toBuilder

public EntityDef.EntityDefBuilder<?,?> toBuilder()

getRelationshipAttributeDefs

public List<RelationshipAttributeDef> getRelationshipAttributeDefs()

Relationships that can exist for the entity.

getSubTypes

public List<String> getSubTypes()

Subtypes of this entity type.

getSuperTypes

public List<String> getSuperTypes()

Supertypes of this entity type.

getBusinessAttributeDefs

public Map<String,Object> getBusinessAttributeDefs()

Unused.

equals

public boolean equals(Object o)

Overrides:

equals in class TypeDef

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class TypeDef

hashCode

public int hashCode()

Overrides:

hashCode in class TypeDef

toString

public String toString()

Description copied from class: AtlanObject

Overrides:

toString in class TypeDef

getCategory

public AtlanTypeCategory getCategory()

Fixed category for entity typedefs.

Overrides:

getCategory in class TypeDef