Plugin

class StateTransitionResponse

Canonical

kortex_api.autogen.messages.Plugin_pb2.StateTransitionResponse

Parameters

response (StateTransitionResponseType) –

class Status

Status of the Plugin

Canonical

kortex_api.autogen.messages.Plugin_pb2.Status

Parameters

• state (State) – State of the plugin

• details (str) – Additional information on the state

class MetaData

Versioned data in a given type

Canonical

kortex_api.autogen.messages.Plugin_pb2.MetaData

Parameters

• friendly_name (str) – Friendly name

• package_name (str) – Conan package name

• version (str) – Semantic version

• author (str) – Author of the plugin

• company (str) – Company

• docker_image (str) – Tag of the Docker image the plugin runs in

• additional_data (str) – JSON formated as string representing additional meta-data parameters

• type (PluginType) – Type of plugin

class Configuration

Versioned data in a given type

Canonical

kortex_api.autogen.messages.Plugin_pb2.Configuration

Parameters

• type (DataType) – Type of serialization for the “data” field

• data (str) – Data for the configuration in a serialized format

• version (str) – Version number for “data” format

class ConfigurationSchema

Versioned schemas for the configuration in a given type

Canonical

kortex_api.autogen.messages.Plugin_pb2.ConfigurationSchema

Parameters

• type (DataType) – Type of serialization for the “data” field

• data_schema (str) – Data schema for the configuration in a serialized format

• ui_schema (str) – UI schema for the configuration in a serialized format (optional)

• version (str) – Version number for “data” format

• layout_schema (str) – Layout schema for the configuration in a serialized format (optional)

class ActionDescriptionList

List of Action types descriptions

Canonical

kortex_api.autogen.messages.Plugin_pb2.ActionDescriptionList

Parameters

actions (ActionDescription [ ]) –

class ActionDescription

Action Type description

Canonical

kortex_api.autogen.messages.Plugin_pb2.ActionDescription

Parameters

• handle (ActionDescriptionHandle) – Handle of the Action Description

• can_be_paused (bool) – True if the Action supports the PauseAction and ResumeAction methods

• can_be_cancelled (bool) – True if the Action supports the StopAction method

• serialization_type (DataType) – Type of serialization for the “schema” fields

• input_schema (str) – Data Schema of input data to supply the Action when starting it, in a serialized format

• output_schema (str) – Data Schema of outputted data by the Action when it ends, in a serialized format

• input_ui_schema (str) – UI Schema of input data, in a serialized format (optional)

• output_ui_schema (str) – UI Schema of output data, in a serialized format (optional)

• version (int) – Action version

• input_layout_schema (str) – Layout Schema of input data, in a serialized format (optional)

• output_layout_schema (str) – Layout Schema of output data, in a serialized format (optional)

• branch_count_property (str) – Property Name in input_schema-respected JSON object to use for branching strategy:

• setup_on_load (bool) – True if the Action needs to be setup/teardown upon load/unload of a Program

• icon (Icon) – Specifies the icon

• icon_label_path (str) – Optional JSON pointer to a value from the action input that we want to

• friendly_name (str) – Friendly name for the action type

• can_be_started_asynchronously (bool) – True if Action supports being launched asynchronously by the Program Runner

class ActionDescriptionHandle

Handle for an Action Description

Canonical

kortex_api.autogen.messages.Plugin_pb2.ActionDescriptionHandle

Parameters

identifier (str) – Type of the Action

class Action

Plugin Action instance

Canonical

kortex_api.autogen.messages.Plugin_pb2.Action

Parameters

• name (str) – Friendly name for this Action

• action_identifier (ActionHandle) – Handle of this Action in the Database (optional)

• program_identifier (ProgramHandle) – Handle of the Program this Action belongs to in the Database (optional)

• handle (ActionDescriptionHandle) – Handle of the Action Description

• serialization_type (DataType) – Type of serialization for the “input” field

• input (str) – Input data to supply the Action when starting it, in a serialized format

class UiTrigger

Trigger associated to element defined in UI schema that can be sent to plugins and actions

Canonical

kortex_api.autogen.messages.Plugin_pb2.UiTrigger

Parameters

• path (str) – JSON path of the element in the form

• name (str) – Name of the trigger

class ActionTrigger

Canonical

kortex_api.autogen.messages.Plugin_pb2.ActionTrigger

Parameters

• action (Action) – Action to update

• global_trigger (GlobalTrigger) – . Part of the trigger Oneof.

• ui_trigger (UiTrigger) –

  . Part of the trigger Oneof.

class ConfigurationTrigger

Canonical

kortex_api.autogen.messages.Plugin_pb2.ConfigurationTrigger

Parameters

• global_trigger (GlobalTrigger) –

  . Part of the trigger Oneof.

• ui_trigger (UiTrigger) –

  . Part of the trigger Oneof.

class JSONFieldFeedback

Field in a JSON to provide feedback for, with level and optional message to show

Canonical

kortex_api.autogen.messages.Plugin_pb2.JSONFieldFeedback

Parameters

• path (str) – Path to the JSON field

• level (FieldFeedbackLevel) – Feedback level

• message (str) – Optional message to show with the field feedback

class ActionInstanceHandle

Plugin Action instance handle. This is created upon starting an Action and destroyed whenever the Action ends.

Canonical

kortex_api.autogen.messages.Plugin_pb2.ActionInstanceHandle

Parameters

identifier (int) –

class StateNotification

Notification about a state change event

Canonical

kortex_api.autogen.messages.Plugin_pb2.StateNotification

Parameters

• state (State) – New state

• details (str) – Additional information on the state

• generic_info (NotificationInformation) – Generic notification information

class ConfigurationChangeNotification

Notification about a configuration change event

Canonical

kortex_api.autogen.messages.Plugin_pb2.ConfigurationChangeNotification

Parameters

• configuration (Configuration) – Configuration event

• generic_info (NotificationInformation) – Generic notification information

class ActionNotification

Notification about a single action event

Canonical

kortex_api.autogen.messages.Plugin_pb2.ActionNotification

Parameters

• action_event (ActionEvent) – Action event type

• instance_handle (ActionInstanceHandle) – Identifies the action instance for which this event occured

• application_data (str) – Contains the output (JSON) if ACTION_END or a string if ACTION_ABORT or ACTION_FEEDBACK

• field_feedbacks (JSONFieldFeedback [ ]) – Field feedbacks in the Action form (optional)

• handle (ActionHandle) – Handle of this Action in the Database (optional)

• generic_info (NotificationInformation) – Generic notification information

class InfoChangeNotification

Notification sent whenever information on the plugin itself changes (excludes current state, current configuration and current action being played)

Canonical

kortex_api.autogen.messages.Plugin_pb2.InfoChangeNotification

Parameters

• generic_info (NotificationInformation) – Generic notification information

• configuration_schema (ConfigurationSchema) –

  The updated Configuration Schema. Part of the updated_info Oneof.

• action_description (ActionDescription) –

  The updated ActionDescription. Filled when only one ActionDescription has been updated.. Part of the updated_info Oneof.

• action_list (ActionDescriptionList) –

  The updated ActionDescriptionList. Filled when one or more ActionDescription’s have been added/removed from the list.. Part of the updated_info Oneof.

• visualizer (Visualizer) –

  The updated Visualizer. Filled when only one Visualizer has been updated.. Part of the updated_info Oneof.

• visualizer_list (VisualizerList) –

  The updated VisualizerList. Filled when one or more Visualizer’s have been added/removed from the list.. Part of the updated_info Oneof.

• feedback_schema (FeedbackSchema) –

  The updated FeedbackSchema. Part of the updated_info Oneof.

class Visualizer

Information about a Visualizer the plugin can offer

Canonical

kortex_api.autogen.messages.Plugin_pb2.Visualizer

Parameters

• name (str) – Friendly name

• url (str) – URL at which the visualizer is available

class VisualizerList

Visualizer list

Canonical

kortex_api.autogen.messages.Plugin_pb2.VisualizerList

Parameters

visualizers (Visualizer [ ]) – List of visualizers

class Feedback

Feedback data

Canonical

kortex_api.autogen.messages.Plugin_pb2.Feedback

Parameters

• type (DataType) – Type of serialization for the “data” field

• data (str) – Data for the feedback in a serialized format

class FeedbackSchema

Schemas for the feedback in a given type

Canonical

kortex_api.autogen.messages.Plugin_pb2.FeedbackSchema

Parameters

• type (DataType) – Type of serialization for the “data” field

• data_schema (str) – Data schema for the feedback in a serialized format

• ui_schema (str) – UI schema for the feedback in a serialized format (optional)

• layout_schema (str) – Layout schema for the feedback in a serialized format (optional)

class ActionValidationResult

Action validation result

Canonical

kortex_api.autogen.messages.Plugin_pb2.ActionValidationResult

Parameters

• is_ok (bool) – True if Action passed validation, false otherwise

• field_feedbacks (JSONFieldFeedback [ ]) – Contains a list of fields for which feedback is provided