Package com.atlan.model.assets

Class GlossaryTerm.GlossaryTermBuilder<C extends GlossaryTerm,B extends GlossaryTerm.GlossaryTermBuilder<C,B>>

java.lang.Object

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

com.atlan.model.relations.Reference.ReferenceBuilder<C,B>

com.atlan.model.assets.Asset.AssetBuilder<C,B>

com.atlan.model.assets.GlossaryTerm.GlossaryTermBuilder<C,B>

Direct Known Subclasses:

GlossaryAntonym.Antonym.AntonymBuilder, GlossaryIsA.Classify.ClassifyBuilder, GlossaryIsA.IsA.IsABuilder, GlossaryPreferredTerm.PreferredTerm.PreferredTermBuilder, GlossaryPreferredTerm.PreferredToTerm.PreferredToTermBuilder, GlossaryRelatedTerm.SeeAlso.SeeAlsoBuilder, GlossaryReplacementTerm.ReplacedBy.ReplacedByBuilder, GlossaryReplacementTerm.ReplacementTerm.ReplacementTermBuilder, GlossarySemanticAssignment.AssignedTerm.AssignedTermBuilder, GlossarySynonym.Synonym.SynonymBuilder, GlossaryTermCategorization.Term.TermBuilder, GlossaryTranslation.TranslatedTerm.TranslatedTermBuilder, GlossaryTranslation.TranslationTerm.TranslationTermBuilder, GlossaryValidValue.ValidValue.ValidValueBuilder, GlossaryValidValue.ValidValuesFor.ValidValuesForBuilder

Enclosing class:

GlossaryTerm

public abstract static class GlossaryTerm.GlossaryTermBuilder<C extends GlossaryTerm,B extends GlossaryTerm.GlossaryTermBuilder<C,B>>
extends Asset.AssetBuilder<C,B>

Constructor Summary

Constructors

Constructor	Description
GlossaryTermBuilder()

Method Summary

Modifier and Type	Method	Description
protected B	$fillValuesFrom(C instance)
B	abbreviation(String abbreviation)	Unused.
B	additionalAttribute(String additionalAttributeKey, String additionalAttributeValue)
B	additionalAttributes(Map<? extends String,? extends String> additionalAttributes)
B	anchor(IGlossary anchor)	Glossary in which this term is contained.
B	antonym(IGlossaryTerm antonym)
B	antonyms(Collection<? extends IGlossaryTerm> antonyms)
B	assignedEntities(Collection<? extends IAsset> assignedEntities)
B	assignedEntity(IAsset assignedEntity)
abstract C	build()
B	categories(Collection<? extends IGlossaryCategory> categories)
B	category(IGlossaryCategory category)
B	classifies(Collection<? extends IGlossaryTerm> classifies)
B	classify(IGlossaryTerm classify)
B	clearAdditionalAttributes()
B	clearAntonyms()
B	clearAssignedEntities()
B	clearCategories()
B	clearClassifies()
B	clearExamples()
B	clearIsA()
B	clearPreferredTerms()
B	clearPreferredToTerms()
B	clearReplacedBy()
B	clearReplacementTerms()
B	clearSeeAlso()
B	clearSynonyms()
B	clearTranslatedTerms()
B	clearTranslationTerms()
B	clearValidValues()
B	clearValidValuesFor()
B	example(String example)
B	examples(Collection<? extends String> examples)
B	isA(Collection<? extends IGlossaryTerm> isA)
B	isATerm(IGlossaryTerm isATerm)
B	longDescription(String longDescription)	Unused.
B	preferredTerm(IGlossaryTerm preferredTerm)
B	preferredTerms(Collection<? extends IGlossaryTerm> preferredTerms)
B	preferredToTerm(IGlossaryTerm preferredToTerm)
B	preferredToTerms(Collection<? extends IGlossaryTerm> preferredToTerms)
B	replacedBy(Collection<? extends IGlossaryTerm> replacedBy)
B	replacedByTerm(IGlossaryTerm replacedByTerm)
B	replacementTerm(IGlossaryTerm replacementTerm)
B	replacementTerms(Collection<? extends IGlossaryTerm> replacementTerms)
B	seeAlso(Collection<? extends IGlossaryTerm> seeAlso)
B	seeAlsoOne(IGlossaryTerm seeAlsoOne)
protected abstract B	self()
B	shortDescription(String shortDescription)	Unused.
B	synonym(IGlossaryTerm synonym)
B	synonyms(Collection<? extends IGlossaryTerm> synonyms)
B	termType(AtlasGlossaryTermType termType)	TBC
String	toString()
B	translatedTerm(IGlossaryTerm translatedTerm)
B	translatedTerms(Collection<? extends IGlossaryTerm> translatedTerms)
B	translationTerm(IGlossaryTerm translationTerm)
B	translationTerms(Collection<? extends IGlossaryTerm> translationTerms)
B	typeName(String typeName)	Fixed typeName for GlossaryTerms.
B	usage(String usage)	Unused.
B	validValue(IGlossaryTerm validValue)
B	validValueFor(IGlossaryTerm validValueFor)
B	validValues(Collection<? extends IGlossaryTerm> validValues)
B	validValuesFor(Collection<? extends IGlossaryTerm> validValuesFor)

Methods inherited from class com.atlan.model.assets.Asset.AssetBuilder

addAssetGCPDataplexAspect, addAssetGCPDataplexAspectField, addStarredBy, adminGroup, adminGroups, adminRole, adminRoles, adminUser, adminUsers, announcementMessage, announcementTitle, announcementType, announcementUpdatedAt, announcementUpdatedBy, anomaloCheck, anomaloChecks, appendAssignedTerm, appendAtlanTag, appendAtlanTag, appendAtlanTags, appendAtlanTags, application, applicationField, applicationFieldQualifiedName, applicationQualifiedName, assetAiGeneratedDescription, assetAiGeneratedDescriptionConfidence, assetAiGeneratedDescriptionReasoning, assetAnnouncementExpiredAt, assetAnomaloAppliedCheckType, assetAnomaloAppliedCheckTypes, assetAnomaloCheckCount, assetAnomaloCheckStatuses, assetAnomaloDQStatus, assetAnomaloFailedCheckCount, assetAnomaloFailedCheckType, assetAnomaloFailedCheckTypes, assetAnomaloLastCheckRunAt, assetAnomaloSourceUrl, assetCoverImage, assetDbtAccountName, assetDbtAlias, assetDbtEnvironmentDbtVersion, assetDbtEnvironmentName, assetDbtJobLastRun, assetDbtJobLastRunArtifactS3Path, assetDbtJobLastRunArtifactsSaved, assetDbtJobLastRunCreatedAt, assetDbtJobLastRunDequedAt, assetDbtJobLastRunExecutedByThreadId, assetDbtJobLastRunGitBranch, assetDbtJobLastRunGitSha, assetDbtJobLastRunHasDocsGenerated, assetDbtJobLastRunHasSourcesGenerated, assetDbtJobLastRunNotificationsSent, assetDbtJobLastRunOwnerThreadId, assetDbtJobLastRunQueuedDuration, assetDbtJobLastRunQueuedDurationHumanized, assetDbtJobLastRunRunDuration, assetDbtJobLastRunRunDurationHumanized, assetDbtJobLastRunStartedAt, assetDbtJobLastRunStatusMessage, assetDbtJobLastRunTotalDuration, assetDbtJobLastRunTotalDurationHumanized, assetDbtJobLastRunUpdatedAt, assetDbtJobLastRunUrl, assetDbtJobName, assetDbtJobNextRun, assetDbtJobNextRunHumanized, assetDbtJobSchedule, assetDbtJobScheduleCronHumanized, assetDbtJobStatus, assetDbtMeta, assetDbtPackageName, assetDbtProjectName, assetDbtSemanticLayerProxyUrl, assetDbtSourceFreshnessCriteria, assetDbtTag, assetDbtTags, assetDbtTestStatus, assetDbtUniqueId, assetDbtWorkflowLastUpdated, assetDQFreshnessExpectation, assetDQFreshnessValue, assetDQManualRunStatus, assetDQResult, assetDQRowScopeFilterColumnQualifiedName, assetDQRuleAttachedDimension, assetDQRuleAttachedDimensions, assetDQRuleAttachedRuleType, assetDQRuleAttachedRuleTypes, assetDQRuleFailedCount, assetDQRuleFailedDimension, assetDQRuleFailedDimensions, assetDQRuleFailedRuleType, assetDQRuleFailedRuleTypes, assetDQRuleLastRunAt, assetDQRulePassedCount, assetDQRulePassedDimension, assetDQRulePassedDimensions, assetDQRulePassedRuleType, assetDQRulePassedRuleTypes, assetDQRuleResultTag, assetDQRuleResultTags, assetDQRuleTotalCount, assetDQScheduleCrontab, assetDQScheduleSourceSyncedAt, assetDQScheduleSourceSyncErrorCode, assetDQScheduleSourceSyncErrorMessage, assetDQScheduleSourceSyncRawError, assetDQScheduleSourceSyncStatus, assetDQScheduleTimeZone, assetDQScheduleType, assetExternalDQMetadataDetail, assetExternalDQMetadataDetails, assetGCPDataplexAspectFieldList, assetGCPDataplexAspectList, assetGCPDataplexMetadataDetails, assetIcon, assetImmutaRequestType, assetImmutaRequestUrl, assetInternalPopularityScore, assetMcAlertQualifiedName, assetMcAlertQualifiedNames, assetMcIncidentName, assetMcIncidentNames, assetMcIncidentPriorities, assetMcIncidentPriority, assetMcIncidentQualifiedName, assetMcIncidentQualifiedNames, assetMcIncidentSeverities, assetMcIncidentSeverity, assetMcIncidentState, assetMcIncidentStates, assetMcIncidentSubType, assetMcIncidentSubTypes, assetMcIncidentType, assetMcIncidentTypes, assetMcIsMonitored, assetMcLastSyncRunAt, assetMcMonitorName, assetMcMonitorNames, assetMcMonitorQualifiedName, assetMcMonitorQualifiedNames, assetMcMonitorScheduleType, assetMcMonitorScheduleTypes, assetMcMonitorStatus, assetMcMonitorStatuses, assetMcMonitorType, assetMcMonitorTypes, assetPoliciesCount, assetPolicyGUID, assetPolicyGUIDs, assetRedirectGUID, assetRedirectGUIDs, assetSmusMetadataFormDetail, assetSmusMetadataFormDetails, assetSmusMetadataFormKeyValueDetail, assetSmusMetadataFormKeyValueDetails, assetSmusMetadataFormName, assetSmusMetadataFormNames, assetSodaCheckCount, assetSodaCheckStatuses, assetSodaDQStatus, assetSodaLastScanAt, assetSodaLastSyncRunAt, assetSodaSourceURL, assetSourceId, assetSourceReadme, assetSpaceName, assetSpaceQualifiedName, assetTag, assetTags, assetThemeHex, assetUserDefinedType, assignedTerm, assignedTerms, atlanTag, atlanTagName, atlanTagNames, atlanTags, certificateStatus, certificateStatusMessage, certificateUpdatedAt, certificateUpdatedBy, clearAdminGroups, clearAdminRoles, clearAdminUsers, clearAnomaloChecks, clearAssetAnomaloAppliedCheckTypes, clearAssetAnomaloFailedCheckTypes, clearAssetDbtTags, clearAssetDQRuleAttachedDimensions, clearAssetDQRuleAttachedRuleTypes, clearAssetDQRuleFailedDimensions, clearAssetDQRuleFailedRuleTypes, clearAssetDQRulePassedDimensions, clearAssetDQRulePassedRuleTypes, clearAssetDQRuleResultTags, clearAssetExternalDQMetadataDetails, clearAssetGCPDataplexAspectFieldList, clearAssetGCPDataplexAspectList, clearAssetMcAlertQualifiedNames, clearAssetMcIncidentNames, clearAssetMcIncidentPriorities, clearAssetMcIncidentQualifiedNames, clearAssetMcIncidentSeverities, clearAssetMcIncidentStates, clearAssetMcIncidentSubTypes, clearAssetMcIncidentTypes, clearAssetMcMonitorNames, clearAssetMcMonitorQualifiedNames, clearAssetMcMonitorScheduleTypes, clearAssetMcMonitorStatuses, clearAssetMcMonitorTypes, clearAssetPolicyGUIDs, clearAssetRedirectGUIDs, clearAssetSmusMetadataFormDetails, clearAssetSmusMetadataFormKeyValueDetails, clearAssetSmusMetadataFormNames, clearAssetTags, clearAssignedTerms, clearAtlanTagNames, clearAtlanTags, clearCustomMetadataSets, clearDomainGUIDs, clearDqBaseDatasetRules, clearDqReferenceDatasetRules, clearFiles, clearInputPortDataProducts, clearLinks, clearMcIncidents, clearMcMonitors, clearMeaningNames, clearMeanings, clearMetrics, clearNonCompliantAssetPolicyGUIDs, clearNullFields, clearOutputPortDataProducts, clearOutputProductGUIDs, clearOwnerGroups, clearOwnerUsers, clearPendingTasks, clearProductGUIDs, clearSchemaRegistrySubjects, clearSodaChecks, clearSourceQueryComputeCostRecords, clearSourceQueryComputeCosts, clearSourceReadExpensiveQueryRecords, clearSourceReadPopularQueryRecords, clearSourceReadRecentUserRecords, clearSourceReadRecentUsers, clearSourceReadSlowQueryRecords, clearSourceReadTopUserRecords, clearSourceReadTopUsers, clearStarredBy, clearStarredDetails, clearUserDefRelationshipFroms, clearUserDefRelationshipTos, clearViewerGroups, clearViewerUsers, connectionName, connectionQualifiedName, connectorName, connectorType, createdBy, createTime, customConnectorType, customMetadata, customMetadataSets, dataContractLatest, dataContractLatestCertified, dbtQualifiedName, deleteHandler, depth, description, displayName, domainGUID, domainGUIDs, dqBaseDatasetRule, dqBaseDatasetRules, dqReferenceDatasetRule, dqReferenceDatasetRules, file, files, hasContract, hasLineage, iconUrl, immediateDownstream, immediateUpstream, inputPortDataProduct, inputPortDataProducts, isAIGenerated, isDiscoverable, isEditable, isIncomplete, isPartial, lastRowChangedAt, lastSyncRun, lastSyncRunAt, lastSyncWorkflowName, lexicographicalSortOrder, link, links, mcIncident, mcIncidents, mcMonitor, mcMonitors, meaning, meaningName, meaningNames, meanings, metric, metrics, name, nonCompliantAssetPolicyGUID, nonCompliantAssetPolicyGUIDs, nullField, nullFields, outputPortDataProduct, outputPortDataProducts, outputProductGUID, outputProductGUIDs, ownerGroup, ownerGroups, ownerUser, ownerUsers, pendingTask, pendingTasks, popularityScore, productGUID, productGUIDs, qualifiedName, readme, removeAnnouncement, removeAssignedTerm, removeAssignedTerms, removeAtlanTag, removeAtlanTags, removeAtlanTags, removeCertificate, removeCustomMetadata, removeDescription, removeOwners, removeUserDescription, sampleDataUrl, schemaRegistrySubject, schemaRegistrySubjects, sodaCheck, sodaChecks, sourceCostUnit, sourceCreatedAt, sourceCreatedBy, sourceEmbedURL, sourceLastReadAt, sourceOwners, sourceQueryComputeCost, sourceQueryComputeCostRecord, sourceQueryComputeCostRecords, sourceQueryComputeCosts, sourceReadCount, sourceReadExpensiveQueryRecord, sourceReadExpensiveQueryRecords, sourceReadPopularQueryRecord, sourceReadPopularQueryRecords, sourceReadQueryCost, sourceReadRecentUser, sourceReadRecentUserRecord, sourceReadRecentUserRecords, sourceReadRecentUsers, sourceReadSlowQueryRecord, sourceReadSlowQueryRecords, sourceReadTopUser, sourceReadTopUserRecord, sourceReadTopUserRecords, sourceReadTopUsers, sourceReadUserCount, sourceTotalCost, sourceUpdatedAt, sourceUpdatedBy, sourceURL, starredBy, starredCount, starredDetail, starredDetails, status, subType, tenantId, updatedBy, updateTime, userDefRelationshipFrom, userDefRelationshipFroms, userDefRelationshipTo, userDefRelationshipTos, userDescription, viewerGroup, viewerGroups, viewerUser, viewerUsers, viewScore

Methods inherited from class com.atlan.model.relations.Reference.ReferenceBuilder

addedRelationshipAttributes, clearCustomAttributes, clearLabels, completeObject, customAttribute, customAttributes, displayText, docId, entityStatus, guid, label, labels, relationshipAttributes, relationshipGuid, relationshipStatus, relationshipType, removedRelationshipAttributes, semantic, uniqueAttributes

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

GlossaryTermBuilder

public GlossaryTermBuilder()

Method Details

$fillValuesFrom

protected B $fillValuesFrom(C instance)

Overrides:

$fillValuesFrom in class Asset.AssetBuilder<C extends GlossaryTerm,B extends GlossaryTerm.GlossaryTermBuilder<C,B>>

typeName

public B typeName(String typeName)

Fixed typeName for GlossaryTerms.

Overrides:

typeName in class Reference.ReferenceBuilder<C extends GlossaryTerm,B extends GlossaryTerm.GlossaryTermBuilder<C,B>>

Returns:

this.

abbreviation

public B abbreviation(String abbreviation)

Unused. Abbreviation of the term.

Returns:

this.

additionalAttribute

public B additionalAttribute(String additionalAttributeKey,
 String additionalAttributeValue)

additionalAttributes

public B additionalAttributes(Map<? extends String,? extends String> additionalAttributes)

clearAdditionalAttributes

public B clearAdditionalAttributes()

anchor

public B anchor(IGlossary anchor)

Glossary in which this term is contained.

Returns:

this.

antonym

public B antonym(IGlossaryTerm antonym)

antonyms

public B antonyms(Collection<? extends IGlossaryTerm> antonyms)

clearAntonyms

public B clearAntonyms()

assignedEntity

public B assignedEntity(IAsset assignedEntity)

assignedEntities

public B assignedEntities(Collection<? extends IAsset> assignedEntities)

clearAssignedEntities

public B clearAssignedEntities()

category

public B category(IGlossaryCategory category)

categories

public B categories(Collection<? extends IGlossaryCategory> categories)

clearCategories

public B clearCategories()

classify

public B classify(IGlossaryTerm classify)

classifies

public B classifies(Collection<? extends IGlossaryTerm> classifies)

clearClassifies

public B clearClassifies()

example

public B example(String example)

examples

public B examples(Collection<? extends String> examples)

clearExamples

public B clearExamples()

isATerm

public B isATerm(IGlossaryTerm isATerm)

isA

public B isA(Collection<? extends IGlossaryTerm> isA)

clearIsA

public B clearIsA()

longDescription

public B longDescription(String longDescription)

Unused. Detailed definition of the term. See 'readme' instead.

Returns:

this.

preferredTerm

public B preferredTerm(IGlossaryTerm preferredTerm)

preferredTerms

public B preferredTerms(Collection<? extends IGlossaryTerm> preferredTerms)

clearPreferredTerms

public B clearPreferredTerms()

preferredToTerm

public B preferredToTerm(IGlossaryTerm preferredToTerm)

preferredToTerms

public B preferredToTerms(Collection<? extends IGlossaryTerm> preferredToTerms)

clearPreferredToTerms

public B clearPreferredToTerms()

replacedByTerm

public B replacedByTerm(IGlossaryTerm replacedByTerm)

replacedBy

public B replacedBy(Collection<? extends IGlossaryTerm> replacedBy)

clearReplacedBy

public B clearReplacedBy()

replacementTerm

public B replacementTerm(IGlossaryTerm replacementTerm)

replacementTerms

public B replacementTerms(Collection<? extends IGlossaryTerm> replacementTerms)

clearReplacementTerms

public B clearReplacementTerms()

seeAlsoOne

public B seeAlsoOne(IGlossaryTerm seeAlsoOne)

seeAlso

public B seeAlso(Collection<? extends IGlossaryTerm> seeAlso)

clearSeeAlso

public B clearSeeAlso()

shortDescription

public B shortDescription(String shortDescription)

Unused. Brief summary of the term. See 'description' and 'userDescription' instead.

Returns:

this.

synonym

public B synonym(IGlossaryTerm synonym)

synonyms

public B synonyms(Collection<? extends IGlossaryTerm> synonyms)

clearSynonyms

public B clearSynonyms()

termType

public B termType(AtlasGlossaryTermType termType)

TBC

Returns:

this.

translatedTerm

public B translatedTerm(IGlossaryTerm translatedTerm)

translatedTerms

public B translatedTerms(Collection<? extends IGlossaryTerm> translatedTerms)

clearTranslatedTerms

public B clearTranslatedTerms()

translationTerm

public B translationTerm(IGlossaryTerm translationTerm)

translationTerms

public B translationTerms(Collection<? extends IGlossaryTerm> translationTerms)

clearTranslationTerms

public B clearTranslationTerms()

usage

public B usage(String usage)

Unused. Intended usage for the term.

Returns:

this.

validValue

public B validValue(IGlossaryTerm validValue)

validValues

public B validValues(Collection<? extends IGlossaryTerm> validValues)

clearValidValues

public B clearValidValues()

validValueFor

public B validValueFor(IGlossaryTerm validValueFor)

validValuesFor

public B validValuesFor(Collection<? extends IGlossaryTerm> validValuesFor)

clearValidValuesFor

public B clearValidValuesFor()

self

protected abstract B self()

Specified by:

self in class Asset.AssetBuilder<C extends GlossaryTerm,B extends GlossaryTerm.GlossaryTermBuilder<C,B>>

build

public abstract C build()

Specified by:

build in class Asset.AssetBuilder<C extends GlossaryTerm,B extends GlossaryTerm.GlossaryTermBuilder<C,B>>

toString

public String toString()

Overrides:

toString in class Asset.AssetBuilder<C extends GlossaryTerm,B extends GlossaryTerm.GlossaryTermBuilder<C,B>>