Package com.atlan.model.relations

Class UserDefRelationship.UserDefRelationshipBuilder<C extends UserDefRelationship,B extends UserDefRelationship.UserDefRelationshipBuilder<C,B>>

java.lang.Object

com.atlan.model.core.AtlanObject.AtlanObjectBuilder<C,B>

com.atlan.model.relations.RelationshipAttributes.RelationshipAttributesBuilder<C,B>

com.atlan.model.relations.UserDefRelationship.UserDefRelationshipBuilder<C,B>

Enclosing class:

UserDefRelationship

public abstract static class UserDefRelationship.UserDefRelationshipBuilder<C extends UserDefRelationship,B extends UserDefRelationship.UserDefRelationshipBuilder<C,B>>
extends RelationshipAttributes.RelationshipAttributesBuilder<C,B>

Constructor Summary

Constructors

Constructor	Description
UserDefRelationshipBuilder()

Method Summary

Modifier and Type	Method	Description
protected B	$fillValuesFrom(C instance)
abstract C	build()
B	fromTypeLabel(String fromTypeLabel)	Name for the relationship when referring from endDef2 asset to endDef1 asset.
protected abstract B	self()
String	toString()
B	toTypeLabel(String toTypeLabel)	Name for the relationship when referring from endDef1 asset to endDef2 asset.
B	typeName(String typeName)	Fixed typeName for UserDefRelationships.
IAsset	userDefRelationshipFrom(IAsset related, Reference.SaveSemantic semantic)	Build the UserDefRelationship relationship (with attributes) into a related object.
IAsset	userDefRelationshipTo(IAsset related, Reference.SaveSemantic semantic)	Build the UserDefRelationship relationship (with attributes) into a related object.

Methods inherited from class com.atlan.model.relations.RelationshipAttributes.RelationshipAttributesBuilder

clearNullFields, nullField, nullFields

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

rawJsonObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

UserDefRelationshipBuilder

public UserDefRelationshipBuilder()

Method Details

userDefRelationshipFrom

public IAsset userDefRelationshipFrom(IAsset related,
 Reference.SaveSemantic semantic)
                               throws InvalidRequestException

Build the UserDefRelationship relationship (with attributes) into a related object.

Parameters:

related - the related asset to which to build the detailed relationship

semantic - to use for saving the relationship

Returns:

a detailed Atlan relationship that conforms to the necessary interface for a related asset

Throws:

InvalidRequestException - if the asset provided is without a GUID or qualifiedName

userDefRelationshipTo

public IAsset userDefRelationshipTo(IAsset related,
 Reference.SaveSemantic semantic)
                             throws InvalidRequestException

Build the UserDefRelationship relationship (with attributes) into a related object.

Parameters:

related - the related asset to which to build the detailed relationship

semantic - to use for saving the relationship

Returns:

a detailed Atlan relationship that conforms to the necessary interface for a related asset

Throws:

InvalidRequestException - if the asset provided is without a GUID or qualifiedName

$fillValuesFrom

protected B $fillValuesFrom(C instance)

Overrides:

$fillValuesFrom in class AtlanObject.AtlanObjectBuilder<C extends UserDefRelationship,B extends UserDefRelationship.UserDefRelationshipBuilder<C,B>>

typeName

public B typeName(String typeName)

Fixed typeName for UserDefRelationships.

Overrides:

typeName in class RelationshipAttributes.RelationshipAttributesBuilder<C extends UserDefRelationship,B extends UserDefRelationship.UserDefRelationshipBuilder<C,B>>

Returns:

this.

fromTypeLabel

public B fromTypeLabel(String fromTypeLabel)

Name for the relationship when referring from endDef2 asset to endDef1 asset.

Returns:

this.

toTypeLabel

public B toTypeLabel(String toTypeLabel)

Name for the relationship when referring from endDef1 asset to endDef2 asset.

Returns:

this.

self

protected abstract B self()

Specified by:

self in class RelationshipAttributes.RelationshipAttributesBuilder<C extends UserDefRelationship,B extends UserDefRelationship.UserDefRelationshipBuilder<C,B>>

build

public abstract C build()

Specified by:

build in class RelationshipAttributes.RelationshipAttributesBuilder<C extends UserDefRelationship,B extends UserDefRelationship.UserDefRelationshipBuilder<C,B>>

toString

public String toString()

Overrides:

toString in class RelationshipAttributes.RelationshipAttributesBuilder<C extends UserDefRelationship,B extends UserDefRelationship.UserDefRelationshipBuilder<C,B>>