Package com.atlan.model.assets

Class Glossary.GlossaryBuilder<C extends Glossary,B extends Glossary.GlossaryBuilder<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.Glossary.GlossaryBuilder<C,B>

Enclosing class:

Glossary

public abstract static class Glossary.GlossaryBuilder<C extends Glossary,B extends Glossary.GlossaryBuilder<C,B>>
extends Asset.AssetBuilder<C,B>

Constructor Summary

Constructors

Constructor	Description
GlossaryBuilder()

Method Summary

Modifier and Type	Method	Description
protected B	$fillValuesFrom(C instance)
B	additionalAttribute(String additionalAttributeKey, String additionalAttributeValue)
B	additionalAttributes(Map<? extends String,? extends String> additionalAttributes)
abstract C	build()
B	categories(Collection<? extends IGlossaryCategory> categories)
B	category(IGlossaryCategory category)
B	clearAdditionalAttributes()
B	clearCategories()
B	clearTerms()
B	glossaryType(AtlasGlossaryType glossaryType)	TBC
B	language(String language)	Unused.
B	longDescription(String longDescription)	Unused.
protected abstract B	self()
B	shortDescription(String shortDescription)	Unused.
B	term(IGlossaryTerm term)
B	terms(Collection<? extends IGlossaryTerm> terms)
String	toString()
B	typeName(String typeName)	Fixed typeName for Glossarys.
B	usage(String usage)	Unused.

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

GlossaryBuilder

public GlossaryBuilder()

Method Details

$fillValuesFrom

protected B $fillValuesFrom(C instance)

Overrides:

$fillValuesFrom in class Asset.AssetBuilder<C extends Glossary,B extends Glossary.GlossaryBuilder<C,B>>

typeName

public B typeName(String typeName)

Fixed typeName for Glossarys.

Overrides:

typeName in class Reference.ReferenceBuilder<C extends Glossary,B extends Glossary.GlossaryBuilder<C,B>>

Returns:

this.

additionalAttribute

public B additionalAttribute(String additionalAttributeKey,
 String additionalAttributeValue)

additionalAttributes

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

clearAdditionalAttributes

public B clearAdditionalAttributes()

category

public B category(IGlossaryCategory category)

categories

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

clearCategories

public B clearCategories()

glossaryType

public B glossaryType(AtlasGlossaryType glossaryType)

TBC

Returns:

this.

language

public B language(String language)

Unused. Language of the glossary's contents.

Returns:

this.

longDescription

public B longDescription(String longDescription)

Unused. A longer description of the glossary. See 'readme' instead.

Returns:

this.

shortDescription

public B shortDescription(String shortDescription)

Unused. A short definition of the glossary. See 'description' and 'userDescription' instead.

Returns:

this.

term

public B term(IGlossaryTerm term)

terms

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

clearTerms

public B clearTerms()

usage

public B usage(String usage)

Unused. Inteded usage for the glossary.

Returns:

this.

self

protected abstract B self()

Specified by:

self in class Asset.AssetBuilder<C extends Glossary,B extends Glossary.GlossaryBuilder<C,B>>

build

public abstract C build()

Specified by:

build in class Asset.AssetBuilder<C extends Glossary,B extends Glossary.GlossaryBuilder<C,B>>

toString

public String toString()

Overrides:

toString in class Asset.AssetBuilder<C extends Glossary,B extends Glossary.GlossaryBuilder<C,B>>