Skip to content

Mode

Base class for Mode 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 Mode assets in Atlan. For that, we would suggest starting with either:

  • Snippets — small, atomic examples of single-step use cases.
  • Patterns — walkthroughs of common multi-step implementation patterns.
classDiagram
    direction RL
    class Mode {
        <<abstract>>
    }
    link Mode "../mode"
    class BI {
        <<abstract>>
    }
    link BI "../entities/bi"
    BI <|-- Mode : 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 ModeReport
    link ModeReport "../entities/modereport"
    Mode <|-- ModeReport : extends
    class ModeQuery
    link ModeQuery "../entities/modequery"
    Mode <|-- ModeQuery : extends
    class ModeChart
    link ModeChart "../entities/modechart"
    Mode <|-- ModeChart : extends
    class ModeWorkspace
    link ModeWorkspace "../entities/modeworkspace"
    Mode <|-- ModeWorkspace : extends
    class ModeCollection
    link ModeCollection "../entities/modecollection"
    Mode <|-- ModeCollection : extends

Type-specific properties

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

modeId
TBC
1
2
3
builder.modeId("String0"); // (1)
mode.getModeId(); // (2)
client.assets.select().where(Mode.MODE_ID.eq("String0")); // (3)

  1. Set the modeId for a Mode.

    For more details

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

  2. Retrieve the modeId from a Mode.

    For more details

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

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

    For more details

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

modeQueryName
TBC
1
2
3
4
builder.modeQueryName("String0"); // (1)
mode.getModeQueryName(); // (2)
client.assets.select().where(Mode.MODE_QUERY_NAME.eq("String0")); // (3)
client.assets.select().where(Mode.MODE_QUERY_NAME.match("String0")); // (4)

  1. Set the modeQueryName for a Mode.

    For more details

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

  2. Retrieve the modeQueryName from a Mode.

    For more details

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

  3. Find all assets in Atlan with their modeQueryName 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 modeQueryName textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

modeQueryQualifiedName
TBC
1
2
3
4
builder.modeQueryQualifiedName("String0"); // (1)
mode.getModeQueryQualifiedName(); // (2)
client.assets.select().where(Mode.MODE_QUERY_QUALIFIED_NAME.eq("String0")); // (3)
client.assets.select().where(Mode.MODE_QUERY_QUALIFIED_NAME.match("String0")); // (4)

  1. Set the modeQueryQualifiedName for a Mode.

    For more details

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

  2. Retrieve the modeQueryQualifiedName from a Mode.

    For more details

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

  3. Find all assets in Atlan with their modeQueryQualifiedName 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 modeQueryQualifiedName textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

modeReportName
TBC
1
2
3
4
builder.modeReportName("String0"); // (1)
mode.getModeReportName(); // (2)
client.assets.select().where(Mode.MODE_REPORT_NAME.eq("String0")); // (3)
client.assets.select().where(Mode.MODE_REPORT_NAME.match("String0")); // (4)

  1. Set the modeReportName for a Mode.

    For more details

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

  2. Retrieve the modeReportName from a Mode.

    For more details

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

  3. Find all assets in Atlan with their modeReportName 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 modeReportName textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

modeReportQualifiedName
TBC
1
2
3
4
builder.modeReportQualifiedName("String0"); // (1)
mode.getModeReportQualifiedName(); // (2)
client.assets.select().where(Mode.MODE_REPORT_QUALIFIED_NAME.eq("String0")); // (3)
client.assets.select().where(Mode.MODE_REPORT_QUALIFIED_NAME.match("String0")); // (4)

  1. Set the modeReportQualifiedName for a Mode.

    For more details

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

  2. Retrieve the modeReportQualifiedName from a Mode.

    For more details

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

  3. Find all assets in Atlan with their modeReportQualifiedName 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 modeReportQualifiedName textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

modeToken
TBC
1
2
3
4
builder.modeToken("String0"); // (1)
mode.getModeToken(); // (2)
client.assets.select().where(Mode.MODE_TOKEN.eq("String0")); // (3)
client.assets.select().where(Mode.MODE_TOKEN.match("String0")); // (4)

  1. Set the modeToken for a Mode.

    For more details

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

  2. Retrieve the modeToken from a Mode.

    For more details

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

  3. Find all assets in Atlan with their modeToken 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 modeToken textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

modeWorkspaceName
TBC
1
2
3
4
builder.modeWorkspaceName("String0"); // (1)
mode.getModeWorkspaceName(); // (2)
client.assets.select().where(Mode.MODE_WORKSPACE_NAME.eq("String0")); // (3)
client.assets.select().where(Mode.MODE_WORKSPACE_NAME.match("String0")); // (4)

  1. Set the modeWorkspaceName for a Mode.

    For more details

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

  2. Retrieve the modeWorkspaceName from a Mode.

    For more details

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

  3. Find all assets in Atlan with their modeWorkspaceName 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 modeWorkspaceName textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

modeWorkspaceQualifiedName
TBC
1
2
3
4
builder.modeWorkspaceQualifiedName("String0"); // (1)
mode.getModeWorkspaceQualifiedName(); // (2)
client.assets.select().where(Mode.MODE_WORKSPACE_QUALIFIED_NAME.eq("String0")); // (3)
client.assets.select().where(Mode.MODE_WORKSPACE_QUALIFIED_NAME.match("String0")); // (4)

  1. Set the modeWorkspaceQualifiedName for a Mode.

    For more details

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

  2. Retrieve the modeWorkspaceQualifiedName from a Mode.

    For more details

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

  3. Find all assets in Atlan with their modeWorkspaceQualifiedName 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 modeWorkspaceQualifiedName textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

modeWorkspaceUsername
TBC
1
2
3
4
builder.modeWorkspaceUsername("String0"); // (1)
mode.getModeWorkspaceUsername(); // (2)
client.assets.select().where(Mode.MODE_WORKSPACE_USERNAME.eq("String0")); // (3)
client.assets.select().where(Mode.MODE_WORKSPACE_USERNAME.match("String0")); // (4)

  1. Set the modeWorkspaceUsername for a Mode.

    For more details

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

  2. Retrieve the modeWorkspaceUsername from a Mode.

    For more details

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

  3. Find all assets in Atlan with their modeWorkspaceUsername 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 modeWorkspaceUsername textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

mode_id
TBC
1
2
3
builder.mode_id = ...  # (1)
mode.mode_id  # (2)
FluentSearch().where(FluentSearch.asset_type(Mode)).where(Mode.MODE_ID.eq("String0"))  # (3)

  1. Set the mode_id for a Mode.

    For more details

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

  2. Retrieve the mode_id from a Mode.

    For more details

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

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

    For more details

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

mode_query_name
TBC
1
2
3
4
builder.mode_query_name = ...  # (1)
mode.mode_query_name  # (2)
FluentSearch().where(FluentSearch.asset_type(Mode)).where(Mode.MODE_QUERY_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(Mode)).where(Mode.MODE_QUERY_NAME.match("String0"))  # (4)

  1. Set the mode_query_name for a Mode.

    For more details

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

  2. Retrieve the mode_query_name from a Mode.

    For more details

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

  3. Find all assets in Atlan with their mode_query_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 mode_query_name textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

mode_query_qualified_name
TBC
1
2
3
4
builder.mode_query_qualified_name = ...  # (1)
mode.mode_query_qualified_name  # (2)
FluentSearch().where(FluentSearch.asset_type(Mode)).where(Mode.MODE_QUERY_QUALIFIED_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(Mode)).where(Mode.MODE_QUERY_QUALIFIED_NAME.match("String0"))  # (4)

  1. Set the mode_query_qualified_name for a Mode.

    For more details

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

  2. Retrieve the mode_query_qualified_name from a Mode.

    For more details

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

  3. Find all assets in Atlan with their mode_query_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 mode_query_qualified_name textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

mode_report_name
TBC
1
2
3
4
builder.mode_report_name = ...  # (1)
mode.mode_report_name  # (2)
FluentSearch().where(FluentSearch.asset_type(Mode)).where(Mode.MODE_REPORT_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(Mode)).where(Mode.MODE_REPORT_NAME.match("String0"))  # (4)

  1. Set the mode_report_name for a Mode.

    For more details

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

  2. Retrieve the mode_report_name from a Mode.

    For more details

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

  3. Find all assets in Atlan with their mode_report_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 mode_report_name textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

mode_report_qualified_name
TBC
1
2
3
4
builder.mode_report_qualified_name = ...  # (1)
mode.mode_report_qualified_name  # (2)
FluentSearch().where(FluentSearch.asset_type(Mode)).where(Mode.MODE_REPORT_QUALIFIED_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(Mode)).where(Mode.MODE_REPORT_QUALIFIED_NAME.match("String0"))  # (4)

  1. Set the mode_report_qualified_name for a Mode.

    For more details

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

  2. Retrieve the mode_report_qualified_name from a Mode.

    For more details

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

  3. Find all assets in Atlan with their mode_report_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 mode_report_qualified_name textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

mode_token
TBC
1
2
3
4
builder.mode_token = ...  # (1)
mode.mode_token  # (2)
FluentSearch().where(FluentSearch.asset_type(Mode)).where(Mode.MODE_TOKEN.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(Mode)).where(Mode.MODE_TOKEN.match("String0"))  # (4)

  1. Set the mode_token for a Mode.

    For more details

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

  2. Retrieve the mode_token from a Mode.

    For more details

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

  3. Find all assets in Atlan with their mode_token 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 mode_token textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

mode_workspace_name
TBC
1
2
3
4
builder.mode_workspace_name = ...  # (1)
mode.mode_workspace_name  # (2)
FluentSearch().where(FluentSearch.asset_type(Mode)).where(Mode.MODE_WORKSPACE_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(Mode)).where(Mode.MODE_WORKSPACE_NAME.match("String0"))  # (4)

  1. Set the mode_workspace_name for a Mode.

    For more details

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

  2. Retrieve the mode_workspace_name from a Mode.

    For more details

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

  3. Find all assets in Atlan with their mode_workspace_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 mode_workspace_name textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

mode_workspace_qualified_name
TBC
1
2
3
4
builder.mode_workspace_qualified_name = ...  # (1)
mode.mode_workspace_qualified_name  # (2)
FluentSearch().where(FluentSearch.asset_type(Mode)).where(Mode.MODE_WORKSPACE_QUALIFIED_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(Mode)).where(Mode.MODE_WORKSPACE_QUALIFIED_NAME.match("String0"))  # (4)

  1. Set the mode_workspace_qualified_name for a Mode.

    For more details

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

  2. Retrieve the mode_workspace_qualified_name from a Mode.

    For more details

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

  3. Find all assets in Atlan with their mode_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 mode_workspace_qualified_name textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

mode_workspace_username
TBC
1
2
3
4
builder.mode_workspace_username = ...  # (1)
mode.mode_workspace_username  # (2)
FluentSearch().where(FluentSearch.asset_type(Mode)).where(Mode.MODE_WORKSPACE_USERNAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(Mode)).where(Mode.MODE_WORKSPACE_USERNAME.match("String0"))  # (4)

  1. Set the mode_workspace_username for a Mode.

    For more details

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

  2. Retrieve the mode_workspace_username from a Mode.

    For more details

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

  3. Find all assets in Atlan with their mode_workspace_username 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 mode_workspace_username textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

modeId
TBC
1
2
3
4
5
{
  "attributes": {
    "modeId": "String0" // (1)
  }
}

  1. Set the modeId for a Mode.

    For more details

    For more information, see the asset CRUD snippets.

modeQueryName
TBC
1
2
3
4
5
{
  "attributes": {
    "modeQueryName": "String0" // (1)
  }
}

  1. Set the modeQueryName for a Mode.

    For more details

    For more information, see the asset CRUD snippets.

modeQueryQualifiedName
TBC
1
2
3
4
5
{
  "attributes": {
    "modeQueryQualifiedName": "String0" // (1)
  }
}

  1. Set the modeQueryQualifiedName for a Mode.

    For more details

    For more information, see the asset CRUD snippets.

modeReportName
TBC
1
2
3
4
5
{
  "attributes": {
    "modeReportName": "String0" // (1)
  }
}

  1. Set the modeReportName for a Mode.

    For more details

    For more information, see the asset CRUD snippets.

modeReportQualifiedName
TBC
1
2
3
4
5
{
  "attributes": {
    "modeReportQualifiedName": "String0" // (1)
  }
}

  1. Set the modeReportQualifiedName for a Mode.

    For more details

    For more information, see the asset CRUD snippets.

modeToken
TBC
1
2
3
4
5
{
  "attributes": {
    "modeToken": "String0" // (1)
  }
}

  1. Set the modeToken for a Mode.

    For more details

    For more information, see the asset CRUD snippets.

modeWorkspaceName
TBC
1
2
3
4
5
{
  "attributes": {
    "modeWorkspaceName": "String0" // (1)
  }
}

  1. Set the modeWorkspaceName for a Mode.

    For more details

    For more information, see the asset CRUD snippets.

modeWorkspaceQualifiedName
TBC
1
2
3
4
5
{
  "attributes": {
    "modeWorkspaceQualifiedName": "String0" // (1)
  }
}

  1. Set the modeWorkspaceQualifiedName for a Mode.

    For more details

    For more information, see the asset CRUD snippets.

modeWorkspaceUsername
TBC
1
2
3
4
5
{
  "attributes": {
    "modeWorkspaceUsername": "String0" // (1)
  }
}

  1. Set the modeWorkspaceUsername for a Mode.

    For more details

    For more information, see the asset CRUD snippets.

Relationships

The following illustrates how the various Mode objects inter-relate with each other:

erDiagram
    Connection ||..o{ ModeWorkspace : ""
    ModeWorkspace |o--o{ ModeCollection : modeCollections
    ModeCollection }o--o{ ModeReport : modeReports
    ModeReport |o--o{ ModeQuery : modeQueries
    ModeQuery |o--o{ ModeChart : modeCharts