|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.ace.mws.triggers.Trigger
class Trigger
Field Summary | |
---|---|
private String |
action
For exec atype triggers, signifies executable and arguments. |
private TriggerActionType |
actionType
|
private Date |
blockTime
Time (in seconds) Moab will suspend normal operation to wait for trigger execution to finish. |
private String |
description
|
private TriggerEventType |
eventType
|
private Date |
expireTime
Time at which trigger should be terminated if it has not already been activated. |
private Date |
failOffset
Specifies the time (in seconds) that the threshold condition must exist before the trigger fires. |
private Set |
flags
(TriggerFlag collection) |
private String |
id
Trigger id - internal ID used by moab to track triggers |
private Boolean |
interval
When used in conjunction with MultiFire and RearmTime trigger will fire at regular intervals. |
private Integer |
maxRetry
Specifies the number of times Action will be attempted before the trigger is designated a failure. |
private Boolean |
multiFire
Specifies whether this trigger can fire multiple times. |
private String |
name
Trigger name - can be auto assigned by moab or requested. |
private String |
objectId
The ID of the object which this is attached to. |
private String |
objectType
The type of object which this is attached to. |
private Date |
offset
Relative time offset from event when trigger can fire. |
private TriggerPeriod |
period
Can be used in conjunction with Offset to have a trigger fire at the beginning of the specified period. |
private Date |
rearmTime
Time between MultiFire triggers; rearm time is enforced from the trigger event time. |
private String |
requires
Variables this trigger requires to be set or not set before it will fire. |
private static long |
serialVersionUID
|
private String |
sets
Variable values this trigger sets upon success or failure. |
private String |
threshold
Reservation usage threshold - When reservation usage drops below Threshold, trigger will fire. |
private Date |
timeout
Time allotted to this trigger before it is marked as unsuccessful and its process (if any) killed. |
private String |
unsets
Variable this trigger destroys upon success or failure. |
Constructor Summary | |
Trigger()
|
Method Summary | |
---|---|
String
|
getAction()
For exec atype triggers, signifies executable and arguments. |
TriggerActionType
|
getActionType()
|
Date
|
getBlockTime()
Time (in seconds) Moab will suspend normal operation to wait for trigger execution to finish. |
String
|
getDescription()
|
TriggerEventType
|
getEventType()
|
Date
|
getExpireTime()
Time at which trigger should be terminated if it has not already been activated. |
Date
|
getFailOffset()
Specifies the time (in seconds) that the threshold condition must exist before the trigger fires. |
Set
|
getFlags()
(TriggerFlag collection) |
String
|
getId()
Trigger id - internal ID used by moab to track triggers |
Boolean
|
getInterval()
When used in conjunction with MultiFire and RearmTime trigger will fire at regular intervals. |
Integer
|
getMaxRetry()
Specifies the number of times Action will be attempted before the trigger is designated a failure. |
Boolean
|
getMultiFire()
Specifies whether this trigger can fire multiple times. |
String
|
getName()
Trigger name - can be auto assigned by moab or requested. |
String
|
getObjectId()
The ID of the object which this is attached to. |
String
|
getObjectType()
The type of object which this is attached to. |
Date
|
getOffset()
Relative time offset from event when trigger can fire. |
TriggerPeriod
|
getPeriod()
Can be used in conjunction with Offset to have a trigger fire at the beginning of the specified period. |
Date
|
getRearmTime()
Time between MultiFire triggers; rearm time is enforced from the trigger event time. |
String
|
getRequires()
Variables this trigger requires to be set or not set before it will fire. |
String
|
getSets()
Variable values this trigger sets upon success or failure. |
String
|
getThreshold()
Reservation usage threshold - When reservation usage drops below Threshold, trigger will fire. |
Date
|
getTimeout()
Time allotted to this trigger before it is marked as unsuccessful and its process (if any) killed. |
String
|
getUnsets()
Variable this trigger destroys upon success or failure. |
void
|
setAction(String action)
For exec atype triggers, signifies executable and arguments. |
void
|
setActionType(TriggerActionType actionType)
|
void
|
setBlockTime(Date blockTime)
Time (in seconds) Moab will suspend normal operation to wait for trigger execution to finish. |
void
|
setDescription(String description)
|
void
|
setEventType(TriggerEventType eventType)
|
void
|
setExpireTime(Date expireTime)
Time at which trigger should be terminated if it has not already been activated. |
void
|
setFailOffset(Date failOffset)
Specifies the time (in seconds) that the threshold condition must exist before the trigger fires. |
void
|
setFlags(Set flags)
(TriggerFlag collection) |
void
|
setId(String id)
Trigger id - internal ID used by moab to track triggers |
void
|
setInterval(Boolean interval)
When used in conjunction with MultiFire and RearmTime trigger will fire at regular intervals. |
void
|
setMaxRetry(Integer maxRetry)
Specifies the number of times Action will be attempted before the trigger is designated a failure. |
void
|
setMultiFire(Boolean multiFire)
Specifies whether this trigger can fire multiple times. |
void
|
setName(String name)
Trigger name - can be auto assigned by moab or requested. |
void
|
setObjectId(String objectId)
The ID of the object which this is attached to. |
void
|
setObjectType(String objectType)
The type of object which this is attached to. |
void
|
setOffset(Date offset)
Relative time offset from event when trigger can fire. |
void
|
setPeriod(TriggerPeriod period)
Can be used in conjunction with Offset to have a trigger fire at the beginning of the specified period. |
void
|
setRearmTime(Date rearmTime)
Time between MultiFire triggers; rearm time is enforced from the trigger event time. |
void
|
setRequires(String requires)
Variables this trigger requires to be set or not set before it will fire. |
void
|
setSets(String sets)
Variable values this trigger sets upon success or failure. |
void
|
setThreshold(String threshold)
Reservation usage threshold - When reservation usage drops below Threshold, trigger will fire. |
void
|
setTimeout(Date timeout)
Time allotted to this trigger before it is marked as unsuccessful and its process (if any) killed. |
void
|
setUnsets(String unsets)
Variable this trigger destroys upon success or failure. |
String
|
toString()
|
Methods inherited from class Object | |
---|---|
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
Field Detail |
---|
private String action
private TriggerActionType actionType
private Date blockTime
private String description
private TriggerEventType eventType
private Date expireTime
private Date failOffset
private Set flags
private String id
private Boolean interval
private Integer maxRetry
private Boolean multiFire
private String name
private String objectId
private String objectType
private Date offset
private TriggerPeriod period
private Date rearmTime
private String requires
private static final long serialVersionUID
private String sets
private String threshold
private Date timeout
private String unsets
Constructor Detail |
---|
Trigger()
Method Detail |
---|
String getAction()
TriggerActionType getActionType()
Date getBlockTime()
String getDescription()
TriggerEventType getEventType()
Date getExpireTime()
Date getFailOffset()
Set getFlags()
String getId()
Boolean getInterval()
Integer getMaxRetry()
Boolean getMultiFire()
String getName()
String getObjectId()
String getObjectType()
Date getOffset()
TriggerPeriod getPeriod()
Date getRearmTime()
String getRequires()
String getSets()
String getThreshold()
Date getTimeout()
String getUnsets()
void setAction(String action)
void setActionType(TriggerActionType actionType)
void setBlockTime(Date blockTime)
void setDescription(String description)
void setEventType(TriggerEventType eventType)
void setExpireTime(Date expireTime)
void setFailOffset(Date failOffset)
void setFlags(Set flags)
void setId(String id)
void setInterval(Boolean interval)
void setMaxRetry(Integer maxRetry)
void setMultiFire(Boolean multiFire)
void setName(String name)
void setObjectId(String objectId)
void setObjectType(String objectType)
void setOffset(Date offset)
void setPeriod(TriggerPeriod period)
void setRearmTime(Date rearmTime)
void setRequires(String requires)
void setSets(String sets)
void setThreshold(String threshold)
void setTimeout(Date timeout)
void setUnsets(String unsets)
String toString()
Groovy Documentation