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:

• the add asset resources / links snippets
• the manage file assets pattern

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

Type-specific properties

Following are the properties uniquely available on Resource assets in Atlan.

Java Python Raw REST API

isGlobal

builder.isGlobal(true); // (1)
resource.getIsGlobal(); // (2)
client.assets.select().where(Resource.IS_GLOBAL.eq(true)); // (3)

1. Set the isGlobal for a Resource.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the isGlobal from a Resource.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. Find all assets in Atlan with their isGlobal exactly matching the provided value.

   For more details

   For more information, see the searching section on term queries.

link

builder.link("String0"); // (1)
resource.getLink(); // (2)
client.assets.select().where(Resource.LINK.eq("String0")); // (3)

1. Set the link for a Resource.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the link from a Resource.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. Find all assets in Atlan with their link exactly matching the provided value.

   For more details

   For more information, see the searching section on term queries.

reference

builder.reference("String0"); // (1)
resource.getReference(); // (2)
client.assets.select().where(Resource.REFERENCE.eq("String0")); // (3)

1. Set the reference for a Resource.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the reference from a Resource.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. Find all assets in Atlan with their reference exactly matching the provided value.

   For more details

   For more information, see the searching section on term queries.

resourceMetadata

builder // (1)
    .putResourceMetadata("key1", "value1")
    .putResourceMetadata("key2", "value2");
resource.getResourceMetadata(); // (2)
client.assets.select().where(Resource.RESOURCE_METADATA.eq("key1", "value1")); // (3)

1. Set the resourceMetadata for a Resource.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the resourceMetadata from a Resource.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. Find all assets in Atlan with their resourceMetadata exactly matching the provided value.

   For more details

   For more information, see the searching section on term queries.

is_global

builder.is_global = ...  # (1)
resource.is_global  # (2)
FluentSearch().where(FluentSearch.asset_type(Resource)).where(Resource.IS_GLOBAL.eq(True))  # (3)

1. Set the is_global for a Resource.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the is_global from a Resource.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. Find all assets in Atlan with their is_global exactly matching the provided value.

   For more details

   For more information, see the searching section on term queries.

link

builder.link = ...  # (1)
resource.link  # (2)
FluentSearch().where(FluentSearch.asset_type(Resource)).where(Resource.LINK.eq("String0"))  # (3)

1. Set the link for a Resource.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the link from a Resource.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. Find all assets in Atlan with their link exactly matching the provided value.

   For more details

   For more information, see the searching section on term queries.

reference

builder.reference = ...  # (1)
resource.reference  # (2)
FluentSearch().where(FluentSearch.asset_type(Resource)).where(Resource.REFERENCE.eq("String0"))  # (3)

1. Set the reference for a Resource.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the reference from a Resource.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. Find all assets in Atlan with their reference exactly matching the provided value.

   For more details

   For more information, see the searching section on term queries.

resource_metadata

builder.resource_metadata = {...}  # (1)
resource.resource_metadata  # (2)
FluentSearch().where(FluentSearch.asset_type(Resource)).where(Resource.RESOURCE_METADATA.eq("String0"))  # (3)

1. Set the resource_metadata for a Resource.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the resource_metadata from a Resource.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. Find all assets in Atlan with their resource_metadata exactly matching the provided value.

   For more details

   For more information, see the searching section on term queries.

isGlobal

{
  "attributes": {
    "isGlobal": true // (1)
  }
}

1. Set the isGlobal for a Resource.

   For more details

   For more information, see the asset CRUD snippets.

link

{
  "attributes": {
    "link": "String0" // (1)
  }
}

1. Set the link for a Resource.

   For more details

   For more information, see the asset CRUD snippets.

reference

{
  "attributes": {
    "reference": "String0" // (1)
  }
}

1. Set the reference for a Resource.

   For more details

   For more information, see the asset CRUD snippets.

resourceMetadata

{
  "attributes": {
    "resourceMetadata": [ // (1)
      {"key1", "value1"},
      {"key2", "value2"}
    ]
  }
}

1. Set the resourceMetadata for a Resource.

   For more details

   For more information, see the asset CRUD snippets.

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