Package com.atlan.model.relations

Class GlossarySynonym.GlossarySynonymBuilder<C extends GlossarySynonym,B extends GlossarySynonym.GlossarySynonymBuilder<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.GlossarySynonym.GlossarySynonymBuilder<C,B>

Enclosing class:

GlossarySynonym

public abstract static class GlossarySynonym.GlossarySynonymBuilder<C extends GlossarySynonym,B extends GlossarySynonym.GlossarySynonymBuilder<C,B>>
extends RelationshipAttributes.RelationshipAttributesBuilder<C,B>

Constructor Summary

Constructors

Constructor	Description
GlossarySynonymBuilder()

Method Summary

Modifier and Type	Method	Description
protected B	$fillValuesFrom(C instance)
abstract C	build()
B	description(String description)	Details about the relationship.
B	expression(String expression)	Expression used to set the relationship.
protected abstract B	self()
B	source(String source)	Source of the relationship.
B	status(AtlasGlossaryTermRelationshipStatus status)	Status of the synonym assignment, typically used by discovery engines.
B	steward(String steward)	User responsible for assessing the relationship and deciding if it should be approved or not.
IGlossaryTerm	synonym(IGlossaryTerm related, Reference.SaveSemantic semantic)	Build the GlossarySynonym relationship (with attributes) into a related object.
String	toString()
B	typeName(String typeName)	Fixed typeName for GlossarySynonyms.

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

GlossarySynonymBuilder

public GlossarySynonymBuilder()

Method Details

synonym

public IGlossaryTerm synonym(IGlossaryTerm related,
 Reference.SaveSemantic semantic)
                      throws InvalidRequestException

Build the GlossarySynonym 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 GlossarySynonym,B extends GlossarySynonym.GlossarySynonymBuilder<C,B>>

typeName

public B typeName(String typeName)

Fixed typeName for GlossarySynonyms.

Overrides:

typeName in class RelationshipAttributes.RelationshipAttributesBuilder<C extends GlossarySynonym,B extends GlossarySynonym.GlossarySynonymBuilder<C,B>>

Returns:

this.

description

public B description(String description)

Details about the relationship.

Returns:

this.

expression

public B expression(String expression)

Expression used to set the relationship.

Returns:

this.

source

public B source(String source)

Source of the relationship.

Returns:

this.

status

public B status(AtlasGlossaryTermRelationshipStatus status)

Status of the synonym assignment, typically used by discovery engines.

Returns:

this.

steward

public B steward(String steward)

User responsible for assessing the relationship and deciding if it should be approved or not.

Returns:

this.

self

protected abstract B self()

Specified by:

self in class RelationshipAttributes.RelationshipAttributesBuilder<C extends GlossarySynonym,B extends GlossarySynonym.GlossarySynonymBuilder<C,B>>

build

public abstract C build()

Specified by:

build in class RelationshipAttributes.RelationshipAttributesBuilder<C extends GlossarySynonym,B extends GlossarySynonym.GlossarySynonymBuilder<C,B>>

toString

public String toString()

Overrides:

toString in class RelationshipAttributes.RelationshipAttributesBuilder<C extends GlossarySynonym,B extends GlossarySynonym.GlossarySynonymBuilder<C,B>>