Package com.atlan.model.typedefs

Class RelationshipDef

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.typedefs.TypeDef

com.atlan.model.typedefs.RelationshipDef

All Implemented Interfaces:

Serializable

public class RelationshipDef
extends TypeDef

Structural definition of an entity.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RelationshipDef.RelationshipDefBuilder<C extends RelationshipDef,B extends RelationshipDef.RelationshipDefBuilder<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	RelationshipDef(RelationshipDef.RelationshipDefBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static RelationshipDef.RelationshipDefBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
static RelationshipDef.RelationshipDefBuilder<?,?>	creator(String name, RelationshipEndDef end1, RelationshipEndDef end2)	Build up a relationship definition from the provided parameters and default settings for all other parameters.
static RelationshipDef.RelationshipDefBuilder<?,?>	creator(String name, RelationshipEndDef end1, RelationshipEndDef end2, List<AttributeDef> attributes)	Build up a relationship 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.
RelationshipEndDef	getEndDef1()	Definition for the first endpoint of the relationship.
RelationshipEndDef	getEndDef2()	Definition for the second endpoint of the relationship.
PropagateTags	getPropagateTags()	Whether Atlan tags should propagate through this relationship, and if so in which direction(s).
List<RelationshipAttributeDef>	getRelationshipAttributeDefs()	Relationships that can exist for the entity.
RelationshipCategory	getRelationshipCategory()	Style of relationship in regard to containment and lifecycle.
String	getRelationshipLabel()	TBC
List<String>	getSubTypes()	Subtypes of this entity type.
List<String>	getSuperTypes()	Supertypes of this entity type.
int	hashCode()
RelationshipDef.RelationshipDefBuilder<?,?>	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

RelationshipDef

protected RelationshipDef(RelationshipDef.RelationshipDefBuilder<?,?> b)

Method Details

creator

public static RelationshipDef.RelationshipDefBuilder<?,?> creator(String name,
 RelationshipEndDef end1,
 RelationshipEndDef end2)

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

Parameters:

name - name of the relationship definition

end1 - definition of the first endpoint of the relationship

end2 - definition of the second endpoint of the relationship

Returns:

a builder for a relationship definition

creator

public static RelationshipDef.RelationshipDefBuilder<?,?> creator(String name,
 RelationshipEndDef end1,
 RelationshipEndDef end2,
 List<AttributeDef> attributes)

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

Parameters:

name - name of the relationship definition

end1 - definition of the first endpoint of the relationship

end2 - definition of the second endpoint of the relationship

attributes - definitions for each attribute within the relationship definition

Returns:

a builder for a relationship definition

builder

public static RelationshipDef.RelationshipDefBuilder<?,?> builder()

toBuilder

public RelationshipDef.RelationshipDefBuilder<?,?> toBuilder()

getRelationshipLabel

public String getRelationshipLabel()

TBC

getRelationshipCategory

public RelationshipCategory getRelationshipCategory()

Style of relationship in regard to containment and lifecycle.

getPropagateTags

public PropagateTags getPropagateTags()

Whether Atlan tags should propagate through this relationship, and if so in which direction(s).

getEndDef1

public RelationshipEndDef getEndDef1()

Definition for the first endpoint of the relationship.

getEndDef2

public RelationshipEndDef getEndDef2()

Definition for the second endpoint of the relationship.

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