Skip to content

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
builder.presetDashboardId(123456789L); // (1)
preset.getPresetDashboardId(); // (2)
client.assets.select().where(Preset.PRESET_DASHBOARD_ID.gt(123456789L)); // (3)

  1. Set the presetDashboardId for a Preset.

    For more details

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

  2. Retrieve the presetDashboardId from a Preset.

    For more details

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

  3. 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
builder.presetDashboardQualifiedName("String0"); // (1)
preset.getPresetDashboardQualifiedName(); // (2)
client.assets.select().where(Preset.PRESET_DASHBOARD_QUALIFIED_NAME.eq("String0")); // (3)
client.assets.select().where(Preset.PRESET_DASHBOARD_QUALIFIED_NAME.match("String0")); // (4)

  1. Set the presetDashboardQualifiedName for a Preset.

    For more details

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

  2. Retrieve the presetDashboardQualifiedName from a Preset.

    For more details

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

  3. 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.

  4. 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
builder.presetWorkspaceId(123456789L); // (1)
preset.getPresetWorkspaceId(); // (2)
client.assets.select().where(Preset.PRESET_WORKSPACE_ID.gt(123456789L)); // (3)

  1. Set the presetWorkspaceId for a Preset.

    For more details

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

  2. Retrieve the presetWorkspaceId from a Preset.

    For more details

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

  3. 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
builder.presetWorkspaceQualifiedName("String0"); // (1)
preset.getPresetWorkspaceQualifiedName(); // (2)
client.assets.select().where(Preset.PRESET_WORKSPACE_QUALIFIED_NAME.eq("String0")); // (3)
client.assets.select().where(Preset.PRESET_WORKSPACE_QUALIFIED_NAME.match("String0")); // (4)

  1. Set the presetWorkspaceQualifiedName for a Preset.

    For more details

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

  2. Retrieve the presetWorkspaceQualifiedName from a Preset.

    For more details

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

  3. 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.

  4. 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
builder.preset_dashboard_id = ...  # (1)
preset.preset_dashboard_id  # (2)
FluentSearch().where(FluentSearch.asset_type(Preset)).where(Preset.PRESET_DASHBOARD_ID.gt(123))  # (3)

  1. Set the preset_dashboard_id for a Preset.

    For more details

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

  2. Retrieve the preset_dashboard_id from a Preset.

    For more details

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

  3. 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
builder.preset_dashboard_qualified_name = ...  # (1)
preset.preset_dashboard_qualified_name  # (2)
FluentSearch().where(FluentSearch.asset_type(Preset)).where(Preset.PRESET_DASHBOARD_QUALIFIED_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(Preset)).where(Preset.PRESET_DASHBOARD_QUALIFIED_NAME.match("String0"))  # (4)

  1. Set the preset_dashboard_qualified_name for a Preset.

    For more details

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

  2. Retrieve the preset_dashboard_qualified_name from a Preset.

    For more details

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

  3. 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.

  4. 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
builder.preset_workspace_id = ...  # (1)
preset.preset_workspace_id  # (2)
FluentSearch().where(FluentSearch.asset_type(Preset)).where(Preset.PRESET_WORKSPACE_ID.gt(123))  # (3)

  1. Set the preset_workspace_id for a Preset.

    For more details

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

  2. Retrieve the preset_workspace_id from a Preset.

    For more details

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

  3. 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
builder.preset_workspace_qualified_name = ...  # (1)
preset.preset_workspace_qualified_name  # (2)
FluentSearch().where(FluentSearch.asset_type(Preset)).where(Preset.PRESET_WORKSPACE_QUALIFIED_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(Preset)).where(Preset.PRESET_WORKSPACE_QUALIFIED_NAME.match("String0"))  # (4)

  1. Set the preset_workspace_qualified_name for a Preset.

    For more details

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

  2. Retrieve the preset_workspace_qualified_name from a Preset.

    For more details

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

  3. 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.

  4. 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
{
  "attributes": {
    "presetDashboardId": 123456789 // (1)
  }
}

  1. Set the presetDashboardId for a Preset.

    For more details

    For more information, see the asset CRUD snippets.

presetDashboardQualifiedName
qualifiedName of the Preset asset's collection.
1
2
3
4
5
{
  "attributes": {
    "presetDashboardQualifiedName": "String0" // (1)
  }
}

  1. Set the presetDashboardQualifiedName for a Preset.

    For more details

    For more information, see the asset CRUD snippets.

presetWorkspaceId
ID of the Preset asset's workspace.
1
2
3
4
5
{
  "attributes": {
    "presetWorkspaceId": 123456789 // (1)
  }
}

  1. Set the presetWorkspaceId for a Preset.

    For more details

    For more information, see the asset CRUD snippets.

presetWorkspaceQualifiedName
qualifiedName of the Preset asset's workspace.
1
2
3
4
5
{
  "attributes": {
    "presetWorkspaceQualifiedName": "String0" // (1)
  }
}

  1. Set the presetWorkspaceQualifiedName for a Preset.

    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