Skip to main content

CatalogService

Source and message fields. Error family: catalog.

ListServices​

Every service, summarized.

  • Path: /backplane.console.v1.CatalogService/ListServices.
  • Input: ListServicesRequest; output: ListServicesResponse; mode: unary.
  • Errors: catalog + common.
  • Read/validation: safe to retry after a transient failure.
// client: CatalogServiceClient; request: ListServicesRequest; signal: AbortSignal
const response = await client.listServices(request, { signal });

GetService​

One service in full: latest manifest, manifests per version, instances.

  • Path: /backplane.console.v1.CatalogService/GetService.
  • Input: GetServiceRequest; output: GetServiceResponse; mode: unary.
  • Errors: catalog + common.
  • Read/validation: safe to retry after a transient failure.
// client: CatalogServiceClient; request: GetServiceRequest; signal: AbortSignal
const response = await client.getService(request, { signal });

WatchCatalog​

The summary now and after every change of the catalog, until the call is cancelled; a slow reader skips intermediate snapshots.

  • Path: /backplane.console.v1.CatalogService/WatchCatalog.
  • Input: WatchCatalogRequest; output: WatchCatalogResponse; mode: replacement snapshots.
  • Errors: catalog + common.
  • Long-lived read; recovery follows its stream semantics.
// client: CatalogServiceClient; request: WatchCatalogRequest; signal: AbortSignal
for await (const response of client.watchCatalog(request, { signal })) {
  console.log(response);
}

ListPlugins​

Console plugins: services whose latest manifest declares a UI bundle.

  • Path: /backplane.console.v1.CatalogService/ListPlugins.
  • Input: ListPluginsRequest; output: ListPluginsResponse; mode: unary.
  • Errors: catalog + common.
  • Read/validation: safe to retry after a transient failure.
// client: CatalogServiceClient; request: ListPluginsRequest; signal: AbortSignal
const response = await client.listPlugins(request, { signal });