Package com.atlan.model.assets
Class GlossaryTerm
java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.GlossaryTerm
- All Implemented Interfaces:
IAsset,IGlossaryTerm,IReferenceable,AuditDetail,Serializable,Comparable<Reference>
- Direct Known Subclasses:
GlossaryAntonym.Antonym,GlossaryIsA.Classify,GlossaryIsA.IsA,GlossaryPreferredTerm.PreferredTerm,GlossaryPreferredTerm.PreferredToTerm,GlossaryRelatedTerm.SeeAlso,GlossaryReplacementTerm.ReplacedBy,GlossaryReplacementTerm.ReplacementTerm,GlossarySemanticAssignment.AssignedTerm,GlossarySynonym.Synonym,GlossaryTermCategorization.Term,GlossaryTranslation.TranslatedTerm,GlossaryTranslation.TranslationTerm,GlossaryValidValue.ValidValue,GlossaryValidValue.ValidValuesFor
@Generated("com.atlan.generators.ModelGeneratorV2")
public class GlossaryTerm
extends Asset
implements IGlossaryTerm, IAsset, IReferenceable
Instance of a term in Atlan. Terms define concepts in natural language that can be associated with other assets to provide meaning.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classGlossaryTerm.GlossaryTermBuilder<C extends GlossaryTerm,B extends GlossaryTerm.GlossaryTermBuilder<C, B>> Nested classes/interfaces inherited from class com.atlan.model.assets.Asset
Asset.AssetBuilder<C extends Asset,B extends Asset.AssetBuilder<C, B>> Nested classes/interfaces inherited from class com.atlan.model.relations.Reference
Reference.ReferenceBuilder<C extends Reference,B extends Reference.ReferenceBuilder<C, B>>, Reference.SaveSemantic Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject
AtlanObject.AtlanObjectBuilder<C extends AtlanObject,B extends AtlanObject.AtlanObjectBuilder<C, B>> -
Field Summary
FieldsFields inherited from class com.atlan.model.core.AtlanObject
rawJsonObjectFields inherited from interface com.atlan.model.assets.IAsset
ADMIN_GROUPS, ADMIN_ROLES, ADMIN_USERS, ANNOUNCEMENT_MESSAGE, ANNOUNCEMENT_TITLE, ANNOUNCEMENT_TYPE, ANNOUNCEMENT_UPDATED_AT, ANNOUNCEMENT_UPDATED_BY, ANOMALO_CHECKS, APPLICATION, APPLICATION_FIELD, APPLICATION_FIELD_QUALIFIED_NAME, APPLICATION_QUALIFIED_NAME, ASSET_ANOMALO_APPLIED_CHECK_TYPES, ASSET_ANOMALO_CHECK_COUNT, ASSET_ANOMALO_CHECK_STATUSES, ASSET_ANOMALO_DQ_STATUS, ASSET_ANOMALO_FAILED_CHECK_COUNT, ASSET_ANOMALO_FAILED_CHECK_TYPES, ASSET_ANOMALO_LAST_CHECK_RUN_AT, ASSET_ANOMALO_SOURCE_URL, ASSET_COVER_IMAGE, ASSET_DBT_ACCOUNT_NAME, ASSET_DBT_ALIAS, ASSET_DBT_ENVIRONMENT_DBT_VERSION, ASSET_DBT_ENVIRONMENT_NAME, ASSET_DBT_JOB_LAST_RUN, ASSET_DBT_JOB_LAST_RUN_ARTIFACT_S3PATH, ASSET_DBT_JOB_LAST_RUN_ARTIFACTS_SAVED, ASSET_DBT_JOB_LAST_RUN_CREATED_AT, ASSET_DBT_JOB_LAST_RUN_DEQUED_AT, ASSET_DBT_JOB_LAST_RUN_EXECUTED_BY_THREAD_ID, ASSET_DBT_JOB_LAST_RUN_GIT_BRANCH, ASSET_DBT_JOB_LAST_RUN_GIT_SHA, ASSET_DBT_JOB_LAST_RUN_HAS_DOCS_GENERATED, ASSET_DBT_JOB_LAST_RUN_HAS_SOURCES_GENERATED, ASSET_DBT_JOB_LAST_RUN_NOTIFICATIONS_SENT, ASSET_DBT_JOB_LAST_RUN_OWNER_THREAD_ID, ASSET_DBT_JOB_LAST_RUN_QUEUED_DURATION, ASSET_DBT_JOB_LAST_RUN_QUEUED_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_RUN_DURATION, ASSET_DBT_JOB_LAST_RUN_RUN_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_STARTED_AT, ASSET_DBT_JOB_LAST_RUN_STATUS_MESSAGE, ASSET_DBT_JOB_LAST_RUN_TOTAL_DURATION, ASSET_DBT_JOB_LAST_RUN_TOTAL_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_UPDATED_AT, ASSET_DBT_JOB_LAST_RUN_URL, ASSET_DBT_JOB_NAME, ASSET_DBT_JOB_NEXT_RUN, ASSET_DBT_JOB_NEXT_RUN_HUMANIZED, ASSET_DBT_JOB_SCHEDULE, ASSET_DBT_JOB_SCHEDULE_CRON_HUMANIZED, ASSET_DBT_JOB_STATUS, ASSET_DBT_META, ASSET_DBT_PACKAGE_NAME, ASSET_DBT_PROJECT_NAME, ASSET_DBT_SEMANTIC_LAYER_PROXY_URL, ASSET_DBT_SOURCE_FRESHNESS_CRITERIA, ASSET_DBT_TAGS, ASSET_DBT_TEST_STATUS, ASSET_DBT_UNIQUE_ID, ASSET_DBT_WORKFLOW_LAST_UPDATED, ASSET_DQ_FRESHNESS_EXPECTATION, ASSET_DQ_FRESHNESS_VALUE, ASSET_DQ_RESULT, ASSET_DQ_ROW_SCOPE_FILTER_COLUMN_QUALIFIED_NAME, ASSET_DQ_RULE_ATTACHED_DIMENSIONS, ASSET_DQ_RULE_ATTACHED_RULE_TYPES, ASSET_DQ_RULE_FAILED_COUNT, ASSET_DQ_RULE_FAILED_DIMENSIONS, ASSET_DQ_RULE_FAILED_RULE_TYPES, ASSET_DQ_RULE_LAST_RUN_AT, ASSET_DQ_RULE_PASSED_COUNT, ASSET_DQ_RULE_PASSED_DIMENSIONS, ASSET_DQ_RULE_PASSED_RULE_TYPES, ASSET_DQ_RULE_RESULT_TAGS, ASSET_DQ_RULE_TOTAL_COUNT, ASSET_DQ_SCHEDULE_CRONTAB, ASSET_DQ_SCHEDULE_SOURCE_SYNC_ERROR_CODE, ASSET_DQ_SCHEDULE_SOURCE_SYNC_ERROR_MESSAGE, ASSET_DQ_SCHEDULE_SOURCE_SYNC_RAW_ERROR, ASSET_DQ_SCHEDULE_SOURCE_SYNC_STATUS, ASSET_DQ_SCHEDULE_SOURCE_SYNCED_AT, ASSET_DQ_SCHEDULE_TIME_ZONE, ASSET_DQ_SCHEDULE_TYPE, ASSET_EXTERNAL_DQ_METADATA_DETAILS, ASSET_ICON, ASSET_INTERNAL_POPULARITY_SCORE, ASSET_MC_ALERT_QUALIFIED_NAMES, ASSET_MC_INCIDENT_NAMES, ASSET_MC_INCIDENT_PRIORITIES, ASSET_MC_INCIDENT_QUALIFIED_NAMES, ASSET_MC_INCIDENT_SEVERITIES, ASSET_MC_INCIDENT_STATES, ASSET_MC_INCIDENT_SUB_TYPES, ASSET_MC_INCIDENT_TYPES, ASSET_MC_IS_MONITORED, ASSET_MC_LAST_SYNC_RUN_AT, ASSET_MC_MONITOR_NAMES, ASSET_MC_MONITOR_QUALIFIED_NAMES, ASSET_MC_MONITOR_SCHEDULE_TYPES, ASSET_MC_MONITOR_STATUSES, ASSET_MC_MONITOR_TYPES, ASSET_POLICIES_COUNT, ASSET_POLICY_GUIDS, ASSET_REDIRECT_GUIDS, ASSET_SODA_CHECK_COUNT, ASSET_SODA_CHECK_STATUSES, ASSET_SODA_DQ_STATUS, ASSET_SODA_LAST_SCAN_AT, ASSET_SODA_LAST_SYNC_RUN_AT, ASSET_SODA_SOURCE_URL, ASSET_SOURCE_README, ASSET_SPACE_NAME, ASSET_SPACE_QUALIFIED_NAME, ASSET_TAGS, ASSET_THEME_HEX, ASSET_USER_DEFINED_TYPE, CERTIFICATE_STATUS, CERTIFICATE_STATUS_MESSAGE, CERTIFICATE_UPDATED_AT, CERTIFICATE_UPDATED_BY, CONNECTION_NAME, CONNECTION_QUALIFIED_NAME, CONNECTOR_NAME, CONNECTOR_TYPE, CUSTOM_CONNECTOR_TYPE, DATA_CONTRACT_LATEST, DATA_CONTRACT_LATEST_CERTIFIED, DBT_QUALIFIED_NAME, DESCRIPTION, DISPLAY_NAME, DOMAIN_GUIDS, DQ_BASE_DATASET_RULES, DQ_REFERENCE_DATASET_RULES, FILES, HAS_CONTRACT, HAS_LINEAGE, INPUT_PORT_DATA_PRODUCTS, IS_AI_GENERATED, IS_DISCOVERABLE, IS_EDITABLE, IS_PARTIAL, LAST_ROW_CHANGED_AT, LAST_SYNC_RUN, LAST_SYNC_RUN_AT, LAST_SYNC_WORKFLOW_NAME, LEXICOGRAPHICAL_SORT_ORDER, LINKS, MC_INCIDENTS, MC_MONITORS, METRICS, NAME, NON_COMPLIANT_ASSET_POLICY_GUIDS, OUTPUT_PORT_DATA_PRODUCTS, OUTPUT_PRODUCT_GUIDS, OWNER_GROUPS, OWNER_USERS, POPULARITY_SCORE, PRODUCT_GUIDS, QUALIFIED_NAME, README, SAMPLE_DATA_URL, SCHEMA_REGISTRY_SUBJECTS, SODA_CHECKS, SOURCE_COST_UNIT, SOURCE_CREATED_AT, SOURCE_CREATED_BY, SOURCE_EMBED_URL, SOURCE_LAST_READ_AT, SOURCE_OWNERS, SOURCE_QUERY_COMPUTE_COST_RECORDS, SOURCE_QUERY_COMPUTE_COSTS, SOURCE_READ_COUNT, SOURCE_READ_EXPENSIVE_QUERY_RECORDS, SOURCE_READ_POPULAR_QUERY_RECORDS, SOURCE_READ_QUERY_COST, SOURCE_READ_RECENT_USER_RECORDS, SOURCE_READ_RECENT_USERS, SOURCE_READ_SLOW_QUERY_RECORDS, SOURCE_READ_TOP_USER_RECORDS, SOURCE_READ_TOP_USERS, SOURCE_READ_USER_COUNT, SOURCE_TOTAL_COST, SOURCE_UPDATED_AT, SOURCE_UPDATED_BY, SOURCE_URL, STARRED_BY, STARRED_COUNT, STARRED_DETAILS, SUB_TYPE, TENANT_ID, USER_DEF_RELATIONSHIP_FROMS, USER_DEF_RELATIONSHIP_TOS, USER_DESCRIPTION, VIEW_SCORE, VIEWER_GROUPS, VIEWER_USERSFields inherited from interface com.atlan.model.assets.IGlossaryTerm
ABBREVIATION, ADDITIONAL_ATTRIBUTES, ANCHOR, ANTONYMS, ASSIGNED_ENTITIES, CATEGORIES, CLASSIFIES, EXAMPLES, IS_A, LONG_DESCRIPTION, PREFERRED_TERMS, PREFERRED_TO_TERMS, REPLACED_BY, REPLACEMENT_TERMS, SEE_ALSO, SHORT_DESCRIPTION, SYNONYMS, TERM_TYPE, TRANSLATED_TERMS, TRANSLATION_TERMS, USAGE, VALID_VALUES, VALID_VALUES_FORFields inherited from interface com.atlan.model.assets.IReferenceable
ASSIGNED_TERMS, ATLAN_TAGS, CREATE_TIME, CREATED_BY, CUSTOM_ATTRIBUTES, GUID, PROPAGATED_ATLAN_TAGS, STATUS, SUPER_TYPE_NAMES, UPDATE_TIME, UPDATED_BY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic GlossaryTerm.GlossaryTermBuilder<?, ?> static GlossaryTermappendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) Deprecated.static GlossaryTermappendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) protected booleanstatic GlossaryTerm.GlossaryTermBuilder<?, ?> Builds the minimal object necessary for creating a term.static GlossaryTerm.GlossaryTermBuilder<?, ?> Builds the minimal object necessary for creating a term.booleanstatic GlossaryTermfindByName(AtlanClient client, String name, String glossaryName) Find a GlossaryTerm by its human-readable name.static GlossaryTermfindByName(AtlanClient client, String name, String glossaryName, Collection<String> attributes) Find a GlossaryTerm by its human-readable name.static GlossaryTermfindByName(AtlanClient client, String name, String glossaryName, List<AtlanField> attributes) Find a GlossaryTerm by its human-readable name.static GlossaryTermfindByNameFast(AtlanClient client, String name, String glossaryQualifiedName) Find a GlossaryTerm by its human-readable name.static GlossaryTermfindByNameFast(AtlanClient client, String name, String glossaryQualifiedName, Collection<String> attributes) Find a GlossaryTerm by its human-readable name.static GlossaryTermfindByNameFast(AtlanClient client, String name, String glossaryQualifiedName, List<AtlanField> attributes) Find a GlossaryTerm by its human-readable name.static GlossaryTermget(AtlanClient client, String id) Retrieves a GlossaryTerm by one of its identifiers, complete with all of its relationships.static GlossaryTermget(AtlanClient client, String id, boolean includeAllRelationships) Retrieves a GlossaryTerm by one of its identifiers, optionally complete with all of its relationships.static GlossaryTermget(AtlanClient client, String id, Collection<AtlanField> attributes) Retrieves a GlossaryTerm by one of its identifiers, with only the requested attributes (and relationships).static GlossaryTermget(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated) Retrieves a GlossaryTerm by one of its identifiers, with only the requested attributes (and relationships).TBCTBCTBCTBCTBCTBCTBCTBCgetIsA()TBCTBCTBCTBCTBCTBCTBCTBCTBCTBCTBCTBCFixed typeName for GlossaryTerms.getUsage()TBCTBCTBCinthashCode()static GlossaryTermReference to a GlossaryTerm by GUID.static GlossaryTermrefByGuid(String guid, Reference.SaveSemantic semantic) Reference to a GlossaryTerm by GUID.static GlossaryTermrefByQualifiedName(String qualifiedName) Reference to a GlossaryTerm by qualifiedName.static GlossaryTermrefByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic) Reference to a GlossaryTerm by qualifiedName.static GlossaryTermremoveAnnouncement(AtlanClient client, String qualifiedName, String name, String glossaryGuid) Remove the announcement from a GlossaryTerm.static voidremoveAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) Deprecated.static GlossaryTermremoveCertificate(AtlanClient client, String qualifiedName, String name, String glossaryGuid) Remove the certificate from a GlossaryTerm.static GlossaryTermremoveDescription(AtlanClient client, String qualifiedName, String name, String glossaryGuid) Remove the system description from a GlossaryTerm.static GlossaryTermremoveOwners(AtlanClient client, String qualifiedName, String name, String glossaryGuid) Remove the owners from a GlossaryTerm.static GlossaryTermremoveUserDescription(AtlanClient client, String qualifiedName, String name, String glossaryGuid) Remove the user's description from a GlossaryTerm.static booleanrestore(AtlanClient client, String qualifiedName) Restore the archived (soft-deleted) GlossaryTerm to active.static FluentSearch.FluentSearchBuilder<?, ?> select(AtlanClient client) Start a fluent search that will return all GlossaryTerm assets.static FluentSearch.FluentSearchBuilder<?, ?> select(AtlanClient client, boolean includeArchived) Start a fluent search that will return all GlossaryTerm assets.toString()Builds the minimal object necessary to create a relationship to a GlossaryTerm, from a potentially more-complete GlossaryTerm object.Builds the minimal object necessary to apply an update to a GlossaryTerm, from a potentially more-complete GlossaryTerm object.static GlossaryTermupdateAnnouncement(AtlanClient client, String qualifiedName, String name, String glossaryGuid, AtlanAnnouncementType type, String title, String message) Update the announcement on a GlossaryTerm.static GlossaryTermupdateCertificate(AtlanClient client, String qualifiedName, String name, String glossaryGuid, CertificateStatus certificate, String message) Update the certificate on a GlossaryTerm.static GlossaryTerm.GlossaryTermBuilder<?, ?> Builds the minimal object necessary to update a GlossaryTerm.Methods inherited from class com.atlan.model.assets.Asset
addApiTokenAsAdmin, appendAtlanTags, appendAtlanTags, appendTerms, delete, get, getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetIcon, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getAtlanTagNames, getAtlanTags, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCreatedBy, getCreateTime, getCustomConnectorType, getCustomMetadata, getCustomMetadataSets, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDeleteHandler, getDepth, getDescription, getDisplayName, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getFiles, getHasContract, getHasLineage, getIconUrl, getImmediateDownstream, getImmediateUpstream, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsIncomplete, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMeaningNames, getMeanings, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getNullFields, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPendingTasks, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getStatus, getSubType, getTenantId, getUpdatedBy, getUpdateTime, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, lineage, lineage, purge, removeAnnouncement, removeAtlanTag, removeCertificate, removeCustomMetadata, removeDescription, removeOwners, removeTerms, removeUserDescription, replaceCustomMetadata, replaceTerms, requestLineage, restore, save, save, saveMergingCM, saveMergingCM, saveReplacingCM, saveReplacingCM, updateAnnouncement, updateAnnouncement, updateCertificate, updateCertificate, updateCustomMetadataAttributes, updateMergingCM, updateMergingCM, updateReplacingCM, updateReplacingCMMethods inherited from class com.atlan.model.relations.Reference
builder, by, compareTo, getCompleteObject, getCustomAttributes, getDisplayText, getEntityStatus, getGuid, getLabels, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSemantic, getUniqueAttributes, isComplete, isValidReference, isValidReferenceByGuid, isValidReferenceByQualifiedName, setCompleteObject, to, validateRelationship, validateRequiredMethods inherited from class com.atlan.model.core.AtlanObject
getRawJsonObject, setRawJsonObject, toJsonMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.atlan.model.search.AuditDetail
getRawJsonObject, setRawJsonObjectMethods inherited from interface com.atlan.model.assets.IAsset
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetIcon, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedNameMethods inherited from interface com.atlan.model.assets.IGlossaryTerm
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetIcon, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedNameMethods inherited from interface com.atlan.model.assets.IReferenceable
getAtlanTagNames, getAtlanTags, getCreatedBy, getCreateTime, getCustomMetadataSets, getDeleteHandler, getGuid, getIsIncomplete, getMeaningNames, getMeanings, getPendingTasks, getQualifiedName, getStatus, getUpdatedBy, getUpdateTime
-
Field Details
-
TYPE_NAME
- See Also:
-
-
Constructor Details
-
GlossaryTerm
-
-
Method Details
-
trimToReference
Builds the minimal object necessary to create a relationship to a GlossaryTerm, from a potentially more-complete GlossaryTerm object.- Overrides:
trimToReferencein classAsset- Returns:
- the minimal object necessary to relate to the GlossaryTerm
- Throws:
InvalidRequestException- if any of the minimal set of required properties for a GlossaryTerm relationship are not found in the initial object
-
select
Start a fluent search that will return all GlossaryTerm assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) GlossaryTerm assets will be included.- Parameters:
client- connectivity to the Atlan tenant from which to retrieve the assets- Returns:
- a fluent search that includes all GlossaryTerm assets
-
select
public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived) Start a fluent search that will return all GlossaryTerm assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.- Parameters:
client- connectivity to the Atlan tenant from which to retrieve the assetsincludeArchived- when true, archived (soft-deleted) GlossaryTerms will be included- Returns:
- a fluent search that includes all GlossaryTerm assets
-
refByGuid
Reference to a GlossaryTerm by GUID. Use this to create a relationship to this GlossaryTerm, where the relationship should be replaced.- Parameters:
guid- the GUID of the GlossaryTerm to reference- Returns:
- reference to a GlossaryTerm that can be used for defining a relationship to a GlossaryTerm
-
refByGuid
Reference to a GlossaryTerm by GUID. Use this to create a relationship to this GlossaryTerm, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).- Parameters:
guid- the GUID of the GlossaryTerm to referencesemantic- how to save this relationship (replace all with this, append it, or remove it)- Returns:
- reference to a GlossaryTerm that can be used for defining a relationship to a GlossaryTerm
-
refByQualifiedName
Reference to a GlossaryTerm by qualifiedName. Use this to create a relationship to this GlossaryTerm, where the relationship should be replaced.- Parameters:
qualifiedName- the qualifiedName of the GlossaryTerm to reference- Returns:
- reference to a GlossaryTerm that can be used for defining a relationship to a GlossaryTerm
-
refByQualifiedName
public static GlossaryTerm refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic) Reference to a GlossaryTerm by qualifiedName. Use this to create a relationship to this GlossaryTerm, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).- Parameters:
qualifiedName- the qualifiedName of the GlossaryTerm to referencesemantic- how to save this relationship (replace all with this, append it, or remove it)- Returns:
- reference to a GlossaryTerm that can be used for defining a relationship to a GlossaryTerm
-
get
Retrieves a GlossaryTerm by one of its identifiers, complete with all of its relationships.- Parameters:
client- connectivity to the Atlan tenant from which to retrieve the assetid- of the GlossaryTerm to retrieve, either its GUID or its full qualifiedName- Returns:
- the requested full GlossaryTerm, complete with all of its relationships
- Throws:
AtlanException- on any error during the API invocation, such as theNotFoundExceptionif the GlossaryTerm does not exist or the provided GUID is not a GlossaryTerm
-
get
public static GlossaryTerm get(AtlanClient client, String id, boolean includeAllRelationships) throws AtlanException Retrieves a GlossaryTerm by one of its identifiers, optionally complete with all of its relationships.- Parameters:
client- connectivity to the Atlan tenant from which to retrieve the assetid- of the GlossaryTerm to retrieve, either its GUID or its full qualifiedNameincludeAllRelationships- if true, all the asset's relationships will also be retrieved; if false, no relationships will be retrieved- Returns:
- the requested full GlossaryTerm, optionally complete with all of its relationships
- Throws:
AtlanException- on any error during the API invocation, such as theNotFoundExceptionif the GlossaryTerm does not exist or the provided GUID is not a GlossaryTerm
-
get
public static GlossaryTerm get(AtlanClient client, String id, Collection<AtlanField> attributes) throws AtlanException Retrieves a GlossaryTerm by one of its identifiers, with only the requested attributes (and relationships).- Parameters:
client- connectivity to the Atlan tenant from which to retrieve the assetid- of the GlossaryTerm to retrieve, either its GUID or its full qualifiedNameattributes- to retrieve for the GlossaryTerm, including any relationships- Returns:
- the requested GlossaryTerm, with only its minimal information and the requested attributes (and relationships)
- Throws:
AtlanException- on any error during the API invocation, such as theNotFoundExceptionif the GlossaryTerm does not exist or the provided GUID is not a GlossaryTerm
-
get
public static GlossaryTerm get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated) throws AtlanException Retrieves a GlossaryTerm by one of its identifiers, with only the requested attributes (and relationships).- Parameters:
client- connectivity to the Atlan tenant from which to retrieve the assetid- of the GlossaryTerm to retrieve, either its GUID or its full qualifiedNameattributes- to retrieve for the GlossaryTerm, including any relationshipsattributesOnRelated- to retrieve on each relationship retrieved for the GlossaryTerm- Returns:
- the requested GlossaryTerm, with only its minimal information and the requested attributes (and relationships)
- Throws:
AtlanException- on any error during the API invocation, such as theNotFoundExceptionif the GlossaryTerm does not exist or the provided GUID is not a GlossaryTerm
-
restore
Restore the archived (soft-deleted) GlossaryTerm to active.- Parameters:
client- connectivity to the Atlan tenant on which to restore the assetqualifiedName- for the GlossaryTerm- Returns:
- true if the GlossaryTerm is now active, and false otherwise
- Throws:
AtlanException- on any API problems
-
creator
public static GlossaryTerm.GlossaryTermBuilder<?,?> creator(String name, Glossary glossary) throws InvalidRequestException Builds the minimal object necessary for creating a term.- Parameters:
name- of the termglossary- in which the term should be created- Returns:
- the minimal request necessary to create the term, as a builder
- Throws:
InvalidRequestException- if the glossary provided is without a GUID or qualifiedName
-
creator
Builds the minimal object necessary for creating a term.- Parameters:
name- of the termglossaryId- unique identifier of the term's glossary, either is real GUID or qualifiedName- Returns:
- the minimal request necessary to create the term, as a builder
-
updater
public static GlossaryTerm.GlossaryTermBuilder<?,?> updater(String qualifiedName, String name, String glossaryGuid) Builds the minimal object necessary to update a GlossaryTerm.- Parameters:
qualifiedName- of the GlossaryTermname- of the GlossaryTermglossaryGuid- unique identifier of the GlossaryTerm's glossary- Returns:
- the minimal request necessary to update the GlossaryTerm, as a builder
-
trimToRequired
Builds the minimal object necessary to apply an update to a GlossaryTerm, from a potentially more-complete GlossaryTerm object.- Overrides:
trimToRequiredin classAsset- Returns:
- the minimal object necessary to update the GlossaryTerm, as a builder
- Throws:
InvalidRequestException- if any of the minimal set of required properties for GlossaryTerm are not found in the initial object
-
findByName
public static GlossaryTerm findByName(AtlanClient client, String name, String glossaryName) throws AtlanException Find a GlossaryTerm by its human-readable name. Only the bare minimum set of attributes and no relationships will be retrieved for the term, if found. Note that this operation must run two separate queries to first resolve the qualifiedName of the glossary, so will be somewhat slower. If you already have the qualifiedName of the glossary, use findByNameFast instead.- Parameters:
client- connectivity to the Atlan tenant in which to search for the GlossaryTermname- of the GlossaryTermglossaryName- human-readable name of the Glossary in which the category exists- Returns:
- the GlossaryTerm, if found
- Throws:
AtlanException- on any API problems, or if the GlossaryTerm does not exist
-
findByName
public static GlossaryTerm findByName(AtlanClient client, String name, String glossaryName, Collection<String> attributes) throws AtlanException Find a GlossaryTerm by its human-readable name. Note that this operation must run two separate queries to first resolve the qualifiedName of the glossary, so will be somewhat slower. If you already have the qualifiedName of the glossary, use findByNameFast instead.- Parameters:
client- connectivity to the Atlan tenant in which to search for the GlossaryTermname- of the GlossaryTermglossaryName- human-readable name of the Glossary in which the category existsattributes- an optional collection of attributes (unchecked) to retrieve for the GlossaryTerm- Returns:
- the GlossaryTerm, if found
- Throws:
AtlanException- on any API problems, or if the GlossaryTerm does not exist
-
findByName
public static GlossaryTerm findByName(AtlanClient client, String name, String glossaryName, List<AtlanField> attributes) throws AtlanException Find a GlossaryTerm by its human-readable name. Note that this operation must run two separate queries to first resolve the qualifiedName of the glossary, so will be somewhat slower. If you already have the qualifiedName of the glossary, use findByNameFast instead.- Parameters:
client- connectivity to the Atlan tenant in which to search for the GlossaryTermname- of the GlossaryTermglossaryName- human-readable name of the Glossary in which the category existsattributes- an optional collection of attributes (checked) to retrieve for the GlossaryTerm- Returns:
- the GlossaryTerm, if found
- Throws:
AtlanException- on any API problems, or if the GlossaryTerm does not exist
-
findByNameFast
public static GlossaryTerm findByNameFast(AtlanClient client, String name, String glossaryQualifiedName) throws AtlanException Find a GlossaryTerm by its human-readable name. Only the bare minimum set of attributes and no relationships will be retrieved for the term, if found.- Parameters:
client- connectivity to the Atlan tenant in which to search for the GlossaryTermname- of the GlossaryTermglossaryQualifiedName- qualifiedName of the Glossary in which the category exists- Returns:
- the GlossaryTerm, if found
- Throws:
AtlanException- on any API problems, or if the GlossaryTerm does not exist
-
findByNameFast
public static GlossaryTerm findByNameFast(AtlanClient client, String name, String glossaryQualifiedName, Collection<String> attributes) throws AtlanException Find a GlossaryTerm by its human-readable name.- Parameters:
client- connectivity to the Atlan tenant in which to search for the GlossaryTermname- of the GlossaryTermglossaryQualifiedName- qualifiedName of the Glossary in which the category existsattributes- an optional collection of attributes (unchecked) to retrieve for the GlossaryTerm- Returns:
- the GlossaryTerm, if found
- Throws:
AtlanException- on any API problems, or if the GlossaryTerm does not exist
-
findByNameFast
public static GlossaryTerm findByNameFast(AtlanClient client, String name, String glossaryQualifiedName, List<AtlanField> attributes) throws AtlanException Find a GlossaryTerm by its human-readable name.- Parameters:
client- connectivity to the Atlan tenant in which to search for the GlossaryTermname- of the GlossaryTermglossaryQualifiedName- qualifiedName of the Glossary in which the category existsattributes- an optional collection of attributes (checked) to retrieve for the GlossaryTerm- Returns:
- the GlossaryTerm, if found
- Throws:
AtlanException- on any API problems, or if the GlossaryTerm does not exist
-
removeDescription
public static GlossaryTerm removeDescription(AtlanClient client, String qualifiedName, String name, String glossaryGuid) throws AtlanException Remove the system description from a GlossaryTerm.- Parameters:
client- connectivity to the Atlan tenant from which to remove the GlossaryTerm's descriptionqualifiedName- of the GlossaryTermname- of the GlossaryTermglossaryGuid- unique ID (GUID) of the GlossaryTerm's glossary- Returns:
- the updated GlossaryTerm, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
removeUserDescription
public static GlossaryTerm removeUserDescription(AtlanClient client, String qualifiedName, String name, String glossaryGuid) throws AtlanException Remove the user's description from a GlossaryTerm.- Parameters:
client- connectivity to the Atlan tenant from which to remove the GlossaryTerm's descriptionqualifiedName- of the GlossaryTermname- of the GlossaryTermglossaryGuid- unique ID (GUID) of the GlossaryTerm's glossary- Returns:
- the updated GlossaryTerm, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
removeOwners
public static GlossaryTerm removeOwners(AtlanClient client, String qualifiedName, String name, String glossaryGuid) throws AtlanException Remove the owners from a GlossaryTerm.- Parameters:
client- connectivity to the Atlan tenant from which to remove the GlossaryTerm's ownersqualifiedName- of the GlossaryTermname- of the GlossaryTermglossaryGuid- unique ID (GUID) of the GlossaryTerm's glossary- Returns:
- the updated GlossaryTerm, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
updateCertificate
public static GlossaryTerm updateCertificate(AtlanClient client, String qualifiedName, String name, String glossaryGuid, CertificateStatus certificate, String message) throws AtlanException Update the certificate on a GlossaryTerm.- Parameters:
client- connectivity to the Atlan tenant on which to update the GlossaryTerm's certificatequalifiedName- of the GlossaryTermname- of the GlossaryTermglossaryGuid- unique ID (GUID) of the GlossaryTerm's glossarycertificate- to usemessage- (optional) message, or null if no message- Returns:
- the updated GlossaryTerm, or null if the update failed
- Throws:
AtlanException- on any API problems
-
removeCertificate
public static GlossaryTerm removeCertificate(AtlanClient client, String qualifiedName, String name, String glossaryGuid) throws AtlanException Remove the certificate from a GlossaryTerm.- Parameters:
client- connectivity to the Atlan tenant from which to remove the GlossaryTerm's certificatequalifiedName- of the GlossaryTermname- of the GlossaryTermglossaryGuid- unique ID (GUID) of the GlossaryTerm's glossary- Returns:
- the updated GlossaryTerm, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
updateAnnouncement
public static GlossaryTerm updateAnnouncement(AtlanClient client, String qualifiedName, String name, String glossaryGuid, AtlanAnnouncementType type, String title, String message) throws AtlanException Update the announcement on a GlossaryTerm.- Parameters:
client- connectivity to the Atlan tenant on which to update the GlossaryTerm's announcementqualifiedName- of the GlossaryTermname- of the GlossaryTermglossaryGuid- unique ID (GUID) of the GlossaryTerm's glossarytype- type of announcement to settitle- (optional) title of the announcement to set (or null for no title)message- (optional) message of the announcement to set (or null for no message)- Returns:
- the updated GlossaryTerm, or null if the update failed
- Throws:
AtlanException- on any API problems
-
removeAnnouncement
public static GlossaryTerm removeAnnouncement(AtlanClient client, String qualifiedName, String name, String glossaryGuid) throws AtlanException Remove the announcement from a GlossaryTerm.- Parameters:
client- connectivity to the Atlan tenant from which to remove the GlossaryTerm's announcementqualifiedName- of the GlossaryTermname- of the GlossaryTermglossaryGuid- unique ID (GUID) of the GlossaryTerm's glossary- Returns:
- the updated GlossaryTerm, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
appendAtlanTags
@Deprecated public static GlossaryTerm appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException Deprecated.Add Atlan tags to a GlossaryTerm, without replacing existing Atlan tags linked to the GlossaryTerm. Note: this operation must make two API calls — one to retrieve the GlossaryTerm's existing Atlan tags, and a second to append the new Atlan tags.- Parameters:
client- connectivity to the Atlan tenant on which to append Atlan tags to the GlossaryTermqualifiedName- of the GlossaryTermatlanTagNames- human-readable names of the Atlan tags to add- Returns:
- the updated GlossaryTerm
- Throws:
AtlanException- on any API problems
-
appendAtlanTags
@Deprecated public static GlossaryTerm appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException Add Atlan tags to a GlossaryTerm, without replacing existing Atlan tags linked to the GlossaryTerm. Note: this operation must make two API calls — one to retrieve the GlossaryTerm's existing Atlan tags, and a second to append the new Atlan tags.- Parameters:
client- connectivity to the Atlan tenant on which to append Atlan tags to the GlossaryTermqualifiedName- of the GlossaryTermatlanTagNames- human-readable names of the Atlan tags to addpropagate- whether to propagate the Atlan tag (true) or not (false)removePropagationsOnDelete- whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)restrictLineagePropagation- whether to avoid propagating through lineage (true) or do propagate through lineage (false)- Returns:
- the updated GlossaryTerm
- Throws:
AtlanException- on any API problems
-
removeAtlanTag
@Deprecated public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException Deprecated.Remove an Atlan tag from a GlossaryTerm.- Parameters:
client- connectivity to the Atlan tenant from which to remove an Atlan tag from a GlossaryTermqualifiedName- of the GlossaryTermatlanTagName- human-readable name of the Atlan tag to remove- Throws:
AtlanException- on any API problems, or if the Atlan tag does not exist on the GlossaryTerm
-
_internal
-
toBuilder
-
getAbbreviation
TBC- Specified by:
getAbbreviationin interfaceIGlossaryTerm
-
getAdditionalAttributes
TBC- Specified by:
getAdditionalAttributesin interfaceIGlossaryTerm
-
getAnchor
TBC- Specified by:
getAnchorin interfaceIGlossaryTerm
-
getAntonyms
TBC- Specified by:
getAntonymsin interfaceIGlossaryTerm
-
getAssignedEntities
TBC- Specified by:
getAssignedEntitiesin interfaceIGlossaryTerm
-
getCategories
TBC- Specified by:
getCategoriesin interfaceIGlossaryTerm
-
getClassifies
TBC- Specified by:
getClassifiesin interfaceIGlossaryTerm
-
getExamples
TBC- Specified by:
getExamplesin interfaceIGlossaryTerm
-
getIsA
TBC- Specified by:
getIsAin interfaceIGlossaryTerm
-
getLongDescription
TBC- Specified by:
getLongDescriptionin interfaceIGlossaryTerm
-
getPreferredTerms
TBC- Specified by:
getPreferredTermsin interfaceIGlossaryTerm
-
getPreferredToTerms
TBC- Specified by:
getPreferredToTermsin interfaceIGlossaryTerm
-
getReplacedBy
TBC- Specified by:
getReplacedByin interfaceIGlossaryTerm
-
getReplacementTerms
TBC- Specified by:
getReplacementTermsin interfaceIGlossaryTerm
-
getSeeAlso
TBC- Specified by:
getSeeAlsoin interfaceIGlossaryTerm
-
getShortDescription
TBC- Specified by:
getShortDescriptionin interfaceIGlossaryTerm
-
getSynonyms
TBC- Specified by:
getSynonymsin interfaceIGlossaryTerm
-
getTermType
TBC- Specified by:
getTermTypein interfaceIGlossaryTerm
-
getTranslatedTerms
TBC- Specified by:
getTranslatedTermsin interfaceIGlossaryTerm
-
getTranslationTerms
TBC- Specified by:
getTranslationTermsin interfaceIGlossaryTerm
-
getUsage
TBC- Specified by:
getUsagein interfaceIGlossaryTerm
-
getValidValues
TBC- Specified by:
getValidValuesin interfaceIGlossaryTerm
-
getValidValuesFor
TBC- Specified by:
getValidValuesForin interfaceIGlossaryTerm
-
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
Description copied from class:AtlanObject -
getTypeName
Fixed typeName for GlossaryTerms.- Specified by:
getTypeNamein interfaceAuditDetail- Specified by:
getTypeNamein interfaceIAsset- Specified by:
getTypeNamein interfaceIGlossaryTerm- Specified by:
getTypeNamein interfaceIReferenceable- Overrides:
getTypeNamein classReference
-
Asset.AssetBuilder.appendAtlanTags(List)