Groovy Documentation

com.ace.mws.triggers
[Groovy] Class Trigger

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 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

action

private String action
For exec atype triggers, signifies executable and arguments. For jobpreempt atype triggers, signifies PREEMPTPOLICY to apply to jobs that are running on allocated resources. For changeparam atype triggers, specifies the parameter to change and its new value (using the same syntax and behavior as the changeparam command).


actionType

private TriggerActionType actionType


blockTime

private Date blockTime
Time (in seconds) Moab will suspend normal operation to wait for trigger execution to finish. Use caution as Moab will completely stop normal operation until BlockTime expires.


description

private String description


eventType

private TriggerEventType eventType


expireTime

private Date expireTime
Time at which trigger should be terminated if it has not already been activated.


failOffset

private Date failOffset
Specifies the time (in seconds) that the threshold condition must exist before the trigger fires.


flags

private Set flags
(TriggerFlag collection)


id

private String id
Trigger id - internal ID used by moab to track triggers


interval

private Boolean interval
When used in conjunction with MultiFire and RearmTime trigger will fire at regular intervals. Can be used with TriggerEventType#EPOCH#EPOCH to create a Standing Trigger.
Defaults to false


maxRetry

private Integer maxRetry
Specifies the number of times Action will be attempted before the trigger is designated a failure.


multiFire

private Boolean multiFire
Specifies whether this trigger can fire multiple times. Defaults to false.


name

private String name
Trigger name - can be auto assigned by moab or requested. Alphanumeric up to 16 characters in length


objectId

private String objectId
The ID of the object which this is attached to.


objectType

private String objectType
The type of object which this is attached to. Possible values:


offset

private Date offset
Relative time offset from event when trigger can fire.


period

private TriggerPeriod period
Can be used in conjunction with Offset to have a trigger fire at the beginning of the specified period. Can be used with EType epoch to create a standing trigger.


rearmTime

private Date rearmTime
Time between MultiFire triggers; rearm time is enforced from the trigger event time.


requires

private String requires
Variables this trigger requires to be set or not set before it will fire. Preceding the string with an exclamation mark (!) indicates this variable must NOT be set. Used in conjunction with Sets to create trigger dependencies.


sets

private String sets
Variable values this trigger sets upon success or failure. Preceding the string with an exclamation mark (!) indicates this variable is set upon trigger failure. Preceding the string with a caret (^) indicates this variable is to be exported to the parent object when the current object is destroyed through a completion event. Used in conjunction with Requires to create trigger dependencies.


threshold

private String threshold
Reservation usage threshold - When reservation usage drops below Threshold, trigger will fire.
Threshold usage support is only enabled for reservations and applies to percent processor utilization. gmetric thresholds are supported with job, node, credential, and reservation triggers. See 19.4.3 Threshold Triggers for more information.


timeout

private Date timeout
Time allotted to this trigger before it is marked as unsuccessful and its process (if any) killed.


unsets

private String unsets
Variable this trigger destroys upon success or failure.


 
Constructor Detail

Trigger

Trigger()


 
Method Detail

getAction

String getAction()
For exec atype triggers, signifies executable and arguments. For jobpreempt atype triggers, signifies PREEMPTPOLICY to apply to jobs that are running on allocated resources. For changeparam atype triggers, specifies the parameter to change and its new value (using the same syntax and behavior as the changeparam command).


getActionType

TriggerActionType getActionType()


getBlockTime

Date getBlockTime()
Time (in seconds) Moab will suspend normal operation to wait for trigger execution to finish. Use caution as Moab will completely stop normal operation until BlockTime expires.


getDescription

String getDescription()


getEventType

TriggerEventType getEventType()


getExpireTime

Date getExpireTime()
Time at which trigger should be terminated if it has not already been activated.


getFailOffset

Date getFailOffset()
Specifies the time (in seconds) that the threshold condition must exist before the trigger fires.


getFlags

Set getFlags()
(TriggerFlag collection)


getId

String getId()
Trigger id - internal ID used by moab to track triggers


getInterval

Boolean getInterval()
When used in conjunction with MultiFire and RearmTime trigger will fire at regular intervals. Can be used with TriggerEventType#EPOCH#EPOCH to create a Standing Trigger.
Defaults to false


getMaxRetry

Integer getMaxRetry()
Specifies the number of times Action will be attempted before the trigger is designated a failure.


getMultiFire

Boolean getMultiFire()
Specifies whether this trigger can fire multiple times. Defaults to false.


getName

String getName()
Trigger name - can be auto assigned by moab or requested. Alphanumeric up to 16 characters in length


getObjectId

String getObjectId()
The ID of the object which this is attached to.


getObjectType

String getObjectType()
The type of object which this is attached to. Possible values:


getOffset

Date getOffset()
Relative time offset from event when trigger can fire.


getPeriod

TriggerPeriod getPeriod()
Can be used in conjunction with Offset to have a trigger fire at the beginning of the specified period. Can be used with EType epoch to create a standing trigger.


getRearmTime

Date getRearmTime()
Time between MultiFire triggers; rearm time is enforced from the trigger event time.


getRequires

String getRequires()
Variables this trigger requires to be set or not set before it will fire. Preceding the string with an exclamation mark (!) indicates this variable must NOT be set. Used in conjunction with Sets to create trigger dependencies.


getSets

String getSets()
Variable values this trigger sets upon success or failure. Preceding the string with an exclamation mark (!) indicates this variable is set upon trigger failure. Preceding the string with a caret (^) indicates this variable is to be exported to the parent object when the current object is destroyed through a completion event. Used in conjunction with Requires to create trigger dependencies.


getThreshold

String getThreshold()
Reservation usage threshold - When reservation usage drops below Threshold, trigger will fire.
Threshold usage support is only enabled for reservations and applies to percent processor utilization. gmetric thresholds are supported with job, node, credential, and reservation triggers. See 19.4.3 Threshold Triggers for more information.


getTimeout

Date getTimeout()
Time allotted to this trigger before it is marked as unsuccessful and its process (if any) killed.


getUnsets

String getUnsets()
Variable this trigger destroys upon success or failure.


setAction

void setAction(String action)
For exec atype triggers, signifies executable and arguments. For jobpreempt atype triggers, signifies PREEMPTPOLICY to apply to jobs that are running on allocated resources. For changeparam atype triggers, specifies the parameter to change and its new value (using the same syntax and behavior as the changeparam command).


setActionType

void setActionType(TriggerActionType actionType)


setBlockTime

void setBlockTime(Date blockTime)
Time (in seconds) Moab will suspend normal operation to wait for trigger execution to finish. Use caution as Moab will completely stop normal operation until BlockTime expires.


setDescription

void setDescription(String description)


setEventType

void setEventType(TriggerEventType eventType)


setExpireTime

void setExpireTime(Date expireTime)
Time at which trigger should be terminated if it has not already been activated.


setFailOffset

void setFailOffset(Date failOffset)
Specifies the time (in seconds) that the threshold condition must exist before the trigger fires.


setFlags

void setFlags(Set flags)
(TriggerFlag collection)


setId

void setId(String id)
Trigger id - internal ID used by moab to track triggers


setInterval

void setInterval(Boolean interval)
When used in conjunction with MultiFire and RearmTime trigger will fire at regular intervals. Can be used with TriggerEventType#EPOCH#EPOCH to create a Standing Trigger.
Defaults to false


setMaxRetry

void setMaxRetry(Integer maxRetry)
Specifies the number of times Action will be attempted before the trigger is designated a failure.


setMultiFire

void setMultiFire(Boolean multiFire)
Specifies whether this trigger can fire multiple times. Defaults to false.


setName

void setName(String name)
Trigger name - can be auto assigned by moab or requested. Alphanumeric up to 16 characters in length


setObjectId

void setObjectId(String objectId)
The ID of the object which this is attached to.


setObjectType

void setObjectType(String objectType)
The type of object which this is attached to. Possible values:


setOffset

void setOffset(Date offset)
Relative time offset from event when trigger can fire.


setPeriod

void setPeriod(TriggerPeriod period)
Can be used in conjunction with Offset to have a trigger fire at the beginning of the specified period. Can be used with EType epoch to create a standing trigger.


setRearmTime

void setRearmTime(Date rearmTime)
Time between MultiFire triggers; rearm time is enforced from the trigger event time.


setRequires

void setRequires(String requires)
Variables this trigger requires to be set or not set before it will fire. Preceding the string with an exclamation mark (!) indicates this variable must NOT be set. Used in conjunction with Sets to create trigger dependencies.


setSets

void setSets(String sets)
Variable values this trigger sets upon success or failure. Preceding the string with an exclamation mark (!) indicates this variable is set upon trigger failure. Preceding the string with a caret (^) indicates this variable is to be exported to the parent object when the current object is destroyed through a completion event. Used in conjunction with Requires to create trigger dependencies.


setThreshold

void setThreshold(String threshold)
Reservation usage threshold - When reservation usage drops below Threshold, trigger will fire.
Threshold usage support is only enabled for reservations and applies to percent processor utilization. gmetric thresholds are supported with job, node, credential, and reservation triggers. See 19.4.3 Threshold Triggers for more information.


setTimeout

void setTimeout(Date timeout)
Time allotted to this trigger before it is marked as unsuccessful and its process (if any) killed.


setUnsets

void setUnsets(String unsets)
Variable this trigger destroys upon success or failure.


toString

String toString()


 

Groovy Documentation