ScaffolderClient

Home > @backstage/plugin-scaffolder-common > ScaffolderClient

An API to interact with the scaffolder backend.

Signature:

class ScaffolderClient implements ScaffolderApi 

Implements: ScaffolderApi

Constructors

Constructor	Modifiers	Description
(constructor)(options)		Constructs a new instance of the ScaffolderClient class

Methods

Method	Modifiers	Description
autocomplete({ token, resource, provider, context, })		Starts the task again from the point where it failed.
cancelTask(taskId, options)		Sends a signal to a task broker to cancel the running task by taskId.
dryRun(request, options)
getIntegrationsList(options)
getTask(taskId, options)
getTemplateParameterSchema(templateRef, options)
listActions(options)		Returns a list of all installed actions.
listTasks(request, options)
listTemplatingExtensions(options)		Returns a structure describing the available templating extensions.
retry(taskId, options)?		(Optional) Starts the task again from the point where it failed.
scaffold(request, options)		Executes the scaffolding of a component, given a template and its parameter values.
streamLogs(request, options)