Skip to content

PowerBI

Base class for Power BI 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 Power BI 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 PowerBI {
        <<abstract>>
    }
    link PowerBI "../powerbi"
    class BI {
        <<abstract>>
    }
    link BI "../entities/bi"
    BI <|-- PowerBI : 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 PowerBIReport
    link PowerBIReport "../entities/powerbireport"
    PowerBI <|-- PowerBIReport : extends
    class PowerBIMeasure
    link PowerBIMeasure "../entities/powerbimeasure"
    PowerBI <|-- PowerBIMeasure : extends
    class PowerBIColumn
    link PowerBIColumn "../entities/powerbicolumn"
    PowerBI <|-- PowerBIColumn : extends
    class PowerBITable
    link PowerBITable "../entities/powerbitable"
    PowerBI <|-- PowerBITable : extends
    class PowerBITile
    link PowerBITile "../entities/powerbitile"
    PowerBI <|-- PowerBITile : extends
    class PowerBIDatasource
    link PowerBIDatasource "../entities/powerbidatasource"
    PowerBI <|-- PowerBIDatasource : extends
    class PowerBIWorkspace
    link PowerBIWorkspace "../entities/powerbiworkspace"
    PowerBI <|-- PowerBIWorkspace : extends
    class PowerBIDataset
    link PowerBIDataset "../entities/powerbidataset"
    PowerBI <|-- PowerBIDataset : extends
    class PowerBIDashboard
    link PowerBIDashboard "../entities/powerbidashboard"
    PowerBI <|-- PowerBIDashboard : extends
    class PowerBIDataflow
    link PowerBIDataflow "../entities/powerbidataflow"
    PowerBI <|-- PowerBIDataflow : extends
    class PowerBIPage
    link PowerBIPage "../entities/powerbipage"
    PowerBI <|-- PowerBIPage : extends

Type-specific properties

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

powerBIEndorsement
TBC
1
2
3
builder.powerBIEndorsement(PowerBIEndorsementType.PROMOTED); // (1)
powerBI.getPowerBIEndorsement(); // (2)
client.assets.select().where(PowerBI.POWER_BI_ENDORSEMENT.eq(PowerBIEndorsementType.PROMOTED)); // (3)

  1. Set the powerBIEndorsement for a PowerBI.

    For more details

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

  2. Retrieve the powerBIEndorsement from a PowerBI.

    For more details

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

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

    For more details

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

powerBIFormatString
TBC
1
2
3
builder.powerBIFormatString("String0"); // (1)
powerBI.getPowerBIFormatString(); // (2)
client.assets.select().where(PowerBI.POWER_BI_FORMAT_STRING.eq("String0")); // (3)

  1. Set the powerBIFormatString for a PowerBI.

    For more details

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

  2. Retrieve the powerBIFormatString from a PowerBI.

    For more details

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

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

    For more details

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

powerBIIsHidden
TBC
1
2
3
builder.powerBIIsHidden(true); // (1)
powerBI.getPowerBIIsHidden(); // (2)
client.assets.select().where(PowerBI.POWER_BI_IS_HIDDEN.eq(true)); // (3)

  1. Set the powerBIIsHidden for a PowerBI.

    For more details

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

  2. Retrieve the powerBIIsHidden from a PowerBI.

    For more details

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

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

    For more details

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

powerBITableQualifiedName
TBC
1
2
3
4
builder.powerBITableQualifiedName("String0"); // (1)
powerBI.getPowerBITableQualifiedName(); // (2)
client.assets.select().where(PowerBI.POWER_BI_TABLE_QUALIFIED_NAME.eq("String0")); // (3)
client.assets.select().where(PowerBI.POWER_BI_TABLE_QUALIFIED_NAME.match("String0")); // (4)

  1. Set the powerBITableQualifiedName for a PowerBI.

    For more details

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

  2. Retrieve the powerBITableQualifiedName from a PowerBI.

    For more details

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

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

    For more details

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

power_b_i_endorsement
TBC
1
2
3
builder.power_b_i_endorsement = ...  # (1)
power_b_i.power_b_i_endorsement  # (2)
FluentSearch().where(FluentSearch.asset_type(PowerBI)).where(PowerBI.POWER_BI_ENDORSEMENT.eq("String0"))  # (3)

  1. Set the power_b_i_endorsement for a PowerBI.

    For more details

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

  2. Retrieve the power_b_i_endorsement from a PowerBI.

    For more details

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

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

    For more details

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

power_b_i_format_string
TBC
1
2
3
builder.power_b_i_format_string = ...  # (1)
power_b_i.power_b_i_format_string  # (2)
FluentSearch().where(FluentSearch.asset_type(PowerBI)).where(PowerBI.POWER_BI_FORMAT_STRING.eq("String0"))  # (3)

  1. Set the power_b_i_format_string for a PowerBI.

    For more details

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

  2. Retrieve the power_b_i_format_string from a PowerBI.

    For more details

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

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

    For more details

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

power_b_i_is_hidden
TBC
1
2
3
builder.power_b_i_is_hidden = ...  # (1)
power_b_i.power_b_i_is_hidden  # (2)
FluentSearch().where(FluentSearch.asset_type(PowerBI)).where(PowerBI.POWER_BI_IS_HIDDEN.eq(True))  # (3)

  1. Set the power_b_i_is_hidden for a PowerBI.

    For more details

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

  2. Retrieve the power_b_i_is_hidden from a PowerBI.

    For more details

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

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

    For more details

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

power_b_i_table_qualified_name
TBC
1
2
3
4
builder.power_b_i_table_qualified_name = ...  # (1)
power_b_i.power_b_i_table_qualified_name  # (2)
FluentSearch().where(FluentSearch.asset_type(PowerBI)).where(PowerBI.POWER_BI_TABLE_QUALIFIED_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(PowerBI)).where(PowerBI.POWER_BI_TABLE_QUALIFIED_NAME.match("String0"))  # (4)

  1. Set the power_b_i_table_qualified_name for a PowerBI.

    For more details

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

  2. Retrieve the power_b_i_table_qualified_name from a PowerBI.

    For more details

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

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

    For more details

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

powerBIEndorsement
TBC
1
2
3
4
5
{
  "attributes": {
    "powerBIEndorsement": "Promoted" // (1)
  }
}

  1. Set the powerBIEndorsement for a PowerBI.

    For more details

    For more information, see the asset CRUD snippets.

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

  1. Set the powerBIFormatString for a PowerBI.

    For more details

    For more information, see the asset CRUD snippets.

powerBIIsHidden
TBC
1
2
3
4
5
{
  "attributes": {
    "powerBIIsHidden": true // (1)
  }
}

  1. Set the powerBIIsHidden for a PowerBI.

    For more details

    For more information, see the asset CRUD snippets.

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

  1. Set the powerBITableQualifiedName for a PowerBI.

    For more details

    For more information, see the asset CRUD snippets.

Relationships

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

erDiagram
    Connection ||..o{ PowerBIWorkspace : ""
    PowerBIWorkspace |o--o{ PowerBIDashboard : dashboards
    PowerBIWorkspace |o--o{ PowerBIDataflow : dataflows
    PowerBIWorkspace |o--o{ PowerBIDataset : datasets
    PowerBIWorkspace |o--o{ PowerBIReport : reports
    PowerBIDashboard |o--o{ PowerBITile : tiles
    PowerBIDataflow }o--o{ PowerBIDataset : datasets
    PowerBIDataset }o--o{ PowerBIDatasource : datasources
    PowerBIDataset |o--o{ PowerBIReport : reports
    PowerBIDataset |o--o{ PowerBITable : tables
    PowerBIDataset |o--o{ PowerBITile : tiles
    PowerBIReport |o--o{ PowerBIPage : pages
    PowerBIReport |o--o{ PowerBITile : tiles
    PowerBITable |o--o{ PowerBIColumn : columns
    PowerBITable |o--o{ PowerBIMeasure : measures