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
Type-specific properties¶
Following are the properties uniquely available on Resource
assets in Atlan.
isGlobal
TBC | |
---|---|
1 2 3 |
|
-
Set the
isGlobal
for aResource
. -
Retrieve the
isGlobal
from aResource
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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
TBC | |
---|---|
1 2 3 |
|
-
Set the
link
for aResource
. -
Retrieve the
link
from aResource
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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
TBC | |
---|---|
1 2 3 |
|
-
Set the
reference
for aResource
. -
Retrieve the
reference
from aResource
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
resourceMetadata
for aResource
. -
Retrieve the
resourceMetadata
from aResource
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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
TBC | |
---|---|
1 2 3 |
|
-
Set the
is_global
for aResource
. -
Retrieve the
is_global
from aResource
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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
TBC | |
---|---|
1 2 3 |
|
-
Set the
link
for aResource
. -
Retrieve the
link
from aResource
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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
TBC | |
---|---|
1 2 3 |
|
-
Set the
reference
for aResource
. -
Retrieve the
reference
from aResource
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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
TBC | |
---|---|
1 2 3 |
|
-
Set the
resource_metadata
for aResource
. -
Retrieve the
resource_metadata
from aResource
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
isGlobal
for aResource
.For more details
For more information, see the asset CRUD snippets.
link
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
link
for aResource
.For more details
For more information, see the asset CRUD snippets.
reference
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
reference
for aResource
.For more details
For more information, see the asset CRUD snippets.
resourceMetadata
TBC | |
---|---|
1 2 3 4 5 6 7 8 |
|
-
Set the
resourceMetadata
for aResource
.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