Interface CubeIngestCatalog

ReadonlyenvironmentTypes

describe

• describe(
      urn: string,
      environment: CubeIngestEnvironmentKey,
      options?: { fresh?: boolean },
  ): Promise<readonly CubeIngestDataSet[]>

  A definition's data sets, typed from what it declares. fresh reads the definition again rather than what this page visit read

  Parameters

  • urn: string
  • environment: CubeIngestEnvironmentKey
  • Optionaloptions: { fresh?: boolean }

  Returns Promise<readonly CubeIngestDataSet[]>

OptionalgetProducerNames

• getProducerNames(
      deploymentIds: readonly string[],
  ): Promise<ReadonlyMap<string, string>>

  The names of producer deployments, by deployment id, from the host's deployment directory: none for an id it doesn't know. Only the Ingest tab reads them, to label its producers; hosts without a directory leave it out, and producers show their ids alone

  Parameters

  • deploymentIds: readonly string[]

  Returns Promise<ReadonlyMap<string, string>>

listDefinitions

• listDefinitions(
      environment: CubeIngestEnvironmentKey,
      producerDeploymentId: string,
  ): Promise<CubeIngestDefinitionList>

  A producer deployment's SDLC-deployed definitions of the environment's class

  Parameters

  • environment: CubeIngestEnvironmentKey
  • producerDeploymentId: string

  Returns Promise<CubeIngestDefinitionList>

listEnvironments

• listEnvironments(): Promise<readonly CubeIngestEnvironment[]>

  Every ingest environment of the classes the host lists, for the viewer to pick one

  Returns Promise<readonly CubeIngestEnvironment[]>

listProducers

• listProducers(
      environment: CubeIngestEnvironmentKey,
  ): Promise<readonly CubeIngestProducer[]>

  The producer deployments of an ingest environment

  Parameters

  • environment: CubeIngestEnvironmentKey

  Returns Promise<readonly CubeIngestProducer[]>

resolveEnvironment

• resolveEnvironment(
      environment: CubeIngestEnvironmentKey,
  ): Promise<CubeIngestEnvironment>

  An ingest environment: the one named, else the viewer's own of the class, which the Ingest tab starts on

  Parameters

  • environment: CubeIngestEnvironmentKey

  Returns Promise<CubeIngestEnvironment>

resolveSchemas

• resolveSchemas(
      environment: CubeIngestEnvironmentKey,
      sources: ReadonlyMap<string, CubeIngestDataSetLocation>,
      options?: { fresh?: boolean },
  ): Promise<Map<string, CubeEngineError | Schema>>

  The schema of each saved source, from its definition as deployed: one entry per key, failures included. fresh reads the definitions again

  Parameters

  • environment: CubeIngestEnvironmentKey
  • sources: ReadonlyMap<string, CubeIngestDataSetLocation>
  • Optionaloptions: { fresh?: boolean }

  Returns Promise<Map<string, CubeEngineError | Schema>>