Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.ace.mws.plugins
[Groovy] Class PluginInstance

java.lang.Object
  com.ace.mws.plugins.PluginInstance

class PluginInstance

This class represents a configured plugin created from a plugin type.

Field Summary
private Boolean autoStart

Whether the plugin should start automatically when created.

private Map config

(Map of String => Object) The configuration of the plugin.

private Date dateCreated

The date that this plugin was created.

private String id

Unique identifier for the plugin.

private Date lastPollDate

The date of the last polling event that occurred.

private Date lastUpdated

The date that this plugin was last updated.

private Date nextPollDate

The date of the next polling event that is scheduled to occur.

private String pluginType

The plugin name as in Native or Example for the plugin called ExamplePlugin.

private Integer pollInterval

The polling interval to use for the plugin in seconds.

private Long precedence

The precedence of this plugin, with the lowest value being the highest precedence.

private PluginState state

The current state of the plugin.

 
Constructor Summary
PluginInstance()

 
Method Summary
Boolean getAutoStart()

Whether the plugin should start automatically when created.

Map getConfig()

(Map of String => Object) The configuration of the plugin.

Date getDateCreated()

The date that this plugin was created.

String getId()

Unique identifier for the plugin.

Date getLastPollDate()

The date of the last polling event that occurred.

Date getLastUpdated()

The date that this plugin was last updated.

Date getNextPollDate()

The date of the next polling event that is scheduled to occur.

String getPluginType()

The plugin name as in Native or Example for the plugin called ExamplePlugin.

Integer getPollInterval()

The polling interval to use for the plugin in seconds.

Long getPrecedence()

The precedence of this plugin, with the lowest value being the highest precedence.

PluginState getState()

The current state of the plugin.

void setAutoStart(Boolean autoStart)

Whether the plugin should start automatically when created.

void setConfig(Map config)

(Map of String => Object) The configuration of the plugin.

void setDateCreated(Date dateCreated)

The date that this plugin was created.

void setId(String id)

Unique identifier for the plugin.

void setLastPollDate(Date lastPollDate)

The date of the last polling event that occurred.

void setLastUpdated(Date lastUpdated)

The date that this plugin was last updated.

void setNextPollDate(Date nextPollDate)

The date of the next polling event that is scheduled to occur.

void setPluginType(String pluginType)

The plugin name as in Native or Example for the plugin called ExamplePlugin.

void setPollInterval(Integer pollInterval)

The polling interval to use for the plugin in seconds.

void setPrecedence(Long precedence)

The precedence of this plugin, with the lowest value being the highest precedence.

void setState(PluginState state)

The current state of the plugin.

String toString()

 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Field Detail

autoStart

private Boolean autoStart
Whether the plugin should start automatically when created. Valid during create/POST, modify/PUT, and list/show/GET.

config

private Map config
(Map of String => Object) 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. Valid during create/POST, modify/PUT, and list/show/GET.
See Also:
Map

dateCreated

private Date dateCreated
The date that this plugin was created. Valid during list/show/GET.

id

private String id
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.
Valid during create/POST and list/show/GET.

lastPollDate

private Date lastPollDate
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. Valid during list/show/GET.

lastUpdated

private Date lastUpdated
The date that this plugin was last updated. Valid during list/show/GET.

nextPollDate

private Date nextPollDate
The date of the next polling event that is scheduled to occur. This may be null if the plugin is in the STOPPED state. Valid during list/show/GET.

pluginType

private String pluginType
The plugin name as in Native or Example for the plugin called ExamplePlugin. Valid during create/POST and list/show/GET.

pollInterval

private Integer pollInterval
The polling interval to use for the plugin in seconds. This is ignored if the plugin type does not support polling. Valid during create/POST, modify/PUT, and list/show/GET.

precedence

private Long precedence
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

private PluginState state
The current state of the plugin. Defaults to PluginState.STOPPED. Valid during list/show/GET.

 
Constructor Detail

PluginInstance

PluginInstance()

 
Method Detail

getAutoStart

Boolean getAutoStart()
Whether the plugin should start automatically when created. Valid during create/POST, modify/PUT, and list/show/GET.

getConfig

Map getConfig()
(Map of String => Object) 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. Valid during create/POST, modify/PUT, and list/show/GET.
See Also:
Map

getDateCreated

Date getDateCreated()
The date that this plugin was created. Valid during list/show/GET.

getId

String getId()
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.
Valid during create/POST and list/show/GET.

getLastPollDate

Date getLastPollDate()
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. Valid during list/show/GET.

getLastUpdated

Date getLastUpdated()
The date that this plugin was last updated. Valid during list/show/GET.

getNextPollDate

Date getNextPollDate()
The date of the next polling event that is scheduled to occur. This may be null if the plugin is in the STOPPED state. Valid during list/show/GET.

getPluginType

String getPluginType()
The plugin name as in Native or Example for the plugin called ExamplePlugin. Valid during create/POST and list/show/GET.

getPollInterval

Integer getPollInterval()
The polling interval to use for the plugin in seconds. This is ignored if the plugin type does not support polling. Valid during create/POST, modify/PUT, and list/show/GET.

getPrecedence

Long getPrecedence()
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).

getState

PluginState getState()
The current state of the plugin. Defaults to PluginState.STOPPED. Valid during list/show/GET.

setAutoStart

void setAutoStart(Boolean autoStart)
Whether the plugin should start automatically when created. Valid during create/POST, modify/PUT, and list/show/GET.

setConfig

void setConfig(Map config)
(Map of String => Object) 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. Valid during create/POST, modify/PUT, and list/show/GET.
See Also:
Map

setDateCreated

void setDateCreated(Date dateCreated)
The date that this plugin was created. Valid during list/show/GET.

setId

void setId(String id)
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.
Valid during create/POST and list/show/GET.

setLastPollDate

void setLastPollDate(Date lastPollDate)
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. Valid during list/show/GET.

setLastUpdated

void setLastUpdated(Date lastUpdated)
The date that this plugin was last updated. Valid during list/show/GET.

setNextPollDate

void setNextPollDate(Date nextPollDate)
The date of the next polling event that is scheduled to occur. This may be null if the plugin is in the STOPPED state. Valid during list/show/GET.

setPluginType

void setPluginType(String pluginType)
The plugin name as in Native or Example for the plugin called ExamplePlugin. Valid during create/POST and list/show/GET.

setPollInterval

void setPollInterval(Integer pollInterval)
The polling interval to use for the plugin in seconds. This is ignored if the plugin type does not support polling. Valid during create/POST, modify/PUT, and list/show/GET.

setPrecedence

void setPrecedence(Long precedence)
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).

setState

void setState(PluginState state)
The current state of the plugin. Defaults to PluginState.STOPPED. Valid during list/show/GET.

toString

String toString()

 

Groovy Documentation