Skip to content

Glossary

AtlasGlossary

pyatlan.model.assets.core.atlas_glossary.AtlasGlossary(__pydantic_self__, **data: Any)

Bases: Asset

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

ADDITIONAL_ATTRIBUTES: KeywordField = KeywordField('additionalAttributes', 'additionalAttributes') class-attribute

Unused. Arbitrary set of additional attributes associated with this glossary.

CATEGORIES: RelationField = RelationField('categories') class-attribute

TBC

GLOSSARY_TYPE: KeywordField = KeywordField('glossaryType', 'glossaryType') class-attribute

LANGUAGE: TextField = TextField('language', 'language') class-attribute

Unused. Language of the glossary's contents.

LONG_DESCRIPTION: TextField = TextField('longDescription', 'longDescription') class-attribute

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

SHORT_DESCRIPTION: TextField = TextField('shortDescription', 'shortDescription') class-attribute

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

TERMS: RelationField = RelationField('terms') class-attribute

TBC

USAGE: TextField = TextField('usage', 'usage') class-attribute

Unused. Inteded usage for the glossary.

AtlasGlossaryCategory

pyatlan.model.assets.core.atlas_glossary_category.AtlasGlossaryCategory(__pydantic_self__, **data: Any)

Bases: Asset

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

ADDITIONAL_ATTRIBUTES: KeywordField = KeywordField('additionalAttributes', 'additionalAttributes') class-attribute

Unused. Arbitrary set of additional attributes associated with the category.

ANCHOR: KeywordField = KeywordField('anchor', '__glossary') class-attribute

Glossary in which the category is contained, searchable by the qualifiedName of the glossary.

CATEGORY_TYPE: KeywordField = KeywordField('categoryType', 'categoryType') class-attribute

CHILDREN_CATEGORIES: RelationField = RelationField('childrenCategories') class-attribute

TBC

LONG_DESCRIPTION: TextField = TextField('longDescription', 'longDescription') class-attribute

Unused. Detailed description of the category. See 'readme' instead.

PARENT_CATEGORY: KeywordField = KeywordField('parentCategory', '__parentCategory') class-attribute

Parent category in which a subcategory is contained, searchable by the qualifiedName of the category.

SHORT_DESCRIPTION: TextField = TextField('shortDescription', 'shortDescription') class-attribute

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

TERMS: RelationField = RelationField('terms') class-attribute

TBC

Functions

can_be_archived() -> bool classmethod

Indicates if an asset can be archived via the asset.delete_by_guid method. :returns: True if archiving is supported

Source code in pyatlan/model/assets/core/atlas_glossary_category.py 
27
28
29
30
31
32
33
@classmethod
def can_be_archived(self) -> bool:
    """
    Indicates if an asset can be archived via the asset.delete_by_guid method.
    :returns: True if archiving is supported
    """
    return False

AtlasGlossaryTerm

pyatlan.model.assets.core.atlas_glossary_term.AtlasGlossaryTerm(__pydantic_self__, **data: Any)

Bases: Asset

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

ABBREVIATION: TextField = TextField('abbreviation', 'abbreviation') class-attribute

Unused. Abbreviation of the term.

ADDITIONAL_ATTRIBUTES: KeywordField = KeywordField('additionalAttributes', 'additionalAttributes') class-attribute

Unused. Arbitrary set of additional attributes for the terrm.

ANCHOR: KeywordField = KeywordField('anchor', '__glossary') class-attribute

Glossary in which the term is contained, searchable by the qualifiedName of the glossary.

ANTONYMS: RelationField = RelationField('antonyms') class-attribute

TBC

ASSIGNED_ENTITIES: RelationField = RelationField('assignedEntities') class-attribute

TBC

CATEGORIES: KeywordField = KeywordField('categories', '__categories') class-attribute

Categories in which the term is organized, searchable by the qualifiedName of the category.

CLASSIFIES: RelationField = RelationField('classifies') class-attribute

TBC

EXAMPLES: TextField = TextField('examples', 'examples') class-attribute

Unused. Exmaples of the term.

IS_A: RelationField = RelationField('isA') class-attribute

TBC

LONG_DESCRIPTION: TextField = TextField('longDescription', 'longDescription') class-attribute

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

PREFERRED_TERMS: RelationField = RelationField('preferredTerms') class-attribute

TBC

PREFERRED_TO_TERMS: RelationField = RelationField('preferredToTerms') class-attribute

TBC

REPLACED_BY: RelationField = RelationField('replacedBy') class-attribute

TBC

REPLACEMENT_TERMS: RelationField = RelationField('replacementTerms') class-attribute

TBC

SEE_ALSO: RelationField = RelationField('seeAlso') class-attribute

TBC

SHORT_DESCRIPTION: TextField = TextField('shortDescription', 'shortDescription') class-attribute

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

SYNONYMS: RelationField = RelationField('synonyms') class-attribute

TBC

TERM_TYPE: KeywordField = KeywordField('termType', 'termType') class-attribute

TRANSLATED_TERMS: RelationField = RelationField('translatedTerms') class-attribute

TBC

TRANSLATION_TERMS: RelationField = RelationField('translationTerms') class-attribute

TBC

USAGE: TextField = TextField('usage', 'usage') class-attribute

Unused. Intended usage for the term.

VALID_VALUES: RelationField = RelationField('validValues') class-attribute

TBC

VALID_VALUES_FOR: RelationField = RelationField('validValuesFor') class-attribute

TBC