5.338 Fields: Plugins
See the associated Plugins resource section for more information on how to use this resource and supported operations.
Additional references
| Type | Value | Additional information |
|---|---|---|
| Permissions resource | plugins | Permissions |
| Hooks filename | plugins.groovy | Pre- and Post-Processing Hooks |
| Distinct query-supported | No | Distinct |
API version 3
This class represents a configured plugin created from a plugin type.
| Field Name | Type | POST | PUT | Description |
|---|---|---|---|---|
| id | String | Yes | No |
Unique identifier for the plugin. Must contain at least one letter and must also start with a letter. Reserved IDs are "all" and "moab". If these are used an error with be returned. |
| autoStart | Boolean | Yes | Yes |
Whether the plugin should start automatically when created. |
| config | Map<String, Map> | Yes | Yes |
The configuration of the plugin. Plugin types may define constraints on the configuration, therefore it is recommended to view the plugin type's documentation for more information on required and optional fields. Regardless, the plugin configuration supports arbitrary keys and values. |
| dateCreated | Date | No | No |
The date that this plugin was created. |
| lastPollDate | Date | No | No |
The date of the last polling event that occurred. This may be null if the plugin is in the STOPPED state or has not yet been polled. |
| lastUpdated | Date | No | No |
The date that this plugin was last updated. |
| nextPollDate | Date | No | No |
The date of the next polling event that is scheduled to occur. This may be null if the plugin is in the STOPPED state. |
| pluginType | String | Yes | No |
The plugin name as in Native or Example for the plugin called ExamplePlugin. |
| pollInterval | Integer | Yes | Yes |
The polling interval to use for the plugin in seconds. This is ignored if the plugin type does not support polling. |
| precedence | Long | Yes | Yes |
The precedence of this plugin, with the lowest value being the highest precedence. Minimum of 1. This is used when doing data consolidation when reporting current state data. Lower numbers results in a higher precedence (i.e. 1 is higher precedence than 10). If not specified during creation, this will be automatically set to 1 for the first plugin created, then 1 greater for each subsequently created plugin (i.e. 1 for plugin1, 2 for plugin2, etc). It is always set to 1 greater than the plugin with the greatest precedence number (i.e. 11 if two plugins exist with precedence 1 and 10). |
| state | PluginState | No | No |
The current state of the plugin. Defaults to PluginState.STOPPED. |
Represents the current state of a plugin.
| Value | Description |
|---|---|
| STOPPED | The plugin is created and ready for use, but is not currently receiving any events |
| STARTED | The plugin is currently receiving events and is working correctly. |
| PAUSED | The plugin is currently not receiving any events but is also not stopped. This should be used when polling or other events should stop only temporarily without firing the stop events. |
| ERRORED | MWS has detected an error with the plugin and has automatically stopped it. Errors could be due to the following reasons:
|
API version 2
This class represents a configured plugin created from a plugin type.
| Field Name | Type | POST | PUT | Description |
|---|---|---|---|---|
| id | String | Yes | No |
Unique identifier for the plugin. Must contain at least one letter and must also start with a letter. Reserved IDs are "all" and "moab". If these are used an error with be returned. |
| autoStart | Boolean | Yes | Yes |
Whether the plugin should start automatically when created. |
| config | Map<String, Map> | Yes | Yes |
The configuration of the plugin. Plugin types may define constraints on the configuration, therefore it is recommended to view the plugin type's documentation for more information on required and optional fields. Regardless, the plugin configuration supports arbitrary keys and values. |
| dateCreated | Date | No | No |
The date that this plugin was created. |
| lastPollDate | Date | No | No |
The date of the last polling event that occurred. This may be null if the plugin is in the STOPPED state or has not yet been polled. |
| lastUpdated | Date | No | No |
The date that this plugin was last updated. |
| nextPollDate | Date | No | No |
The date of the next polling event that is scheduled to occur. This may be null if the plugin is in the STOPPED state. |
| pluginType | String | Yes | No |
The plugin name as in Native or Example for the plugin called ExamplePlugin. |
| pollInterval | Integer | Yes | Yes |
The polling interval to use for the plugin in seconds. This is ignored if the plugin type does not support polling. |
| precedence | Long | Yes | Yes |
The precedence of this plugin, with the lowest value being the highest precedence. Minimum of 1. This is used when doing data consolidation when reporting current state data. Lower numbers results in a higher precedence (i.e. 1 is higher precedence than 10). If not specified during creation, this will be automatically set to 1 for the first plugin created, then 1 greater for each subsequently created plugin (i.e. 1 for plugin1, 2 for plugin2, etc). It is always set to 1 greater than the plugin with the greatest precedence number (i.e. 11 if two plugins exist with precedence 1 and 10). |
| state | PluginState | No | No |
The current state of the plugin. Defaults to PluginState.STOPPED. |
Represents the current state of a plugin.
| Value | Description |
|---|---|
| STOPPED | The plugin is created and ready for use, but is not currently receiving any events |
| STARTED | The plugin is currently receiving events and is working correctly. |
| PAUSED | The plugin is currently not receiving any events but is also not stopped. This should be used when polling or other events should stop only temporarily without firing the stop events. |
| ERRORED | MWS has detected an error with the plugin and has automatically stopped it. Errors could be due to the following reasons:
|
Related Topics