Preset¶
Base class for Preset assets.
Reference documentation
This is reference documentation covering the entire Atlan model. It is not the best place to start when trying to understand managing Preset assets in Atlan. For that, we would suggest starting with the manage Preset assets pattern.
classDiagram
direction RL
class Preset {
<<abstract>>
}
link Preset "../preset"
class BI {
<<abstract>>
}
link BI "../entities/bi"
BI <|-- Preset : extends
class Catalog {
<<abstract>>
}
link Catalog "../entities/catalog"
Catalog <|-- BI : extends
class Asset {
<<abstract>>
}
link Asset "../entities/asset"
Asset <|-- Catalog : extends
class Referenceable {
<<abstract>>
}
link Referenceable "../entities/referenceable"
Referenceable <|-- Asset : extends
class PresetChart
link PresetChart "../entities/presetchart"
Preset <|-- PresetChart : extends
class PresetDataset
link PresetDataset "../entities/presetdataset"
Preset <|-- PresetDataset : extends
class PresetDashboard
link PresetDashboard "../entities/presetdashboard"
Preset <|-- PresetDashboard : extends
class PresetWorkspace
link PresetWorkspace "../entities/presetworkspace"
Preset <|-- PresetWorkspace : extends
Type-specific properties¶
Following are the properties uniquely available on Preset
assets in Atlan.
presetDashboardId
ID of the Preset asset's collection. | |
---|---|
1 2 3 |
|
-
Set the
presetDashboardId
for aPreset
. -
Retrieve the
presetDashboardId
from aPreset
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
presetDashboardId
greater than the provided value.For more details
For more information, see the searching section on range queries.
presetDashboardQualifiedName
qualifiedName of the Preset asset's collection. | |
---|---|
1 2 3 4 |
|
-
Set the
presetDashboardQualifiedName
for aPreset
. -
Retrieve the
presetDashboardQualifiedName
from aPreset
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
presetDashboardQualifiedName
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
presetDashboardQualifiedName
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
presetWorkspaceId
ID of the Preset asset's workspace. | |
---|---|
1 2 3 |
|
-
Set the
presetWorkspaceId
for aPreset
. -
Retrieve the
presetWorkspaceId
from aPreset
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
presetWorkspaceId
greater than the provided value.For more details
For more information, see the searching section on range queries.
presetWorkspaceQualifiedName
qualifiedName of the Preset asset's workspace. | |
---|---|
1 2 3 4 |
|
-
Set the
presetWorkspaceQualifiedName
for aPreset
. -
Retrieve the
presetWorkspaceQualifiedName
from aPreset
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
presetWorkspaceQualifiedName
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
presetWorkspaceQualifiedName
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
preset_dashboard_id
TBC | |
---|---|
1 2 3 |
|
-
Set the
preset_dashboard_id
for aPreset
. -
Retrieve the
preset_dashboard_id
from aPreset
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
preset_dashboard_id
greater than the provided value.For more details
For more information, see the searching section on range queries.
preset_dashboard_qualified_name
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
preset_dashboard_qualified_name
for aPreset
. -
Retrieve the
preset_dashboard_qualified_name
from aPreset
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
preset_dashboard_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
preset_dashboard_qualified_name
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
preset_workspace_id
TBC | |
---|---|
1 2 3 |
|
-
Set the
preset_workspace_id
for aPreset
. -
Retrieve the
preset_workspace_id
from aPreset
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
preset_workspace_id
greater than the provided value.For more details
For more information, see the searching section on range queries.
preset_workspace_qualified_name
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
preset_workspace_qualified_name
for aPreset
. -
Retrieve the
preset_workspace_qualified_name
from aPreset
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
preset_workspace_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
preset_workspace_qualified_name
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
presetDashboardId
ID of the Preset asset's collection. | |
---|---|
1 2 3 4 5 |
|
-
Set the
presetDashboardId
for aPreset
.For more details
For more information, see the asset CRUD snippets.
presetDashboardQualifiedName
qualifiedName of the Preset asset's collection. | |
---|---|
1 2 3 4 5 |
|
-
Set the
presetDashboardQualifiedName
for aPreset
.For more details
For more information, see the asset CRUD snippets.
presetWorkspaceId
ID of the Preset asset's workspace. | |
---|---|
1 2 3 4 5 |
|
-
Set the
presetWorkspaceId
for aPreset
.For more details
For more information, see the asset CRUD snippets.
presetWorkspaceQualifiedName
qualifiedName of the Preset asset's workspace. | |
---|---|
1 2 3 4 5 |
|
-
Set the
presetWorkspaceQualifiedName
for aPreset
.For more details
For more information, see the asset CRUD snippets.
Relationships¶
The following illustrates how the various Preset objects inter-relate with each other:
erDiagram
Connection ||..o{ PresetWorkspace : ""
PresetWorkspace ||--o{ PresetDashboard : presetDashboards
PresetDashboard ||--o{ PresetChart : presetCharts
PresetDashboard ||--o{ PresetDataset : presetDatasets