Skip to main content

PluginEntry

This class represents a WebAPI plugin entry, providing essential metadata for plugin management within the system. It defines a unique identifier, specifies the task types it supports, and includes an instance of the plugin loader. The class also allows for designation as a default plugin for unknown task types or specific task types when multiple plugins are registered.

Attributes

AttributeTypeDescription
IDpluginsCore.TaskTypeID/Name of the plugin. This will be used to identify this plugin and has to be unique in the entire system. All functions like enabling and disabling a plugin use this ID.
SupportedTaskTypes[]pluginsCore.TaskTypeA list of all the task types for which this plugin is applicable.
PluginLoader[PluginLoader](pluginloader.md?sid=flyteplugins_go_tasks_pluginmachinery_webapi_pluginloader)An instance of the plugin.
IsDefaultboolBoolean that indicates if this plugin can be used as the default for unknown task types. There can only be one default in the system.
DefaultForTaskTypes[]pluginsCore.TaskTypeA list of all task types for which this plugin should be default handler when multiple registered plugins support the same task type. This must be a subset of RegisteredTaskTypes and at most one default per task type is supported.