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

com.ace.mws.reservations
[Groovy] Class StandingReservation

java.lang.Object
  com.ace.mws.reservations.StandingReservation

class StandingReservation

This class represents a standing reservation.

A standing reservation is any reservation that is not a one-time reservation. This includes reservations that recur every day or every week, or infinite reservations.

Field Summary
private ReservationAccess access

If set to ReservationAccess#SHARED#SHARED, allows a standing reservation to use resources already allocated to other non-job reservations.

private Set accounts

(String collection) Specifies that jobs with the associated accounts may use the resources contained within this reservation.
private Set aclRules

(AclRule collection) The set of access control rules associated with this standing reservation.
private String chargeAccount

Specifies the account to which Moab will charge all idle cycles within the reservation (via the allocation manager).
private String chargeUser

Specifies the user to which Moab will charge all idle cycles within the reservation (via the allocation manager).
private Set classes

(String collection) Specifies that jobs with the associated classes/queues may use the resources contained within this reservation.
private Set clusters

(String collection) Specifies that jobs originating within the listed clusters may use the resources contained within this reservation.
private String comment

Specifies a descriptive message associated with the standing reservation and all child reservations
private Set days

(String collection) Specifies which days of the week the standing reservation is active.
private Integer depth

Specifies the depth of standing reservations to be created, starting at depth 0 (one per period).
private Boolean disabled

Specifies if the standing reservation should no longer spawn child reservations.
private Long endOffset

The ending offset, in seconds, from the beginning of the current period (DAY or WEEK), for this standing reservation.

private Set flags

(ReservationFlag collection) Specifies special reservation attributes.
private Set groups

(String collection) Specifies the groups allowed access to this standing reservation.
private Set hosts

(String collection) Specifies the set of hosts that the scheduler can search for resources to satisfy the reservation.

private String id

The unique ID of the standing reservation.
private Set jobAttributes

(JobFlag collection) Specifies job attributes that grant a job access to the reservation.
private Integer maxJob

Specifies the maximum number of jobs that can run in the reservation.
private Integer maxTime

Specifies the maximum time for jobs allowable.

private Set messages

(String collection) Messages associated with the reservation.
private Set nodeFeatures

(String collection) Specifies the required node features for nodes that are part of the standing reservation.
private String os

Specifies the operating system that should be in place during the reservation.

private EmbeddedCredential owner

Specifies the owner of the reservation.

private String partition

Specifies the partition in which to create the standing reservation.

private TimeWindow period

Period of the Standing reservation.

private IntLimit procLimit

Specifies the processor limit for jobs requesting access to this standing reservation.
private IntLimit psLimit

Specifies the processor-second limit for jobs requesting access to this standing reservation.
private Set qoses

(String collection) Specifies that jobs with the listed QoS names can access the reserved resources.
private Set reservationAccessList

(Reservation collection) A list of reservations to which the specified reservation has access.
private String reservationGroup

The group of the reservation.
private Map resources

(Map of String => Integer) Specifies what resources constitute a single standing reservation task.

private Integer rollbackOffset

Specifies the minimum time in the future at which the reservation may start.

private Long startOffset

The starting offset, in seconds, from the beginning of the current period (DAY or WEEK), for this standing reservation.

private Integer taskCount

Specifies how many tasks should be reserved for the reservation
Default is 0 (unlimited tasks).
private Integer tasksPerNode

Specifies the minimum number of tasks per node that must be available on eligible nodes.
private Integer timeLimit

Specifies the maximum allowed overlap between the standing reservation and a job requesting resource access.
private Set triggers

(Trigger collection) Triggers associated with the reservation.
private String type

The type of the reservation.
private Set users

(String collection) Specifies which users have access to the resources reserved by this reservation.
 
Constructor Summary
StandingReservation()

 
Method Summary
ReservationAccess getAccess()

If set to ReservationAccess#SHARED#SHARED, allows a standing reservation to use resources already allocated to other non-job reservations.

Set getAccounts()

(String collection) Specifies that jobs with the associated accounts may use the resources contained within this reservation.
Set getAclRules()

(AclRule collection) The set of access control rules associated with this standing reservation.
String getChargeAccount()

Specifies the account to which Moab will charge all idle cycles within the reservation (via the allocation manager).
String getChargeUser()

Specifies the user to which Moab will charge all idle cycles within the reservation (via the allocation manager).
Set getClasses()

(String collection) Specifies that jobs with the associated classes/queues may use the resources contained within this reservation.
Set getClusters()

(String collection) Specifies that jobs originating within the listed clusters may use the resources contained within this reservation.
String getComment()

Specifies a descriptive message associated with the standing reservation and all child reservations
Set getDays()

(String collection) Specifies which days of the week the standing reservation is active.
Integer getDepth()

Specifies the depth of standing reservations to be created, starting at depth 0 (one per period).
Boolean getDisabled()

Specifies if the standing reservation should no longer spawn child reservations.
Long getEndOffset()

The ending offset, in seconds, from the beginning of the current period (DAY or WEEK), for this standing reservation.

Set getFlags()

(ReservationFlag collection) Specifies special reservation attributes.
Set getGroups()

(String collection) Specifies the groups allowed access to this standing reservation.
Set getHosts()

(String collection) Specifies the set of hosts that the scheduler can search for resources to satisfy the reservation.

String getId()

The unique ID of the standing reservation.
Set getJobAttributes()

(JobFlag collection) Specifies job attributes that grant a job access to the reservation.
Integer getMaxJob()

Specifies the maximum number of jobs that can run in the reservation.
Integer getMaxTime()

Specifies the maximum time for jobs allowable.

Set getMessages()

(String collection) Messages associated with the reservation.
Set getNodeFeatures()

(String collection) Specifies the required node features for nodes that are part of the standing reservation.
String getOs()

Specifies the operating system that should be in place during the reservation.

EmbeddedCredential getOwner()

Specifies the owner of the reservation.

String getPartition()

Specifies the partition in which to create the standing reservation.

TimeWindow getPeriod()

Period of the Standing reservation.

IntLimit getProcLimit()

Specifies the processor limit for jobs requesting access to this standing reservation.
IntLimit getPsLimit()

Specifies the processor-second limit for jobs requesting access to this standing reservation.
Set getQoses()

(String collection) Specifies that jobs with the listed QoS names can access the reserved resources.
Set getReservationAccessList()

(Reservation collection) A list of reservations to which the specified reservation has access.
String getReservationGroup()

The group of the reservation.
Map getResources()

(Map of String => Integer) Specifies what resources constitute a single standing reservation task.

Integer getRollbackOffset()

Specifies the minimum time in the future at which the reservation may start.

Long getStartOffset()

The starting offset, in seconds, from the beginning of the current period (DAY or WEEK), for this standing reservation.

Integer getTaskCount()

Specifies how many tasks should be reserved for the reservation
Default is 0 (unlimited tasks).
Integer getTasksPerNode()

Specifies the minimum number of tasks per node that must be available on eligible nodes.
Integer getTimeLimit()

Specifies the maximum allowed overlap between the standing reservation and a job requesting resource access.
Set getTriggers()

(Trigger collection) Triggers associated with the reservation.
String getType()

The type of the reservation.
Set getUsers()

(String collection) Specifies which users have access to the resources reserved by this reservation.
void setAccess(ReservationAccess access)

If set to ReservationAccess#SHARED#SHARED, allows a standing reservation to use resources already allocated to other non-job reservations.

void setAccounts(Set accounts)

(String collection) Specifies that jobs with the associated accounts may use the resources contained within this reservation.
void setAclRules(Set aclRules)

(AclRule collection) The set of access control rules associated with this standing reservation.
void setChargeAccount(String chargeAccount)

Specifies the account to which Moab will charge all idle cycles within the reservation (via the allocation manager).
void setChargeUser(String chargeUser)

Specifies the user to which Moab will charge all idle cycles within the reservation (via the allocation manager).
void setClasses(Set classes)

(String collection) Specifies that jobs with the associated classes/queues may use the resources contained within this reservation.
void setClusters(Set clusters)

(String collection) Specifies that jobs originating within the listed clusters may use the resources contained within this reservation.
void setComment(String comment)

Specifies a descriptive message associated with the standing reservation and all child reservations
void setDays(Set days)

(String collection) Specifies which days of the week the standing reservation is active.
void setDepth(Integer depth)

Specifies the depth of standing reservations to be created, starting at depth 0 (one per period).
void setDisabled(Boolean disabled)

Specifies if the standing reservation should no longer spawn child reservations.
void setEndOffset(Long endOffset)

The ending offset, in seconds, from the beginning of the current period (DAY or WEEK), for this standing reservation.

void setFlags(Set flags)

(ReservationFlag collection) Specifies special reservation attributes.
void setGroups(Set groups)

(String collection) Specifies the groups allowed access to this standing reservation.
void setHosts(Set hosts)

(String collection) Specifies the set of hosts that the scheduler can search for resources to satisfy the reservation.

void setId(String id)

The unique ID of the standing reservation.
void setJobAttributes(Set jobAttributes)

(JobFlag collection) Specifies job attributes that grant a job access to the reservation.
void setMaxJob(Integer maxJob)

Specifies the maximum number of jobs that can run in the reservation.
void setMaxTime(Integer maxTime)

Specifies the maximum time for jobs allowable.

void setMessages(Set messages)

(String collection) Messages associated with the reservation.
void setNodeFeatures(Set nodeFeatures)

(String collection) Specifies the required node features for nodes that are part of the standing reservation.
void setOs(String os)

Specifies the operating system that should be in place during the reservation.

void setOwner(EmbeddedCredential owner)

Specifies the owner of the reservation.

void setPartition(String partition)

Specifies the partition in which to create the standing reservation.

void setPeriod(TimeWindow period)

Period of the Standing reservation.

void setProcLimit(IntLimit procLimit)

Specifies the processor limit for jobs requesting access to this standing reservation.
void setPsLimit(IntLimit psLimit)

Specifies the processor-second limit for jobs requesting access to this standing reservation.
void setQoses(Set qoses)

(String collection) Specifies that jobs with the listed QoS names can access the reserved resources.
void setReservationAccessList(Set reservationAccessList)

(Reservation collection) A list of reservations to which the specified reservation has access.
void setReservationGroup(String reservationGroup)

The group of the reservation.
void setResources(Map resources)

(Map of String => Integer) Specifies what resources constitute a single standing reservation task.

void setRollbackOffset(Integer rollbackOffset)

Specifies the minimum time in the future at which the reservation may start.

void setStartOffset(Long startOffset)

The starting offset, in seconds, from the beginning of the current period (DAY or WEEK), for this standing reservation.

void setTaskCount(Integer taskCount)

Specifies how many tasks should be reserved for the reservation
Default is 0 (unlimited tasks).
void setTasksPerNode(Integer tasksPerNode)

Specifies the minimum number of tasks per node that must be available on eligible nodes.
void setTimeLimit(Integer timeLimit)

Specifies the maximum allowed overlap between the standing reservation and a job requesting resource access.
void setTriggers(Set triggers)

(Trigger collection) Triggers associated with the reservation.
void setType(String type)

The type of the reservation.
void setUsers(Set users)

(String collection) Specifies which users have access to the resources reserved by this reservation.
String toString()

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

Field Detail

access

private ReservationAccess access
If set to ReservationAccess#SHARED#SHARED, allows a standing reservation to use resources already allocated to other non-job reservations. Otherwise, these other reservations block resource access.

accounts

private Set accounts
(String collection) Specifies that jobs with the associated accounts may use the resources contained within this reservation.
See Also:
String

aclRules

private Set aclRules
(AclRule collection) The set of access control rules associated with this standing reservation.
See Also:
AclRule

chargeAccount

private String chargeAccount
Specifies the account to which Moab will charge all idle cycles within the reservation (via the allocation manager).

chargeUser

private String chargeUser
Specifies the user to which Moab will charge all idle cycles within the reservation (via the allocation manager).
Must be used in conjunction with chargeAccount

classes

private Set classes
(String collection) Specifies that jobs with the associated classes/queues may use the resources contained within this reservation.
See Also:
String

clusters

private Set clusters
(String collection) Specifies that jobs originating within the listed clusters may use the resources contained within this reservation.
See Also:
String

comment

private String comment
Specifies a descriptive message associated with the standing reservation and all child reservations

days

private Set days
(String collection) Specifies which days of the week the standing reservation is active.
Valid values are Mon, Tue, Wed, Thu, Fri, Sat, Sun, or [ALL].
See Also:
String

depth

private Integer depth
Specifies the depth of standing reservations to be created, starting at depth 0 (one per period).

disabled

private Boolean disabled
Specifies if the standing reservation should no longer spawn child reservations.

endOffset

private Long endOffset
The ending offset, in seconds, from the beginning of the current period (DAY or WEEK), for this standing reservation. See examples at startOffset.

flags

private Set flags
(ReservationFlag collection) Specifies special reservation attributes.
See Also:
ReservationFlag

groups

private Set groups
(String collection) Specifies the groups allowed access to this standing reservation.
See Also:
String

hosts

private Set hosts
(String collection) Specifies the set of hosts that the scheduler can search for resources to satisfy the reservation. If specified using the class:X format, Moab only selects hosts that support the specified class. If TASKCOUNT is also specified, only TASKCOUNT tasks are reserved. Otherwise, all matching hosts are reserved.
See Also:
String

id

private String id
The unique ID of the standing reservation.

jobAttributes

private Set jobAttributes
(JobFlag collection) Specifies job attributes that grant a job access to the reservation.
Values can be specified with a != assignment to only allow jobs NOT requesting a certain feature inside the reservation.
See Also:
JobFlag

maxJob

private Integer maxJob
Specifies the maximum number of jobs that can run in the reservation.

maxTime

private Integer maxTime
Specifies the maximum time for jobs allowable. Can be used with affinity to attract jobs with same maxTime.

messages

private Set messages
(String collection) Messages associated with the reservation.
See Also:
String

nodeFeatures

private Set nodeFeatures
(String collection) Specifies the required node features for nodes that are part of the standing reservation.
See Also:
String

os

private String os
Specifies the operating system that should be in place during the reservation. Moab provisions this OS at reservation start and restores the original OS at reservation completion.

owner

private EmbeddedCredential owner
Specifies the owner of the reservation. Setting ownership for a reservation grants the user management privileges, including the power to release it.
Setting a user as the owner of a reservation gives that user privileges to query and release the reservation.
For sandbox reservations, sandboxes are applied to a specific peer only if owner is set to CLUSTER:<PEERNAME>

partition

private String partition
Specifies the partition in which to create the standing reservation. Defaults to ALL.

period

private TimeWindow period
Period of the Standing reservation. Defaults to TimeWindow#DAY#DAY.

procLimit

private IntLimit procLimit
Specifies the processor limit for jobs requesting access to this standing reservation.

psLimit

private IntLimit psLimit
Specifies the processor-second limit for jobs requesting access to this standing reservation.

qoses

private Set qoses
(String collection) Specifies that jobs with the listed QoS names can access the reserved resources.
See Also:
String

reservationAccessList

private Set reservationAccessList
(Reservation collection) A list of reservations to which the specified reservation has access.
See Also:
Reservation

reservationGroup

private String reservationGroup
The group of the reservation.

resources

private Map resources
(Map of String => Integer) Specifies what resources constitute a single standing reservation task. (Each task must be able to obtain all of its resources as an atomic unit on a single node.)
Supported resources currently include the following:
See Also:
Integer

rollbackOffset

private Integer rollbackOffset
Specifies the minimum time in the future at which the reservation may start. This offset is rolling meaning the start time of the reservation will continuously roll back into the future to maintain this offset. Rollback offsets are a good way of providing guaranteed resource access to users under the conditions that they must commit their resources in the future or lose dedicated access. See QoS for more info about quality of service and service level agreements.

startOffset

private Long startOffset
The starting offset, in seconds, from the beginning of the current period (DAY or WEEK), for this standing reservation. If period is DAY, the offset is from midnight (00:00) of the current day. If period is WEEK, the offset is from midnight Sunday of the current week.

Example 1: For a standing reservation that begins at 9:00 and ends at 17:00 every day, period is DAY, startOffset is 32400 (9*60*60), and endOffset is 61200 (17*60*60).

Example 2: For a standing reservation that begins at 9:00 Monday and ends at 17:00 Friday every week, period is WEEK, startOffset is 118800 ((24+9)*60*60), and endOffset is 493200 (((5*24)+17)*60*60).

taskCount

private Integer taskCount
Specifies how many tasks should be reserved for the reservation
Default is 0 (unlimited tasks).

tasksPerNode

private Integer tasksPerNode
Specifies the minimum number of tasks per node that must be available on eligible nodes.
Default is 0 (no TPN constraint)

timeLimit

private Integer timeLimit
Specifies the maximum allowed overlap between the standing reservation and a job requesting resource access.
Default is null (-1 in moab)

triggers

private Set triggers
(Trigger collection) Triggers associated with the reservation.
See Also:
Trigger

type

private String type
The type of the reservation.

users

private Set users
(String collection) Specifies which users have access to the resources reserved by this reservation.
See Also:
String

 
Constructor Detail

StandingReservation

StandingReservation()

 
Method Detail

getAccess

ReservationAccess getAccess()
If set to ReservationAccess#SHARED#SHARED, allows a standing reservation to use resources already allocated to other non-job reservations. Otherwise, these other reservations block resource access.

getAccounts

Set getAccounts()
(String collection) Specifies that jobs with the associated accounts may use the resources contained within this reservation.
See Also:
String

getAclRules

Set getAclRules()
(AclRule collection) The set of access control rules associated with this standing reservation.
See Also:
AclRule

getChargeAccount

String getChargeAccount()
Specifies the account to which Moab will charge all idle cycles within the reservation (via the allocation manager).

getChargeUser

String getChargeUser()
Specifies the user to which Moab will charge all idle cycles within the reservation (via the allocation manager).
Must be used in conjunction with chargeAccount

getClasses

Set getClasses()
(String collection) Specifies that jobs with the associated classes/queues may use the resources contained within this reservation.
See Also:
String

getClusters

Set getClusters()
(String collection) Specifies that jobs originating within the listed clusters may use the resources contained within this reservation.
See Also:
String

getComment

String getComment()
Specifies a descriptive message associated with the standing reservation and all child reservations

getDays

Set getDays()
(String collection) Specifies which days of the week the standing reservation is active.
Valid values are Mon, Tue, Wed, Thu, Fri, Sat, Sun, or [ALL].
See Also:
String

getDepth

Integer getDepth()
Specifies the depth of standing reservations to be created, starting at depth 0 (one per period).

getDisabled

Boolean getDisabled()
Specifies if the standing reservation should no longer spawn child reservations.

getEndOffset

Long getEndOffset()
The ending offset, in seconds, from the beginning of the current period (DAY or WEEK), for this standing reservation. See examples at startOffset.

getFlags

Set getFlags()
(ReservationFlag collection) Specifies special reservation attributes.
See Also:
ReservationFlag

getGroups

Set getGroups()
(String collection) Specifies the groups allowed access to this standing reservation.
See Also:
String

getHosts

Set getHosts()
(String collection) Specifies the set of hosts that the scheduler can search for resources to satisfy the reservation. If specified using the class:X format, Moab only selects hosts that support the specified class. If TASKCOUNT is also specified, only TASKCOUNT tasks are reserved. Otherwise, all matching hosts are reserved.
See Also:
String

getId

String getId()
The unique ID of the standing reservation.

getJobAttributes

Set getJobAttributes()
(JobFlag collection) Specifies job attributes that grant a job access to the reservation.
Values can be specified with a != assignment to only allow jobs NOT requesting a certain feature inside the reservation.
See Also:
JobFlag

getMaxJob

Integer getMaxJob()
Specifies the maximum number of jobs that can run in the reservation.

getMaxTime

Integer getMaxTime()
Specifies the maximum time for jobs allowable. Can be used with affinity to attract jobs with same maxTime.

getMessages

Set getMessages()
(String collection) Messages associated with the reservation.
See Also:
String

getNodeFeatures

Set getNodeFeatures()
(String collection) Specifies the required node features for nodes that are part of the standing reservation.
See Also:
String

getOs

String getOs()
Specifies the operating system that should be in place during the reservation. Moab provisions this OS at reservation start and restores the original OS at reservation completion.

getOwner

EmbeddedCredential getOwner()
Specifies the owner of the reservation. Setting ownership for a reservation grants the user management privileges, including the power to release it.
Setting a user as the owner of a reservation gives that user privileges to query and release the reservation.
For sandbox reservations, sandboxes are applied to a specific peer only if owner is set to CLUSTER:<PEERNAME>

getPartition

String getPartition()
Specifies the partition in which to create the standing reservation. Defaults to ALL.

getPeriod

TimeWindow getPeriod()
Period of the Standing reservation. Defaults to TimeWindow#DAY#DAY.

getProcLimit

IntLimit getProcLimit()
Specifies the processor limit for jobs requesting access to this standing reservation.

getPsLimit

IntLimit getPsLimit()
Specifies the processor-second limit for jobs requesting access to this standing reservation.

getQoses

Set getQoses()
(String collection) Specifies that jobs with the listed QoS names can access the reserved resources.
See Also:
String

getReservationAccessList

Set getReservationAccessList()
(Reservation collection) A list of reservations to which the specified reservation has access.
See Also:
Reservation

getReservationGroup

String getReservationGroup()
The group of the reservation.

getResources

Map getResources()
(Map of String => Integer) Specifies what resources constitute a single standing reservation task. (Each task must be able to obtain all of its resources as an atomic unit on a single node.)
Supported resources currently include the following:
See Also:
Integer

getRollbackOffset

Integer getRollbackOffset()
Specifies the minimum time in the future at which the reservation may start. This offset is rolling meaning the start time of the reservation will continuously roll back into the future to maintain this offset. Rollback offsets are a good way of providing guaranteed resource access to users under the conditions that they must commit their resources in the future or lose dedicated access. See QoS for more info about quality of service and service level agreements.

getStartOffset

Long getStartOffset()
The starting offset, in seconds, from the beginning of the current period (DAY or WEEK), for this standing reservation. If period is DAY, the offset is from midnight (00:00) of the current day. If period is WEEK, the offset is from midnight Sunday of the current week.

Example 1: For a standing reservation that begins at 9:00 and ends at 17:00 every day, period is DAY, startOffset is 32400 (9*60*60), and endOffset is 61200 (17*60*60).

Example 2: For a standing reservation that begins at 9:00 Monday and ends at 17:00 Friday every week, period is WEEK, startOffset is 118800 ((24+9)*60*60), and endOffset is 493200 (((5*24)+17)*60*60).

getTaskCount

Integer getTaskCount()
Specifies how many tasks should be reserved for the reservation
Default is 0 (unlimited tasks).

getTasksPerNode

Integer getTasksPerNode()
Specifies the minimum number of tasks per node that must be available on eligible nodes.
Default is 0 (no TPN constraint)

getTimeLimit

Integer getTimeLimit()
Specifies the maximum allowed overlap between the standing reservation and a job requesting resource access.
Default is null (-1 in moab)

getTriggers

Set getTriggers()
(Trigger collection) Triggers associated with the reservation.
See Also:
Trigger

getType

String getType()
The type of the reservation.

getUsers

Set getUsers()
(String collection) Specifies which users have access to the resources reserved by this reservation.
See Also:
String

setAccess

void setAccess(ReservationAccess access)
If set to ReservationAccess#SHARED#SHARED, allows a standing reservation to use resources already allocated to other non-job reservations. Otherwise, these other reservations block resource access.

setAccounts

void setAccounts(Set accounts)
(String collection) Specifies that jobs with the associated accounts may use the resources contained within this reservation.
See Also:
String

setAclRules

void setAclRules(Set aclRules)
(AclRule collection) The set of access control rules associated with this standing reservation.
See Also:
AclRule

setChargeAccount

void setChargeAccount(String chargeAccount)
Specifies the account to which Moab will charge all idle cycles within the reservation (via the allocation manager).

setChargeUser

void setChargeUser(String chargeUser)
Specifies the user to which Moab will charge all idle cycles within the reservation (via the allocation manager).
Must be used in conjunction with chargeAccount

setClasses

void setClasses(Set classes)
(String collection) Specifies that jobs with the associated classes/queues may use the resources contained within this reservation.
See Also:
String

setClusters

void setClusters(Set clusters)
(String collection) Specifies that jobs originating within the listed clusters may use the resources contained within this reservation.
See Also:
String

setComment

void setComment(String comment)
Specifies a descriptive message associated with the standing reservation and all child reservations

setDays

void setDays(Set days)
(String collection) Specifies which days of the week the standing reservation is active.
Valid values are Mon, Tue, Wed, Thu, Fri, Sat, Sun, or [ALL].
See Also:
String

setDepth

void setDepth(Integer depth)
Specifies the depth of standing reservations to be created, starting at depth 0 (one per period).

setDisabled

void setDisabled(Boolean disabled)
Specifies if the standing reservation should no longer spawn child reservations.

setEndOffset

void setEndOffset(Long endOffset)
The ending offset, in seconds, from the beginning of the current period (DAY or WEEK), for this standing reservation. See examples at startOffset.

setFlags

void setFlags(Set flags)
(ReservationFlag collection) Specifies special reservation attributes.
See Also:
ReservationFlag

setGroups

void setGroups(Set groups)
(String collection) Specifies the groups allowed access to this standing reservation.
See Also:
String

setHosts

void setHosts(Set hosts)
(String collection) Specifies the set of hosts that the scheduler can search for resources to satisfy the reservation. If specified using the class:X format, Moab only selects hosts that support the specified class. If TASKCOUNT is also specified, only TASKCOUNT tasks are reserved. Otherwise, all matching hosts are reserved.
See Also:
String

setId

void setId(String id)
The unique ID of the standing reservation.

setJobAttributes

void setJobAttributes(Set jobAttributes)
(JobFlag collection) Specifies job attributes that grant a job access to the reservation.
Values can be specified with a != assignment to only allow jobs NOT requesting a certain feature inside the reservation.
See Also:
JobFlag

setMaxJob

void setMaxJob(Integer maxJob)
Specifies the maximum number of jobs that can run in the reservation.

setMaxTime

void setMaxTime(Integer maxTime)
Specifies the maximum time for jobs allowable. Can be used with affinity to attract jobs with same maxTime.

setMessages

void setMessages(Set messages)
(String collection) Messages associated with the reservation.
See Also:
String

setNodeFeatures

void setNodeFeatures(Set nodeFeatures)
(String collection) Specifies the required node features for nodes that are part of the standing reservation.
See Also:
String

setOs

void setOs(String os)
Specifies the operating system that should be in place during the reservation. Moab provisions this OS at reservation start and restores the original OS at reservation completion.

setOwner

void setOwner(EmbeddedCredential owner)
Specifies the owner of the reservation. Setting ownership for a reservation grants the user management privileges, including the power to release it.
Setting a user as the owner of a reservation gives that user privileges to query and release the reservation.
For sandbox reservations, sandboxes are applied to a specific peer only if owner is set to CLUSTER:<PEERNAME>

setPartition

void setPartition(String partition)
Specifies the partition in which to create the standing reservation. Defaults to ALL.

setPeriod

void setPeriod(TimeWindow period)
Period of the Standing reservation. Defaults to TimeWindow#DAY#DAY.

setProcLimit

void setProcLimit(IntLimit procLimit)
Specifies the processor limit for jobs requesting access to this standing reservation.

setPsLimit

void setPsLimit(IntLimit psLimit)
Specifies the processor-second limit for jobs requesting access to this standing reservation.

setQoses

void setQoses(Set qoses)
(String collection) Specifies that jobs with the listed QoS names can access the reserved resources.
See Also:
String

setReservationAccessList

void setReservationAccessList(Set reservationAccessList)
(Reservation collection) A list of reservations to which the specified reservation has access.
See Also:
Reservation

setReservationGroup

void setReservationGroup(String reservationGroup)
The group of the reservation.

setResources

void setResources(Map resources)
(Map of String => Integer) Specifies what resources constitute a single standing reservation task. (Each task must be able to obtain all of its resources as an atomic unit on a single node.)
Supported resources currently include the following:
See Also:
Integer

setRollbackOffset

void setRollbackOffset(Integer rollbackOffset)
Specifies the minimum time in the future at which the reservation may start. This offset is rolling meaning the start time of the reservation will continuously roll back into the future to maintain this offset. Rollback offsets are a good way of providing guaranteed resource access to users under the conditions that they must commit their resources in the future or lose dedicated access. See QoS for more info about quality of service and service level agreements.

setStartOffset

void setStartOffset(Long startOffset)
The starting offset, in seconds, from the beginning of the current period (DAY or WEEK), for this standing reservation. If period is DAY, the offset is from midnight (00:00) of the current day. If period is WEEK, the offset is from midnight Sunday of the current week.

Example 1: For a standing reservation that begins at 9:00 and ends at 17:00 every day, period is DAY, startOffset is 32400 (9*60*60), and endOffset is 61200 (17*60*60).

Example 2: For a standing reservation that begins at 9:00 Monday and ends at 17:00 Friday every week, period is WEEK, startOffset is 118800 ((24+9)*60*60), and endOffset is 493200 (((5*24)+17)*60*60).

setTaskCount

void setTaskCount(Integer taskCount)
Specifies how many tasks should be reserved for the reservation
Default is 0 (unlimited tasks).

setTasksPerNode

void setTasksPerNode(Integer tasksPerNode)
Specifies the minimum number of tasks per node that must be available on eligible nodes.
Default is 0 (no TPN constraint)

setTimeLimit

void setTimeLimit(Integer timeLimit)
Specifies the maximum allowed overlap between the standing reservation and a job requesting resource access.
Default is null (-1 in moab)

setTriggers

void setTriggers(Set triggers)
(Trigger collection) Triggers associated with the reservation.
See Also:
Trigger

setType

void setType(String type)
The type of the reservation.

setUsers

void setUsers(Set users)
(String collection) Specifies which users have access to the resources reserved by this reservation.
See Also:
String

toString

String toString()

 

Groovy Documentation