PluginManager

class PluginHandle

Handle for a Plugin instance

Canonical

kortex_api.autogen.messages.PluginManager_pb2.PluginHandle

Parameters

identifier (str) – Unique identifier

class InstallationOptions

Options when updating a plugin

Canonical

kortex_api.autogen.messages.PluginManager_pb2.InstallationOptions

Parameters

• clear_data (bool) – When true, this flag ensures all configuration data pertaining to the plugin is erased before installation/update

• file_id (FileId) – File ID to install the plugin from (optional)

class PluginInfo

Canonical

kortex_api.autogen.messages.PluginManager_pb2.PluginInfo

Parameters

• handle (PluginHandle) – Unique handle to the plugin

• meta_data (MetaData) – Manifest file contents for the Plugin

• installation_type (InstallationType) – Installation type

• configuration (Configuration) – Configuration data

• configuration_schema (ConfigurationSchema) – Configuration schema

• actions (ActionDescription [ ]) – Actions exposed by the plugin

• container_state (ContainerState) – Plugin container current state

• plugin_state (Status) – Plugin application current state

• visualizers (Visualizer [ ]) – Visualizers exposed by the plugin

• feedback_schema (FeedbackSchema) – Feedback schema

class PluginUpdatedNotification

Canonical

kortex_api.autogen.messages.PluginManager_pb2.PluginUpdatedNotification

Parameters

• handle (PluginHandle) – Unique handle

• timestamp (Timestamp) – This field is deprecated and will be removed in a future release

• generic_info (NotificationInformation) – Generic notification information

• plugin_info (PluginInfo) – Plugin information. Filled when a new plugin is detected.. Part of the updated_info Oneof.

• container_state (ContainerState) –

  Container state was updated. Part of the updated_info Oneof.

• plugin_state (Status) –

  Plugin state was updated. Part of the updated_info Oneof.

• configuration (Configuration) –

  Configuration data was updated. Part of the updated_info Oneof.

• configuration_schema (ConfigurationSchema) –

  Configuration schema was updated. Part of the updated_info Oneof.

• action_description (ActionDescription) –

  An Action description was updated. Part of the updated_info Oneof.

• is_removed (bool) –

  The Plugin was removed from the plugins list. Part of the updated_info Oneof.

• action_list (ActionDescriptionList) –

  The whole Action description list was updated. Part of the updated_info Oneof.

• visualizer (Visualizer) –

  A Visualizer was updated. Part of the updated_info Oneof.

• visualizer_list (VisualizerList) –

  The whole Visualizer list was updated. Part of the updated_info Oneof.

• feedback_schema (FeedbackSchema) –

  Feedback schema was updated. Part of the updated_info Oneof.

class PluginInstallationNotification

Canonical

kortex_api.autogen.messages.PluginManager_pb2.PluginInstallationNotification

Parameters

• handle (PluginHandle) – Unique handle (filled if installation succeded)

• package_name (str) – Package name for the installed plugin

• event (PluginInstallationEvent) – Installation event

• details (str) – Details on the event

• timestamp (Timestamp) – This field is deprecated and will be removed in a future release

• generic_info (NotificationInformation) – Generic notification information

class PluginInfoList

Canonical

kortex_api.autogen.messages.PluginManager_pb2.PluginInfoList

Parameters

plugin_info_list (PluginInfo [ ]) –

class PluginScanResponse

This is the scan response message a plugin sends internally when pinged by the PluginManager

Canonical

kortex_api.autogen.messages.PluginManager_pb2.PluginScanResponse

Parameters

• meta_data (MetaData) – Plugin meta-data

• broker_address (str) – Broker IP address which the Plugin is connected to

• handle (PluginHandle) – Unique handle