Skip to main content

WiringService

Source and message fields. Error family: wiring.

GetWiringCatalog​

GetWiringCatalog is every service's hooks, activities and events from its latest manifest: the editor's palette and the types of its ports.

  • Path: /backplane.console.v1.WiringService/GetWiringCatalog.
  • Input: GetWiringCatalogRequest; output: GetWiringCatalogResponse; mode: unary.
  • Errors: wiring + common.
  • Read/validation: safe to retry after a transient failure.
// client: WiringServiceClient; request: GetWiringCatalogRequest; signal: AbortSignal
const response = await client.getWiringCatalog(request, { signal });

AnalyzeBinding​

AnalyzeBinding validates a binding against the latest manifests and describes it: the steps' levels and dependencies, the type of every value and what every expression reads.

  • Path: /backplane.console.v1.WiringService/AnalyzeBinding.
  • Input: AnalyzeBindingRequest; output: AnalyzeBindingResponse; mode: unary.
  • Errors: wiring + common.
  • Read/validation: safe to retry after a transient failure.
// client: WiringServiceClient; request: AnalyzeBindingRequest; signal: AbortSignal
const response = await client.analyzeBinding(request, { signal });

AnalyzeRule​

AnalyzeRule is AnalyzeBinding for a rule.

  • Path: /backplane.console.v1.WiringService/AnalyzeRule.
  • Input: AnalyzeRuleRequest; output: AnalyzeRuleResponse; mode: unary.
  • Errors: wiring + common.
  • Read/validation: safe to retry after a transient failure.
// client: WiringServiceClient; request: AnalyzeRuleRequest; signal: AbortSignal
const response = await client.analyzeRule(request, { signal });

RenameStep​

RenameStep renames a step in a definition: its key, every after naming it and every expression reading it (by the expressions' syntax trees, so a string or a field of the same name is untouched).

  • Path: /backplane.console.v1.WiringService/RenameStep.
  • Input: RenameStepRequest; output: RenameStepResponse; mode: unary.
  • Errors: wiring + common.
  • Read/validation: safe to retry after a transient failure.
// client: WiringServiceClient; request: RenameStepRequest; signal: AbortSignal
const response = await client.renameStep(request, { signal });