Package com.atlan.model.packages

Class PowerBICrawler.PowerBICrawlerBuilder<C extends PowerBICrawler,B extends PowerBICrawler.PowerBICrawlerBuilder<C,B>>

java.lang.Object
com.atlan.model.packages.AbstractPackage.AbstractPackageBuilder<C,B>
com.atlan.model.packages.AbstractCrawler.AbstractCrawlerBuilder<C,B>
com.atlan.model.packages.PowerBICrawler.PowerBICrawlerBuilder<C,B>
Enclosing class:
PowerBICrawler
public abstract static class PowerBICrawler.PowerBICrawlerBuilder<C extends PowerBICrawler,B extends PowerBICrawler.PowerBICrawlerBuilder<C,B>> extends AbstractCrawler.AbstractCrawlerBuilder<C,B>

  • Constructor Details

    • PowerBICrawlerBuilder

      public PowerBICrawlerBuilder()

  • Method Details

    • direct

      public B direct()
      Set up the crawler to extract directly from Power BI.
      Returns:
      the builder, set up to extract directly from Power BI

    • delegatedUser

      public B delegatedUser(String username, String password, String tenantId, String clientId, String clientSecret)
      Set up the crawler to use delegated user authentication.
      Parameters:
      username - through which to access Power BI
      password - through which to access Power BI
      tenantId - unique ID (GUID) of the tenant for Power BI
      clientId - unique ID (GUID) of the client for Power BI
      clientSecret - through which to access Power BI
      Returns:
      the builder, set up to use basic authentication

    • servicePrincipal

      public B servicePrincipal(String tenantId, String clientId, String clientSecret)
      Set up the crawler to use service principal authentication.
      Parameters:
      tenantId - unique ID (GUID) of the tenant for Power BI
      clientId - unique ID (GUID) of the client for Power BI
      clientSecret - through which to access Power BI
      Returns:
      the builder, set up to use basic authentication

    • include

      public B include(List<String> workspaces) throws InvalidRequestException
      Defines the filter for workspaces to include when crawling.
      Parameters:
      workspaces - the GUIDs of workspaces to include when crawling
      Returns:
      the builder, set to include only those workspaces specified
      Throws:
      InvalidRequestException - in the unlikely event the provided filter cannot be translated

    • exclude

      public B exclude(List<String> workspaces) throws InvalidRequestException
      Defines the filter for workspaces to exclude when crawling.
      Parameters:
      workspaces - the GUIDs of workspaces to exclude when crawling
      Returns:
      the builder, set to exclude only those workspaces specified
      Throws:
      InvalidRequestException - in the unlikely event the provided filter cannot be translated

    • include

      public B include(String regex)
      Defines a regular expression to use for including dashboards and reports when crawling.
      Parameters:
      regex - any dashboard and report names that match this regular expression will be included in crawling
      Returns:
      the builder, set to include any assets that match the provided regular expression

    • exclude

      public B exclude(String regex)
      Defines a regular expression to use for excluding dashboards and reports when crawling.
      Parameters:
      regex - any dashboard and report names that match this regular expression will be excluded from crawling
      Returns:
      the builder, set to exclude any assets that match the provided regular expression

    • directEndorsements

      public B directEndorsements(boolean enabled)
      Whether to directly attach endorsements as certificates (true), or instead raise these as requests.
      Parameters:
      enabled - if true, endorsements will be directly set as certificates on assets, otherwise requests will be raised
      Returns:
      the builder, set to directly (or not) set certificates on assets for endorsements

    • metadata

      protected B metadata()
      Set all the metadata for the package (labels, annotations, etc).
      Specified by:
      metadata in class AbstractPackage.AbstractPackageBuilder<C extends PowerBICrawler,B extends PowerBICrawler.PowerBICrawlerBuilder<C,B>>
      Returns:
      the builder, with metadata set

    • $fillValuesFrom

      protected B $fillValuesFrom(C instance)
      Overrides:
      $fillValuesFrom in class AbstractCrawler.AbstractCrawlerBuilder<C extends PowerBICrawler,B extends PowerBICrawler.PowerBICrawlerBuilder<C,B>>

    • self

      protected abstract B self()
      Specified by:
      self in class AbstractCrawler.AbstractCrawlerBuilder<C extends PowerBICrawler,B extends PowerBICrawler.PowerBICrawlerBuilder<C,B>>

    • build

      public abstract C build()
      Specified by:
      build in class AbstractCrawler.AbstractCrawlerBuilder<C extends PowerBICrawler,B extends PowerBICrawler.PowerBICrawlerBuilder<C,B>>

    • toString

      public String toString()
      Overrides:
      toString in class AbstractCrawler.AbstractCrawlerBuilder<C extends PowerBICrawler,B extends PowerBICrawler.PowerBICrawlerBuilder<C,B>>