Serialized Form

Package com.ace.moab.api.acl

Class com.ace.moab.api.acl.ACL extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

acl

java.util.Set<E> acl

The set of ACLRule classes that describe the access to a given object in Moab.

Class com.ace.moab.api.acl.ACLRule extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

affinity

ACLAffinity affinity

The affinity of the ACL object. This will default to ACLAffinity.POSITIVE

comparisonOperator

com.moab.api.util.ComparisonOperator comparisonOperator

The type of comparison to make against the ACL object.

object

com.moab.api.scheduler.MoabObject object

The object to compare against.

value

double value

If there is a numerical value associated with the object,

modifiers

java.util.Set<E> modifiers

The set of advanced modifiers for this particular ACLRule description.

Package com.ace.moab.api.connect.exception

Class com.ace.moab.api.connect.exception.AuthenticationException extends com.moab.api.connect.exception.InitialConnectException implements Serializable

Class com.ace.moab.api.connect.exception.MoabCommunicationException extends java.lang.Exception implements Serializable

Package com.ace.moab.api.credential

Class com.ace.moab.api.credential.InvalidCredentialException extends java.lang.RuntimeException implements Serializable

serialVersionUID: 1L

Package com.ace.moab.api.global

Class com.ace.moab.api.global.InvalidMoabArgumentException extends java.lang.RuntimeException implements Serializable

Class com.ace.moab.api.global.MoabLimits extends java.lang.Object implements Serializable

Serialized Fields

softRange

com.moab.api.util.NumberRange<T extends java.lang.Number> softRange

The soft limits. These limits may be violated by Moab if resources exist.

hardRange

com.moab.api.util.NumberRange<T extends java.lang.Number> hardRange

The hard limits. These limits should never be violated by Moab.

Package com.ace.moab.api.jobs

Class com.ace.moab.api.jobs.JobRequirement extends java.lang.Object implements Serializable

Serialized Fields

allocatedNodes

JobAllocatedNodes allocatedNodes

The set of nodes the requirement is allocated to. Cannot be null.

allocatedPartition

java.lang.String allocatedPartition

The partition the requirement asks for. Can be null.

nodeAccessPolicy

NodeAccessPolicy nodeAccessPolicy

The node access policy the requirement asks for. Can be null.

nodeSet

NodeSet nodeSet

The node set that the requirement asks for. Can be null.

perTaskRequirements

Task perTaskRequirements

All per task requirements are in this Task object. If any value is greater than 0, then it is a requirement.

preferredNodeFeatures

java.util.Set<E> preferredNodeFeatures

The list of node features the requirement preferred. Can be null.

requiredArchitecture

java.lang.String requiredArchitecture

The required architecture. Can be null.

requiredClass

java.lang.String requiredClass

The required class/queue. Can be null.

requiredNetwork

java.lang.String requiredNetwork

The required network. Can be null.

requiredNodeCountMinimum

java.lang.Integer requiredNodeCountMinimum

The minimum number of nodes called for by the requirement. Can be null.

requiredNodeDisk

java.lang.Integer requiredNodeDisk

The required disk space in MB across all nodes. Can be null.

requiredNodeFeatures

java.util.Set<E> requiredNodeFeatures

The list of node features the requirement requires. Can be null.

requiredNodeMemory

java.lang.Integer requiredNodeMemory

The required memory in MB across all nodes. Can be null.

requiredNodeProcessors

java.lang.Integer requiredNodeProcessors

The required processors needed on a per node basis. Can be null.

requiredNodeSwap

java.lang.Integer requiredNodeSwap

The required swap in MB across all nodes. Can be null.

requiredOS

java.lang.String requiredOS

The required operating system on each node. Can be null.

requiredPartition

java.lang.String requiredPartition

The required partition. Can be null.

requiredProcessorCountMinimum

java.lang.Integer requiredProcessorCountMinimum

The minimum number of processors called for by the requirement. Can be null.

tasksPerNode

java.lang.Integer tasksPerNode

The number of tasks to map to each node. Can be null.

Class com.ace.moab.api.jobs.MoabJob extends java.lang.Object implements Serializable

Serialized Fields

account

java.lang.String account

The account that this job is to run under for billing purposes. Can be null.

activeDuration

long activeDuration

The duration in seconds the job has spent being active or running.

allocatedNodes

JobAllocatedNodes allocatedNodes

The list of nodes that are allocated to this job. Cannot be null.

blockReason

JobBlockReason blockReason

The reason the job is blocked. Can be null.

bypass

int bypass

The number of times the job has been backfilled.

commandFile

java.lang.String commandFile

The path to the file that is executed when the job runs. This is the script that will actually call all the work of the job. Can be null.

commandLineArguments

java.lang.String commandLineArguments

The string representing the command line arguments passed in when the job is run. Can be null.

completionTime

java.util.Date completionTime

The date the job completed. If null, the job hasn't completed yet.

dedicatedProcSeconds

double dedicatedProcSeconds

Amount of processor seconds dedicated to the job

dynamicJobInformation

DynamicJobInformation dynamicJobInformation

The dynamic job information for the job.

earliestStartDate

java.util.Date earliestStartDate

The system specified minimum start time

earliestStartDateRequested

java.util.Date earliestStartDateRequested

The earliest start date and time requested by the user. Can be null.

effectiveQueueDuration

long effectiveQueueDuration

The duration in seconds the job has been eligible to run in the queue.

expectedState

JobState expectedState

The expected state of the job based on scheduler action. Cannot be null.

flags

JobFlags flags

All the flags that can be set on a job.

genericAttributes

java.util.List<E> genericAttributes

The list of generic attributes the job has requested. Can be null.

group

java.lang.String group

The group the job is run under. Can be null.

holds

java.util.Set<E> holds

The types of holds that are currently on the job. Can be null.

hostList

java.util.Set<E> hostList

The set of hosts/nodes the job is running on. Can be null.

initialWorkingDirectory

java.lang.String initialWorkingDirectory

The path to the directory the job will be started in. Can be null.

isTemplate

boolean isTemplate

If true, this job object is a template; false, otherwise.

jobDependecyList

java.util.List<E> jobDependecyList

The list of dependencies for this job. Can be null.

genericResourcesList

java.util.List<E> genericResourcesList

The list of generic resources for this job. Can be null.

jobID

java.lang.String jobID

The unique ID of the job. Can be null.

jobName

java.lang.String jobName

The user specified name of the job. Can be null.

jobRequirements

java.util.List<E> jobRequirements

The list of job requirements this job has that specifies what it needs to run. Can be null.

latestCompletedDateRequested

java.util.Date latestCompletedDateRequested

The latest completion date requested by the job. Can be null.

masterHost

java.lang.String masterHost

The node/host that the primary task will run on. Can be null.

memoryRequested

int memoryRequested

The amount of memory in MB requested by the job.

messages

java.util.List<E> messages

The list of system set and user specified message. Can be null.

nodeCountRequested

int nodeCountRequested

The number of nodes the job has requested.

notifyTypeList

java.util.Set<E> notifyTypeList

The set of e-mail notify types attached to the job. Can be null.

partitionAccessList

java.util.Set<E> partitionAccessList

The list of partitions that this job has access to. Can be null.

procCountRequested

int procCountRequested

The number of processors the job has requested.

qos

java.lang.String qos

The QoS the job is actually running under. Can be null.

qosRequested

java.lang.String qosRequested

The QoS the job requested. This may not be the actual QoS the job is given based on policies. Can be null.

queue

java.lang.String queue

The class or queue that the job is running in. Can be null.

queueStatus

QueueStatus queueStatus

The status of the job in its queue. The default is QueueStatus.UNKNOWN. Cannot be null.

reservationRequested

java.lang.String reservationRequested

The reservation that job requested. Can be null.

reservationStartDate

java.util.Date reservationStartDate

The actual start date of the reservation the job is running inside of. Can be null.

resourceManagerExtension

java.lang.String resourceManagerExtension

The resource manager extension String that describes information passed to the the resource manager accounting for the job. Can be null.

resourceManagerName

java.lang.String resourceManagerName

The name of the resource manager that is reporting this job. Can be null.

runPriority

long runPriority

The priority to start running the job.

startCount

int startCount

The number of times the job has been started.

startDate

java.util.Date startDate

The actual date the job started. Can be null.

startPriority

long startPriority

The priority used when the job is first starting.

state

JobState state

The Job's current state. Cannot be null;

stdErrorFilePath

java.lang.String stdErrorFilePath

The path to the file containing the standard error of the job. Can be null.

rmStdErrorFilePath

java.lang.String rmStdErrorFilePath

The path to the remote file containing the standard error of the job. Can be null.

stdInputFilePath

java.lang.String stdInputFilePath

The path to the file containing the standard input of the job. Can be null.

rmstdInputFilePath

java.lang.String rmstdInputFilePath

The path to the remote file containing the standard input of the job. Can be null.

stdOutputFilePath

java.lang.String stdOutputFilePath

The path to the file containing the standard output of the job. Can be null.

rmStdOutputFilePath

java.lang.String rmStdOutputFilePath

The path to the remote file containing the standard output of the job. Can be null.

submitDate

java.util.Date submitDate

The time when this job was submitted to Moab

suspendDuration

long suspendDuration

The duration for which the job has been suspended

systemID

java.lang.String systemID

The system ID of the job as reported by an external source. Can be null.

systemJobID

java.lang.String systemJobID

The job ID according to an external source such as a resource manager. Can be null.

systemPriority

long systemPriority

Administrator specified system priority level

templateMatchList

java.util.List<E> templateMatchList

A comma separate list of all job templates this job matches. Can be null.

templateSetList

java.util.List<E> templateSetList

A list of all job templates that were set on this job. Can be null.

user

java.lang.String user

The user that is running the job. Can be null.

userPriority

long userPriority

The user specified priority for the job.

utilizedMemorySeconds

double utilizedMemorySeconds

Amount of memory seconds utilized by the job

utilizedProcSeconds

double utilizedProcSeconds

Amount of processor seconds utilized by the job

variables

java.util.Set<E> variables

The set of variables this job "owns" or sets on completion. Can be null.

wallclockRequested

long wallclockRequested

The wallclock in seconds requested by the job.

vmUsagePolicy

VMUsagePolicy vmUsagePolicy

The requested VM Usage Policy for this job

Package com.ace.moab.api.node

Class com.ace.moab.api.node.MoabNode extends java.lang.Object implements Serializable

Serialized Fields

applStats

java.util.Set<E> applStats

The node's application statistics

architecture

java.lang.String architecture

The node's processor architecture.

availableClasses

java.util.Set<E> availableClasses

The classes that are available to the node. Can be null.

availableEndDate

java.util.Date availableEndDate

The time when the node will stop being available. Can be null.

availableGenericResources

java.util.HashMap<K,V> availableGenericResources

The node's available generic resources. Stored as name and associated amount.

availableMemoryWeight

double availableMemoryWeight

The weight that the available memory is attributing to the node.

availableProcessorWeight

double availableProcessorWeight

The weight that the available processors are attributing to the node.

availableStartDate

java.util.Date availableStartDate

The time when the node will become available. Can be null.

blockReason

java.lang.String blockReason

The reason why jobs are blocked from running on the node.

chargeRate

double chargeRate

Using allocation management and charging policies, this rate will be accounted for when the node is used by a charged job.

comments

java.lang.String comments

User-specified comments regarding the node.

configuredClasses

java.util.Set<E> configuredClasses

The reported by the resource manager for the node. Can be null.

configuredDiskWeight

double configuredDiskWeight

The configured disk usage priority weight reported by the partition that the node is a part of.

configuredMemoryWeight

double configuredMemoryWeight

The configured memory usage priority weight reported by the partition that the node is a part of.

configuredProcessorWeight

double configuredProcessorWeight

The configured processor usage priority weight reported by the partition that the node is a part of.

configuredSwapWeight

double configuredSwapWeight

The configured swap usage priority weight reported by the partition that the node is a part of.

diskAvailable

int diskAvailable

The node's available disk space in MB.

diskTotal

int diskTotal

The node's total disk space in MB.

externalLoad

double externalLoad

The load on the node not attributed to any batch queues.

features

java.util.Set<E> features

The collection of any opaque node features used to describe and categorize the node. Can be null.

genericMetrics

java.util.HashMap<K,V> genericMetrics

The values for the generic metrics for this node.

genericResources

java.util.HashMap<K,V> genericResources

The generic resources attached to this node. With each generic resource there is a name and optionally an associated amount.

hypervisorType

java.lang.String hypervisorType

The hypervisor type. Null if this is not a hypervisor;

iOLoad

double iOLoad

The load reported by the node on its I/O.

isDynamic

boolean isDynamic

If true, the node is associated with a dynamic resource manager.

jobList

java.util.List<E> jobList

The list of jobIDs currently on the node.

load

double load

The current load of the node as a percentage.

loadWeight

double loadWeight

The load priority weight of the node.

maxIOIn

double maxIOIn

The maximum input as a percentage allowed for the node's I/O.

maxIOLoad

double maxIOLoad

The maximum total load as a percentage allowed for the node's I/O.

maxIOOut

double maxIOOut

The maximum output as a percentage allowed for the node's I/O.

maxJob

int maxJob

The maximum number of jobs allowed to run on the node.

maxJobPerUser

int maxJobPerUser

The maximum number of jobs for a single user allowed to run on the node.

maxLoad

double maxLoad

The maximum total load as a percentage allowed on the node.

maxPageIn

double maxPageIn

The maximum total page in allowed on the node.

maxPageOut

double maxPageOut

The maximum total page out allowed on the node.

maxPEPerJob

double maxPEPerJob

The maximum processor equivalence per job allowed on the node.

maxProc

int maxProc

The maximum number of processors available on the node.

maxProcPerClass

int maxProcPerClass

The maximum number of processors per class available on the node.

memoryAvailable

int memoryAvailable

The node's available memory in MB.

memoryTotal

int memoryTotal

The node's total memory in MB.

messages

java.lang.String messages

Diagnostic messages associated with the node.

network

java.lang.String network

The name of the node's network.

networkLoad

double networkLoad

The load of the node's network as a percentage.

nextOS

java.lang.String nextOS

If populated, the next operating system that is currently being provisioned.

nodeAccessPolicy

NodeAccessPolicy nodeAccessPolicy

The node access policy for the node. The default value is null.

nodeID

java.lang.String nodeID

The node's unique identifier.

nodeType

java.lang.String nodeType

The type of the node. This is used for allocation management purposes.

nodeOperations

java.util.Set<E> nodeOperations

The list of operations that can be performed on this node. Can be null.

os

java.lang.String os

The operating system of the node.

osList

java.util.Set<E> osList

The list of potential operating systems for the node.

partition

java.lang.String partition

The partition this node belongs to.

power

NodePower power

The node's power state according to the resource managers reporting this node.

powerPolicy

PowerPolicy powerPolicy

The power policy for this node. The default is static where the power is controlled manually.

powerSelected

NodePower powerSelected

The node's power state that Moab is currently scheduling. This could be different than the actual node power itself.

priority

double priority

The priority associated with the node.

priorityFunction

PriorityFunction priorityFunction

The function used to calculate this node's priority.

processorsAvailable

int processorsAvailable

The node's available processors.

processorsTotal

int processorsTotal

The node's total processors.

procSpeed

int procSpeed

The node's processor speed in MHz.

profilingEnabled

boolean profilingEnabled

Indicates whether statistical profiling is enabled for this node. If set to false, node statistics will not be gathered.

provisionEndTime

java.util.Date provisionEndTime

The estimated end time of provisioning. This value will populated based on the user specified provision configuration.

provisionStartTime

java.util.Date provisionStartTime

The date the provisioning started. If null, provisioning is not occurring.

See Also:

nextOS

rack

int rack

The node's rack location.

reservationCount

int reservationCount

The number of reservations on the node.

reservationList

java.util.List<E> reservationList

The list of reservations' names currently on this node.

reservations

java.util.List<E> reservations

Reservations found on the node.

resources

java.lang.String resources

The list of resources associated with the node.

rmAccessList

java.lang.String rmAccessList

The list of resource managers this node has access to.

rmList

java.lang.String rmList

The list of resource managers associated with this node.

size

int size

The number of slots or size units consumed by the node.

slot

int slot

The node's slot location.

speed

double speed

The relative speed of the node. The speed must be between .1 and 100.0. The default value for speed is 1.0.

speedWeight

double speedWeight

The weight given to the node's speed attribute when calculating jobs' priority on the node.

state

NodeState state

The node's current state.

substate

java.lang.String substate

The substate that will give more information about the status of the VM.

swapAvailable

int swapAvailable

The node's available swap space in MB.

swapTotal

int swapTotal

The node's total swap space in MB.

taskCount

int taskCount

The number of tasks currently running on the node.

totalActiveTime

long totalActiveTime

The epoch time in seconds that the node was tracked as being busy with jobs.

totalAvailableTime

long totalAvailableTime

The epoch time in seconds that the node is available.

totalStatsTime

long totalStatsTime

The epoch time in seconds that stats have been tracked for the node.

totalUpTime

long totalUpTime

The epoch time in seconds that the node was tracked as being up.

usageWeight

double usageWeight

The weight given to the node's speed attribute when calculating jobs' priority on the node.

vms

VMCollection vms

The collection of VMs on the node. Can be null.

Class com.ace.moab.api.node.Nodes extends java.lang.Object implements Serializable

Serialized Fields

nodes

java.util.HashMap<K,V> nodes

A collection of nodes that have node names as keys.

Class com.ace.moab.api.node.NodeSet extends java.lang.Object implements Serializable

Serialized Fields

selection

ResourceSetSelection selection

The selection type that defines what kind of node set to use. Cannot be null.

type

ResourceSetType type

The type of set that the node set is. Cannot be null.

resourceList

java.util.List<E> resourceList

The list of resources that relates to the type of set this is. Can be null.

priority

ResourceSetPriority priority

The priority that allows control over how the best resource set is selected. Can be null.

tolerance

java.lang.Double tolerance

The specification of the percentage difference between the fastest and slowest node. Can be null.

Package com.ace.moab.api.reservation

Class com.ace.moab.api.reservation.Reservation extends java.lang.Object implements Serializable

Serialized Fields

accountingAccount

java.lang.String accountingAccount

Accountable Account

accountingClass

java.lang.String accountingClass

Accountable Class

accountingGroup

java.lang.String accountingGroup

Accountable Group

accountingQOS

java.lang.String accountingQOS

Accountable QOS

accountingUser

java.lang.String accountingUser

Accountable User

acl

ACL acl

The complete list of ACL Objects including users, groups, accounts, classes, and qoses.

allocatedNodes

java.util.Set<E> allocatedNodes

The allocatedNodes of the reservation

allocNodeCount

int allocNodeCount

The number of allocated nodes for this reservation

allocProcCount

int allocProcCount

The Number of allocated Processors

allocTaskCount

int allocTaskCount

Number of allocated Tasks

comments

java.lang.String comments

Reservation's comments

creationDate

java.util.Date creationDate

Creation Date. Automatically set by Moab when a user creates the reservation. It should only be set from parsing moab information sent to MCM

credentials

java.lang.String credentials

The credentials as defined by Moab.

duration

long duration

The duration of the reservation (in seconds)

endDate

java.util.Date endDate

The end date of the reservation. This is especially useful for one time reservations, which have an exact time for when a reservation ends.

expireDate

java.util.Date expireDate

When non-committed reservation expires and vacates

flags

ReservationFlags flags

The flags associated with the reservation

globalID

java.lang.String globalID

The (moab) global name of the reservation

hostListExpression

java.lang.String hostListExpression

The list of nodes a user can select to reserve. This may or may not be the nodes that are currently allocated to this reservation. A user may also request what node attributes are required, in which case this field is null or empty.

isActive

boolean isActive

State whether or not this reservation is currently active

isTracked

boolean isTracked

States if reservation resource usage is tracked

jobInformation

JobReservation jobInformation

Information only associated to reservations of type 'job'

maxTasks

int maxTasks

The maximum number of tasks for this reservation

messages

java.lang.String messages

Messages for the reservation

name

java.lang.String name

The name of the reservation. Can be null or empty as Moab will automatically assign a name to a reservation if none is specified.

nodeSetPolicy

NodeSetPolicy nodeSetPolicy

The node set policy for the reservation.

owner

java.lang.String owner

A string representing the owner of the reservation

partition

com.moab.api.partitions.Partition partition

The partition this reservation is for

profile

java.lang.String profile

The profile that this reservation is using. A Profile is a specification of attributes that all reservations share.

requirements

ReservationRequirements requirements

The reservation's requirements.

Resources

java.lang.String Resources

Reservation's resources

specName

java.lang.String specName

The specifed name for this reservation. This is either a user-specified name or a moab-specified name such as 'system' but it is NOT a unique identifier for this reserveration. The unique identifier would be the specName.Number

startDate

java.util.Date startDate

The start time for the reservation. This is especially useful for one time reservations, which have an exact time for when a reservation starts.

statistics

ReservationStatistics statistics

Reservation's statistical information that Moab reports to MCM

subType

java.lang.String subType

The reservation sub-type. Can be null.

taskCount

int taskCount

How many tasks must be allocated to satisfy the reservation request NOTE: Either hostList or taskCount must be set for Reservation Creation

triggerList

java.util.Set<E> triggerList

Represents triggers that should be attached to this reservation

type

ReservationType type

The type of reservation - could be "User", "Job", etc.

uIndex

java.lang.String uIndex

The globally unique reservation index

variables

java.util.Set<E> variables

Variables associated with the reservation

Class com.ace.moab.api.reservation.ReservationRequirements extends java.lang.Object implements Serializable

Serialized Fields

task

Task task

The task required for the reservation

architecture

java.lang.String architecture

Required architecture

featureList

java.lang.String featureList

Required Feature list

featureMode

java.lang.String featureMode

Required feature mode

network

java.lang.String network

Required network

OS

java.lang.String OS

Required Operating System

nodeCount

int nodeCount

Required amount of nodes

nodeList

java.util.Set<E> nodeList

Required list of nodes

taskCount

int taskCount

Required task count

Class com.ace.moab.api.reservation.Reservations extends java.lang.Object implements Serializable

Serialized Fields

reservations

java.util.HashSet<E> reservations

The reservations contained in this collection.

Class com.ace.moab.api.reservation.ReservationStatistics extends java.lang.Object implements Serializable

Serialized Fields

caps

double caps

The current active processor-seconds in the last reported iteration.

cips

double cips

The current idle processor-seconds in the last reported iteration.

taps

double taps

The total active processor-seconds over the life of the reservation.

tips

double tips

The total idle processor-seconds over the life of the reservation.

Class com.ace.moab.api.reservation.StandingReservation extends Reservation implements Serializable

Serialized Fields

time

ReservationTime time

Time Frame for the Standing reservation

isDisabled

boolean isDisabled

True if reservation is currently disabled

userList

java.lang.String userList

The users allowed on ACL

groupList

java.lang.String groupList

The groups allowed on ACL

qosList

java.lang.String qosList

The quality of service levels allowed in ACL

classList

java.lang.String classList

The class allowed in ACL

accountList

java.lang.String accountList

The accounts allowed in the ACL

allowGridSandbox

boolean allowGridSandbox

True if reservation allows Grid Sandboxing

clusterList

java.lang.String clusterList

The Comma delimited list of clusters for grid sandboxing

Class com.ace.moab.api.reservation.Task extends java.lang.Object implements Serializable

Serialized Fields

procs

int procs

the number of processors

memory

int memory

The amount of memory (in mBs)

disk

int disk

The amount of disk space (in mBs)

swap

int swap

The amount of swap space (in mBs)

genericResources

java.util.Map<K,V> genericResources

The generic resources the task requires. This map is in the format: ,

Package com.ace.moab.api.triggers

Class com.ace.moab.api.triggers.Trigger extends java.lang.Object implements Serializable

Serialized Fields

action

java.lang.String action

If the trigger's action type is exec, this is the path to a executable or script. If the trigger's action type is mail, this is the email message to send to the adminstrator. If the action type is jobpreempt, this is the PREEMPTPOLICY to apply to jobs which are running on allocated resources.

The default value is null.

actionType

TriggerActionType actionType

The kind of action of take when the trigger fires. This value is associated with the trigger attribute AType.

The default value is null.

actualLaunchTime

long actualLaunchTime

The time in epoch time seconds when the trigger was launched. This value is associated with the trigger attribute LaunchTime.

The default value is UNDEFINED.

blockTime

long blockTime

The time (in seconds) Moab will suspend normal operation to wait for trigger execution to finish. This value is associated with the trigger attribute BlockTime.

The default value is UNDEFINED.

description

java.lang.String description

An optional description of trigger. This may not contain any quotes (ie. ' or "). This value is associated with the trigger attribute Description.

The default value is null.

estimatedLaunchTime

long estimatedLaunchTime

The time in epoch time seconds when the trigger could launch. When calculated, this value ignores the required items list so the trigger might not launch at this estimated time if those required items are not met.

eventType

TriggerEventType eventType

The trigger event to be launched when the trigger fires. This value corresponds to the trigger attribute EType.

The default value is null.

failOffset

long failOffset

The time (in seconds) that the threshold condition must exist before the trigger will fire. This value is associated with the trigger attribute FailOffset.

The default value is UNDEFINED.

flags

TriggerFlags flags

Various trigger behaviors and actions.

id

java.lang.String id

The trigger's unique ID assigned by Moab.

The default value is null.

isFailureDetected

boolean isFailureDetected

If true, a failure was detected in association to the trigger.

The default value is FALSE.

isTriggerCompleted

boolean isTriggerCompleted

If true, the trigger has completed.

The default value is FALSE.

launchOffset

long launchOffset

The offset when trigger will launch. This value is associated with the trigger attribute Offset. This value can be positive or negative. Specifying '+' or a '-' calculates the launch offset relative to the parent object's duration.

The default value is 0.

message

java.lang.String message

Message from Moab about the trigger.

The default value is null.

name

java.lang.String name

The user-specified name of the trigger. This is used to help keep track of triggers.

The default value is null.

objectID

java.lang.String objectID

The ID of the object the trigger is attached to.

The default value is null.

objectType

java.lang.String objectType

The type of the object that the trigger is attached to.

The default value is null.

period

TriggerPeriod period

The period used in conjunction with offset to have the trigger fire at the beginning of the specified period.

The trigger's period can also be used in association with the event type epoch to create a standing trigger.

The default value is NONE.

processID

int processID

The trigger process ID.

The default value is UNDEFINED.

rearmDelayTime

long rearmDelayTime

If the trigger supports multiple firing this is the time in seconds between when it rearms.

The default value is UNDEFINED.

requiredVariables

java.util.Set<E> requiredVariables

Required items needed before the trigger will launch.

The default value is null.

setVariables

java.util.Set<E> setVariables

Variables that will be set upon trigger completion. These will be set regardless of success or failure.

The default value is null.

standardErrorOutput

java.lang.String standardErrorOutput

The path to the standard error output file from the executable or script started by this trigger if fired.

The default value is null.

standardOutOutput

java.lang.String standardOutOutput

The path to the standard out output file from the executable or script started by this trigger if fired.

The default value is null.

state

TriggerState state

The state of the trigger. This value corresponds to the trigger attribute State.

The default value is IDLE.

threshold

TriggerThreshold threshold

When this threshold is reached, the trigger will fire. The threshold functionality is only applicable to reservations attached to the trigger. This value is associated with the trigger attribute Threshold.

The default value is null.

timeout

long timeout

The time in seconds that Moab will wait for the trigger to end before the trigger is killed. Specifying '+' or a '-' calculates the timeout relative to the parent object's duration. This value is associated with the trigger attribute Timeout.

The default value is 0.

unsetVariables

java.util.Set<E> unsetVariables

Variables the trigger destroys completion. This is done regardless of success or failure.

The default value is null.

Package com.ace.moab.api.variables

Class com.ace.moab.api.variables.Variable extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the variable.

value

java.lang.String value

The associated value of the variable. NOTE: value may be NULL, even if name is assigned

Package com.ace.moab.api.vm

Class com.ace.moab.api.vm.VM extends java.lang.Object implements Serializable

Serialized Fields

disk

int disk

The amount of configured disk space in MB.

jobId

java.lang.String jobId

The ID for the job associated with this VM. The association is dependent on which VM flags are set.

id

java.lang.String id

The unique identifier for the VM.

memory

int memory

The amount of memory configured in MB.

nodeId

java.lang.String nodeId

The ID of the physical node that the VM is on.

nodeIndex

int nodeIndex

The index of the node that the VM belongs to. This is simple coordinate information.

os

java.lang.String os

The current operating system of the VM.

osList

java.util.Set<E> osList

The list of potential operating systems that the VM could be turned into.

processors

int processors

The number of virtual processors in the VM.

slot

int slot

The slot of the VM inside a given node.

state

NodeState state

The state of the VM.

substate

java.lang.String substate

The substate that will give more information about the status of the VM.

flags

java.util.Set<E> flags

The flags associated with this VM