Skip to content

Resources model

These are the model elements in Atlan related to resources — covering things like links and files.

Reference documentation

This is reference documentation covering the entire Atlan model. It is not the best place to start when trying to understand how to manage resources in Atlan. For that, we would suggest starting with either:

classDiagram
    direction RL
    class Resource {
        <<abstract>>
    }
    link Resource "../resource"
    class Catalog {
        <<abstract>>
    }
    link Catalog "../entities/catalog"
    Catalog <|-- Resource : extends
    class Asset {
        <<abstract>>
    }
    link Asset "../entities/asset"
    Asset <|-- Catalog : extends
    class Referenceable {
        <<abstract>>
    }
    link Referenceable "../entities/referenceable"
    Referenceable <|-- Asset : extends
    class ReadmeTemplate
    link ReadmeTemplate "../entities/readmetemplate"
    Resource <|-- ReadmeTemplate : extends
    class Readme
    link Readme "../entities/readme"
    Resource <|-- Readme : extends
    class File
    link File "../entities/file"
    Resource <|-- File : extends
    class Link
    link Link "../entities/link"
    Resource <|-- Link : extends
    class Badge
    link Badge "../entities/badge"
    Asset <|-- Badge : extends

Properties

These attributes are specific to instances of Resource (and all of its subtypes).

isGlobal

Whether the resource is global (true) or not (false).

URL to the resource.

reference

Reference to the resource.

resourceMetadata

Metadata of the resource.

Relationships

The following illustrates how the various pieces of resources inter-relate with each other:

erDiagram
    Asset ||--o| Readme : readme
    Asset |o--o{ File : files
    Asset ||--o{ Link : links