Interface CubeLakehouseServices

What a host gives Cube to read its deployed data products (PLAN §6.8)

interface CubeLakehouseServices {
    contractServerClient: LakehouseContractServerClient;
    deploymentNameServiceUrl?: string;
    depotServerClient: DepotServerClient;
    enterpriseStereotype?: { profile: string; value: string };
    getAccessToken: () => undefined | string;
    getCurrentUser: () => string;
    getMarketplaceLink?: (
        target: CubeMarketplaceLinkTarget,
    ) => undefined | string;
    getPreferredEnvironment?: () => undefined | string;
    ingestServerClient?: LakehouseIngestServerClient;
    marketplaceServerClient?: MarketplaceServerClient;
    platformServerClient?: LakehousePlatformServerClient;
}

Properties

contractServerClient deploymentNameServiceUrl? depotServerClient enterpriseStereotype? getAccessToken getCurrentUser getMarketplaceLink? getPreferredEnvironment? ingestServerClient? marketplaceServerClient? platformServerClient?

Properties

ReadonlycontractServerClient

contractServerClient: LakehouseContractServerClient

Optional ReadonlydeploymentNameServiceUrl

deploymentNameServiceUrl?: string

The engine path of the Legend user service naming producer deployments, as Marketplace configures it (dataProductConfig.producer.deploymentLegendServiceUrl): with it, the Ingest tab shows each producer's name

ReadonlydepotServerClient

depotServerClient: DepotServerClient

Optional ReadonlyenterpriseStereotype

enterpriseStereotype?: { profile: string; value: string }

The stereotype the host's marketplace marks access point groups open to everyone with; without it, a group with no contract shows no access

ReadonlygetAccessToken

getAccessToken: () => undefined | string

ReadonlygetCurrentUser

getCurrentUser: () => string

The viewer, whose lakehouse environment data product runs use

Optional ReadonlygetMarketplaceLink

getMarketplaceLink?: (target: CubeMarketplaceLinkTarget) => undefined | string

A deployed data product's page in the host's marketplace; none when the host has no marketplace

Optional ReadonlygetPreferredEnvironment

getPreferredEnvironment?: () => undefined | string

The environment the host remembers for the viewer, used before their entitlements' first one

Optional ReadonlyingestServerClient

ingestServerClient?: LakehouseIngestServerClient

A client for the ingest servers the platform names: each call names its server

Optional ReadonlymarketplaceServerClient

marketplaceServerClient?: MarketplaceServerClient

The marketplace's search API: with it, the source dialog searches there, never reading the lakehouse's whole list

Optional ReadonlyplatformServerClient

platformServerClient?: LakehousePlatformServerClient

The lakehouse platform, whose ingest environments the Ingest tab reads (PLAN §6.7)

Settings

Member Visibility

On This Page

Properties