Package com.atlan.model.typedefs

Class RelationshipEndDef

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.typedefs.AttributeDef

com.atlan.model.typedefs.RelationshipEndDef

All Implemented Interfaces:

Serializable, Comparable<AttributeDef>

public class RelationshipEndDef
extends AttributeDef

Defines the characteristics of the structure of one end of a relationship.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RelationshipEndDef.RelationshipEndDefBuilder<C extends RelationshipEndDef,B extends RelationshipEndDef.RelationshipEndDefBuilder<C,B>>

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

AttributeDef.AttributeDefBuilder<C extends AttributeDef,B extends AttributeDef.AttributeDefBuilder<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	RelationshipEndDef(RelationshipEndDef.RelationshipEndDefBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static RelationshipEndDef.RelationshipEndDefBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
static RelationshipEndDef.RelationshipEndDefBuilder<?,?>	creator(String name, String type, boolean isContainer, AtlanCustomAttributeCardinality cardinality)	Builds the minimal object necessary to construct a relationship end definition.
boolean	equals(Object o)
AtlanCustomAttributeCardinality	getCardinality()	Cardinality of this end of the relationship.
String	getDescription()	Description of the relationship from this end of it.
Boolean	getIsContainer()	Whether this end of the relationship is a container ("owns" the other end's assets).
Boolean	getIsLegacyAttribute()	TBC
String	getName()	Name of the attribute that represents this end of the relationship.
String	getType()	Name of the type definition (entity type) for the other end of the relationship.
int	hashCode()
RelationshipEndDef.RelationshipEndDefBuilder<?,?>	toBuilder()
String	toString()

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

compareTo, creator, creator, getAutoUpdateAttributes, getBasicType, getBasicType, getConstraints, getContainerType, getContainerType, getDefaultValue, getDisplayName, getEnumValues, getIncludeInNotification, getIndexType, getIndexTypeESConfig, getIndexTypeESFields, getIsDefaultValueNull, getIsIndexable, getIsNew, getIsOptional, getIsUnique, getOptions, getSearchWeight, getSkipScrubbing, getTypeName, getValuesMaxCount, getValuesMinCount, isArchived, of, of, of, of, of, of, of, of

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

RelationshipEndDef

protected RelationshipEndDef(RelationshipEndDef.RelationshipEndDefBuilder<?,?> b)

Method Details

creator

public static RelationshipEndDef.RelationshipEndDefBuilder<?,?> creator(String name,
 String type,
 boolean isContainer,
 AtlanCustomAttributeCardinality cardinality)

Builds the minimal object necessary to construct a relationship end definition. NOTE: INTERNAL USE ONLY.

Parameters:

name - of the attribute that represents this end of the relationship

type - name of the entity definition for the other end of the relationship

isContainer - whether this end of the relationship "owns" the other end's assets

cardinality - of this end of the relationship

Returns:

builder containing minimal information necessary to define a new relationship end

builder

public static RelationshipEndDef.RelationshipEndDefBuilder<?,?> builder()

toBuilder

public RelationshipEndDef.RelationshipEndDefBuilder<?,?> toBuilder()

Overrides:

toBuilder in class AttributeDef

getName

public String getName()

Name of the attribute that represents this end of the relationship.

Overrides:

getName in class AttributeDef

getDescription

public String getDescription()

Description of the relationship from this end of it.

Overrides:

getDescription in class AttributeDef

getType

public String getType()

Name of the type definition (entity type) for the other end of the relationship.

getIsContainer

public Boolean getIsContainer()

Whether this end of the relationship is a container ("owns" the other end's assets).

getIsLegacyAttribute

public Boolean getIsLegacyAttribute()

TBC

getCardinality

public AtlanCustomAttributeCardinality getCardinality()

Cardinality of this end of the relationship.

Overrides:

getCardinality in class AttributeDef

equals

public boolean equals(Object o)

Overrides:

equals in class AttributeDef

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AttributeDef

hashCode

public int hashCode()

Overrides:

hashCode in class AttributeDef

toString

public String toString()

Description copied from class: AtlanObject

Overrides:

toString in class AttributeDef