Plugins
Last updated
Last updated
A plugin is an extension of PACE, with custom logic. A plugin consists of the following properties:
id
: the unique identifier for this plugin implementation
implementation
: the canonical (full) class reference of this plugin
actions
: the list of actions that this plugin supports
Actions are interfaces that can be implemented by the plugin creator, in order for the plugin to offer certain functionalities. The interfaces are defined by the action types. Furthermore, a plugin can possibly be invoked, which means that the action can be triggered through the API (and thus the CLI).
Configuring and enabling a certain plugin differs, as each plugin requires its own configuration. The minimum required plugin configuration looks as follows:
This enables the my-plugin
plugin. More details on building your own plugin can be found in the SDK section.
Below, an overview of all available action types and their description is provided. Also, whether the plugin is invokable
is specified. A plugin action is invokable
if it can be initiated through the PACE API, via the InvokePlugin
RPC. If a plugin action requires a payload, it needs to be provided as a string value, which can be either a JSON, YAML, or base 64 encoded version of the JSON/YAML.
Action name | Description | Parameters | Result | Invokable |
---|---|---|---|---|
Missing an action or a way to integrate certain functionality with PACE? Let us know.
GENERATE_DATA_POLICY
Generate / complete a Data Policy using a plugin, given certain parameters
A payload, that differs per plugin
GENERATE_SAMPLE_DATA
Generate sample data, for example to test run your data policy on a sample data set.
A payload, that differs per plugin
String (currently only CSV is supported)