Referenceable¶
Base class for everything in Atlan.
Complete reference
This is a complete reference for the Referenceable
object in Atlan, showing every possible property and relationship that can exist for these objects. For an introduction, you probably want to start with:
Inheritance¶
Following is the inheritance structure for Referenceable
. The type structure may be simplified in some of the SDKs, but for search purposes you could still use any of the super types shown below.
classDiagram
direction RL
class Referenceable {
<<abstract>>
}
link Referenceable "../entities/referenceable"
Attributes¶
Following are all the properties available on Referenceable
assets in Atlan.
Core properties¶
As the root of all objects, Referenceable
defines the core properties available on everything in Atlan. For detailed examples of searching these fields, see common search fields.
typeName
Type of this asset. | |
---|---|
1 2 3 4 |
|
-
Retrieve the
typeName
from an asset.Use instanceof for type checking
If you are operating on an
Asset
type, chances are it is actually a more concrete type. Rather than using String-based comparisons, you can type-check using Java types:if (asset instanceof Column)
, for example. This has the added benefit of not needing separate null handling (if null, thenasset
cannot be aninstanceof
any type). -
Query for all assets that are sub-types of a particular super-type, in this example all assets that are sub-types of
SQL
. - Query for all assets with a particular type, in this example a
Table
. - Query for all assets with any one of a number of different types, in this example either a
Table
,View
, orMaterializedView
.
guid
Treat as read-only
This should be treated as read-only, you should not try to set guid
on an asset.
Globally-unique identifier for this asset. | |
---|---|
1 2 |
|
-
Retrieve the
guid
from an asset.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Query for an asset with an exact GUID.
For more details
For more information, see the searching section on term queries.
atlanTags
Atlan tags assigned to the asset. | |
---|---|
1 2 3 4 5 |
|
-
Add Atlan tags to an asset.
For more details
For more information, see the tagging assets snippets.
-
Retrieve the
atlanTags
from an asset.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Query for assets that have one or more particular Atlan tags.
For more details
For more information, see the find assets with a tag snippets.
customMetadataSets
Map of custom metadata attributes and values defined on the asset. | |
---|---|
1 2 3 4 5 6 7 8 9 10 |
|
-
Add custom metadata to an asset.
For more details
For more information, see the change custom metadata snippets.
-
Retrieve custom metadata from an asset.
For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Query for assets that have particular custom metadata.
For more details
For more information, see the find assets with custom metadata snippets.
status
Treat as read-only
This should be treated as read-only, you should not try to set status
on an asset. Instead, see the asset CRUD snippets on deleting and restoring assets.
Status of the asset. | |
---|---|
1 2 |
|
-
Retrieve the
status
from an asset.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Query for assets that have a particular status.
For more details
For more information, see the common search fields snippets.
createdBy
Treat as read-only
This should be treated as read-only, you should not try to set createdBy
on an asset.
User or account that created the asset. | |
---|---|
1 2 |
|
-
Retrieve the
createdBy
user from an asset.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Query for assets that were created by a particular user.
For more details
For more information, see the common search fields snippets.
updatedBy
Treat as read-only
This should be treated as read-only, you should not try to set updatedBy
on an asset.
User or account that last updated the asset. | |
---|---|
1 2 |
|
-
Retrieve the
updatedBy
user from an asset.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Query for assets that were last updated by a particular user.
For more details
For more information, see the common search fields snippets.
createTime
Treat as read-only
This should be treated as read-only, you should not try to set createTime
on an asset.
Time (epoch) at which the asset was created, in milliseconds. | |
---|---|
1 2 |
|
-
Retrieve the
createTime
from an asset.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Query for assets that were created on or after a particular time.
For more details
For more information, see the common search fields snippets.
updateTime
Treat as read-only
This should be treated as read-only, you should not try to set updateTime
on an asset.
Time (epoch) at which the asset was last updated, in milliseconds. | |
---|---|
1 2 |
|
-
Retrieve the
updateTime
from an asset.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Query for assets that were last updated on or after a particular time.
For more details
For more information, see the common search fields snippets.
deleteHandler
Treat as read-only
This should be treated as read-only, you should not try to set deleteHandler
on an asset. Instead, see the asset CRUD snippets on deleting assets.
Details on the handler used for deletion of the asset. | |
---|---|
1 |
|
-
Retrieve the
deleteHandler
from an asset. (This will only have a value for soft-deleted, or archived, assets.)For more details
For more information, see the asset CRUD snippets on retrieving assets.
atlanTagNames
Treat as read-only
These should be treated as read-only, you should not try to set atlanTagNames
on an asset. Instead see atlanTags
.
Human-readable names of the Atlan tags that exist on the asset. | |
---|---|
1 |
|
-
Retrieve the
atlanTagNames
from an asset.For more details
For more information, see the asset CRUD snippets on retrieving assets.
isIncomplete (unused)
meaningNames
Treat as read-only
These should be treated as read-only, you should not try to set meaningNames
on an asset. Instead see meanings
.
Human-readable names of terms that have been linked to this asset. | |
---|---|
1 |
|
-
Retrieve the
meaningNames
from an asset.For more details
For more information, see the asset CRUD snippets on retrieving assets.
meanings
Treat as read-only
These should be treated as read-only, you should not try to set meanings
on an asset. Instead, see the link terms and assets snippets.
Details of terms that have been linked to this asset. | |
---|---|
1 |
|
-
Retrieve the
meanings
from an asset.For more details
For more information, see the asset CRUD snippets on retrieving assets.
pendingTasks
Treat as read-only
These should be treated as read-only, you should not try to set pendingTasks
on an asset.
Unique identifiers (GUIDs) for any background tasks that are yet to operate on this asset. | |
---|---|
1 |
|
-
Retrieve the
pendingTasks
from an asset.For more details
For more information, see the asset CRUD snippets on retrieving assets.
type_name
asset.type_name # (1)
FluentSearch().where(CompoundQuery.super_types([SQL])) # (2)
FluentSearch().where(CompoundQuery.asset_type(Table)) # (3)
FluentSearch().where(CompoundQuery.asset_types([Table, View, MaterializedView])) # (4)
-
Retrieve the
type_name
from an asset.Use isinstance for type checking
If you are operating on an
Asset
type, chances are it is actually a more concrete type. Rather than using String-based comparisons, you can type-check using Python types:if isinstance(asset, Column)
, for example. -
Query for all assets that are sub-types of a particular super-type, in this example all assets that are sub-types of
SQL
. - Query for all assets with a particular type, in this example a
Table
. - Query for all assets with any one of a number of different types, in this example either a
Table
,View
, orMaterializedView
.
guid
Treat as read-only
This should be treated as read-only, you should not try to set guid
on an asset.
Globally-unique identifier for this asset. | |
---|---|
1 2 |
|
-
Retrieve the
guid
from an asset.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Query for an asset with an exact GUID.
For more details
For more information, see the searching section on term queries.
atlan_tags
Atlan tags assigned to the asset. | |
---|---|
1 2 3 4 5 6 7 |
|
-
Add Atlan tags to an asset.
For more details
For more information, see the tagging assets snippets.
-
Retrieve the
atlan_tags
from an asset.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Query for assets that have one or more particular Atlan tags.
For more details
For more information, see the find assets with a tag snippets.
custom_metadata
Map of custom metadata attributes and values defined on the asset. | |
---|---|
1 2 3 4 5 6 7 8 9 |
|
-
Add custom metadata to an asset.
For more details
For more information, see the change custom metadata snippets.
-
Retrieve custom metadata from an asset.
For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Query for assets that have particular custom metadata.
For more details
For more information, see the find assets with custom metadata snippets.
status
Treat as read-only
This should be treated as read-only, you should not try to set status
on an asset. Instead, see the asset CRUD snippets on deleting and restoring assets.
Status of the asset. | |
---|---|
1 2 |
|
-
Retrieve the
status
from an asset.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Query for assets that have a particular status.
For more details
For more information, see the common search fields snippets.
created_by
Treat as read-only
This should be treated as read-only, you should not try to set created_by
on an asset.
User or account that created the asset. | |
---|---|
1 2 |
|
-
Retrieve the
created_by
user from an asset.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Query for assets that were created by a particular user.
For more details
For more information, see the common search fields snippets.
updated_by
Treat as read-only
This should be treated as read-only, you should not try to set updated_by
on an asset.
User or account that last updated the asset. | |
---|---|
1 2 |
|
-
Retrieve the
updated_by
user from an asset.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Query for assets that were last updated by a particular user.
For more details
For more information, see the common search fields snippets.
create_time
Treat as read-only
This should be treated as read-only, you should not try to set create_time
on an asset.
Time (epoch) at which the asset was created, in milliseconds. | |
---|---|
1 2 |
|
-
Retrieve the
create_time
from an asset.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Query for assets that were created on or after a particular time.
For more details
For more information, see the common search fields snippets.
update_time
Treat as read-only
This should be treated as read-only, you should not try to set update_time
on an asset.
Time (epoch) at which the asset was last updated, in milliseconds. | |
---|---|
1 2 |
|
-
Retrieve the
update_time
from an asset.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Query for assets that were last updated on or after a particular time.
For more details
For more information, see the common search fields snippets.
delete_handler
Treat as read-only
This should be treated as read-only, you should not try to set delete_handler
on an asset. Instead, see the asset CRUD snippets on deleting assets.
Details on the handler used for deletion of the asset. | |
---|---|
1 |
|
-
Retrieve the
delete_handler
from an asset. (This will only have a value for soft-deleted, or archived, assets.)For more details
For more information, see the asset CRUD snippets on retrieving assets.
classification_names
Treat as read-only
These should be treated as read-only, you should not try to set classification_names
on an asset. Instead see atlan_tags
.
Human-readable names of the Atlan tags that exist on the asset. | |
---|---|
1 |
|
-
Retrieve the
classification_names
from an asset.For more details
For more information, see the asset CRUD snippets on retrieving assets.
is_incomplete (unused)
meaning_names
Treat as read-only
These should be treated as read-only, you should not try to set meaning_names
on an asset. Instead see meanings
.
Human-readable names of terms that have been linked to this asset. | |
---|---|
1 |
|
-
Retrieve the
meaning_names
from an asset.For more details
For more information, see the asset CRUD snippets on retrieving assets.
meanings
Treat as read-only
These should be treated as read-only, you should not try to set meanings
on an asset. Instead, see the link terms and assets snippets.
Details of terms that have been linked to this asset. | |
---|---|
1 |
|
-
Retrieve the
meanings
from an asset.For more details
For more information, see the asset CRUD snippets on retrieving assets.
pending_tasks
Treat as read-only
These should be treated as read-only, you should not try to set pending_tasks
on an asset.
Unique identifiers (GUIDs) for any background tasks that are yet to operate on this asset. | |
---|---|
1 |
|
-
Retrieve the
pending_tasks
from an asset.For more details
For more information, see the asset CRUD snippets on retrieving assets.
typeName
{
"typeName": "Referenceable" // (1)
}
- The
typeName
of an asset is at the top-level of the payload, and in this example indicates aReferenceable
.
guid
Treat as read-only
This should be treated as read-only, you should not try to set guid
on an asset.
Globally-unique identifier for this asset. | |
---|---|
1 2 3 |
|
- The
guid
of an the asset is at the top-level of the payload.
classifications
Classifications assigned to the asset. | |
---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
|
-
The
classifications
of an asset are at the top-level of the payload. There is a list of such complex objects.For more details
For more information, see the classify assets snippets.
customMetadataSets
Map of custom metadata attributes and values defined on the asset. | |
---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
|
-
The custom metadata for an asset is nested within a
businessAttributes
object embedded in the payload. There is a nested dictionary of further embedded objects.For more details
For more information, see the change custom metadata snippets.
status
Treat as read-only
This should be treated as read-only, you should not try to set status
on an asset. Instead, see the asset CRUD snippets on deleting and restoring assets.
Status of the asset. | |
---|---|
1 2 3 |
|
- The
status
of an asset is at the top-level of the payload.
createdBy
Treat as read-only
This should be treated as read-only, you should not try to set createdBy
on an asset.
User or account that created the asset. | |
---|---|
1 2 3 |
|
- The
createdBy
user of an asset is at the top-level of the payload.
updatedBy
Treat as read-only
This should be treated as read-only, you should not try to set updatedBy
on an asset.
User or account that last updated the asset. | |
---|---|
1 2 3 |
|
- The
updatedBy
user of an asset is at the top-level of the payload.
createTime
Treat as read-only
This should be treated as read-only, you should not try to set createTime
on an asset.
Time (epoch) at which the asset was created, in milliseconds. | |
---|---|
1 2 3 |
|
- The
createTime
of an asset is at the top-level of the payload.
updateTime
Treat as read-only
This should be treated as read-only, you should not try to set updateTime
on an asset.
Time (epoch) at which the asset was last updated, in milliseconds. | |
---|---|
1 2 3 |
|
- The
updateTime
of an asset is at the top-level of the payload.
deleteHandler
Treat as read-only
This should be treated as read-only, you should not try to set deleteHandler
on an asset. Instead, see the asset CRUD snippets on deleting assets.
Details on the handler used for deletion of the asset. | |
---|---|
1 2 3 |
|
- The
deleteHandler
of an asset is at the top-level of the payload. (This will only have a value for soft-deleted, or archived, assets.)
classificationNames
Treat as read-only
These should be treated as read-only, you should not try to set classificationNames
on an asset. Instead see classifications
.
{
"classificationNames": ["yQBDoKHdTLJhqAsdR3RMq6", "WCVjmgKnW40G151dESXZ03"] // (1)
}
- The
classificationNames
of an asset are at the top-level of the payload. These are a list of the Atlan-internal hashed-string names.
isIncomplete (unused)
meaningNames
Treat as read-only
These should be treated as read-only, you should not try to set meaningNames
on an asset. Instead see meanings
.
Human-readable names of terms that have been linked to this asset. | |
---|---|
1 2 3 |
|
- The
meaningNames
of an asset are at the top-level of the payload.
meanings
Treat as read-only
These should be treated as read-only, you should not try to set meanings
on an asset. Instead, see the link terms and assets snippets.
Details of terms that have been linked to this asset. | |
---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
|
- The
meanings
of an asset are at the top-level of the payload. There is a list of such complex objects.
pendingTasks
Treat as read-only
These should be treated as read-only, you should not try to set pendingTasks
on an asset.
Unique identifiers (GUIDs) for any background tasks that are yet to operate on this asset. | |
---|---|
1 2 3 |
|
- The
pendingTasks
of an asset are at the top-level of the payload.
Type-specific properties¶
qualifiedName
asset.getQualifiedName(); // (1)
- Retrieve the
qualifiedName
from aReferenceable
.
qualified_name
Unique name for this asset. This is typically a concatenation of the asset's name onto its parent's qualifiedName. This must be unique across all assets of the same type. | |
---|---|
1 2 3 4 |
|
-
Set the
qualified_name
for aReferenceable
. -
Retrieve the
qualified_name
from aReferenceable
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
qualified_name
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
qualified_name
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
qualifiedName
{
"attributes": {
"qualifiedName": "String0" // (1)
}
}
- Set the
qualifiedName
for aReferenceable
.