TriggerFlag (mws)

Overview

Package

Class

Deprecated

Index

Help

Groovy Documentation

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | PROPERTY | METHOD

DETAIL: ENUM CONSTANTS | FIELD | PROPERTY | METHOD

com.ace.mws.triggers
[Groovy] Enum TriggerFlag

java.lang.Object
  com.ace.mws.triggers.TriggerFlag

enum TriggerFlag

This enumeration specifies a flag belonging to a trigger.

Authors:: bsaville

Enum Constant Summary
`ASYNCHRONOUS` An asynchronous trigger.
`ATTACH_ERROR` If the trigger outputs anything to stderr, Moab will attach this as a message to the trigger object.
`CHECKPOINT` Moab should always checkpoint this trigger.
`CLEANUP` If the trigger is still running when the parent object completes or is canceled, the trigger will be killed.
`GENERIC_SYSTEM_JOB` The trigger belongs to a generic system job (for checkpointing).
`GLOBAL_TRIGGER` The trigger will be (or was) inserted into the global trigger list.
`GLOBAL_VARS` The trigger will look in the name space of all nodes with the globalvars flag in addition to its own name space.
`INTERVAL` Trigger is periodic.
`LEAVE_FILES` Do not remove stderr and stdout files.
`MULTIFIRE` Trigger can fire multiple times.
`OBJECT_XML_STDIN` Trigger passes its parent's object XML information into the trigger's stdin.
`PROBE` The trigger's stdout will be monitored.
`PROBE_ALL` The trigger's stdout will be monitored.
`REMOVE_STD_FILES` The trigger will delete stdout/stderr files after it has been reset.
`RESET_ON_MODIFY` The trigger resets if the object it is attached to is modified, even if multifire is not set.
`SOFT_KILL` By default, a `SIGKILL` (kill -9) signal is sent to the kill the script when a trigger times out.
`USER` The trigger will execute under the user ID of the object's owner.

Property Summary
`String`	`name` The name Moab recognizes for a trigger type

Constructor Summary
`private TriggerFlag(String name)`

Method Summary
`static TriggerFlag`	`parseString(String string)` Attempts to parse a string and convert it into a corresponding TriggerFlag enum value.
`TriggerFlag`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`TriggerFlag[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

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

Enum Constant Detail

ASYNCHRONOUS

TriggerFlag ASYNCHRONOUS

An asynchronous trigger.

ATTACH_ERROR

TriggerFlag ATTACH_ERROR

If the trigger outputs anything to stderr, Moab will attach this as a message to the trigger object.

CHECKPOINT

TriggerFlag CHECKPOINT

Moab should always checkpoint this trigger. See Checkpointing Triggers for more information.

CLEANUP

TriggerFlag CLEANUP

If the trigger is still running when the parent object completes or is canceled, the trigger will be killed.

GENERIC_SYSTEM_JOB

TriggerFlag GENERIC_SYSTEM_JOB

The trigger belongs to a generic system job (for checkpointing).

GLOBAL_TRIGGER

TriggerFlag GLOBAL_TRIGGER

The trigger will be (or was) inserted into the global trigger list.

GLOBAL_VARS

TriggerFlag GLOBAL_VARS

The trigger will look in the name space of all nodes with the globalvars flag in addition to its own name space. A specific node to search can be specified using the following format:
globalvars+node_id

INTERVAL

TriggerFlag INTERVAL

Trigger is periodic.

LEAVE_FILES

TriggerFlag LEAVE_FILES

Do not remove stderr and stdout files.

MULTIFIRE

TriggerFlag MULTIFIRE

Trigger can fire multiple times.

OBJECT_XML_STDIN

TriggerFlag OBJECT_XML_STDIN

Trigger passes its parent's object XML information into the trigger's stdin. This only works for exec triggers with reservation type parents.

PROBE

TriggerFlag PROBE

The trigger's stdout will be monitored.

PROBE_ALL

TriggerFlag PROBE_ALL

The trigger's stdout will be monitored.

REMOVE_STD_FILES

TriggerFlag REMOVE_STD_FILES

The trigger will delete stdout/stderr files after it has been reset.

RESET_ON_MODIFY

TriggerFlag RESET_ON_MODIFY

The trigger resets if the object it is attached to is modified, even if multifire is not set.

SOFT_KILL

TriggerFlag SOFT_KILL

By default, a SIGKILL (kill -9) signal is sent to the kill the script when a trigger times out. This flag will instead send a SIGTERM (kill -15) signal to kill the script. The SIGTERM signal will allow the script to trap the signal so that the script can clean up any residual information on the system (instead of just dying, as with the SIGKILL signal).

NOTE: A timed-out trigger will only receive one kill signal. This means that if you specify this flag, a timed-out trigger will only receive the SIGTERM signal, and never the SIGKILL signal.

USER

TriggerFlag USER

The trigger will execute under the user ID of the object's owner. If the parent object is sched, the user to run under may be explicitly specified using the format user+<username>, for example flags=user+john:

Property Detail

name

String name

The name Moab recognizes for a trigger type

Constructor Detail

TriggerFlag

private TriggerFlag(String name)

Method Detail

parseString

static TriggerFlag parseString(String string)

Attempts to parse a string and convert it into a corresponding TriggerFlag enum value.

Parameters:: string - the string to parse into a corresponding TriggerFlag enum value.

Returns:: the corresponding TriggerFlag enum value or null.

valueOf

TriggerFlag valueOf(String name)

Returns the enum constant of this type with the specified name.

values

TriggerFlag[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Groovy Documentation

com.ace.mws.triggers [Groovy] Enum TriggerFlag