|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 Integer |
endTime
Specifies the time of day the standing reservation period ends (end of day or end of week depending on period). |
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 Credential |
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 static long |
serialVersionUID
|
private Integer |
startTime
Specifies the time of day/week the standing reservation becomes active. |
private Integer |
taskCount
Specifies how many tasks should be reserved for the reservation |
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. |
Integer
|
getEndTime()
Specifies the time of day the standing reservation period ends (end of day or end of week depending on period). |
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. |
Credential
|
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. |
Integer
|
getStartTime()
Specifies the time of day/week the standing reservation becomes active. |
Integer
|
getTaskCount()
Specifies how many tasks should be reserved for the reservation |
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
|
setEndTime(Integer endTime)
Specifies the time of day the standing reservation period ends (end of day or end of week depending on period). |
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(Credential 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
|
setStartTime(Integer startTime)
Specifies the time of day/week the standing reservation becomes active. |
void
|
setTaskCount(Integer taskCount)
Specifies how many tasks should be reserved for the reservation |
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 |
---|
private ReservationAccess access
private Set accounts
private Set aclRules
private String chargeAccount
private String chargeUser
private Set classes
private Set clusters
private String comment
private Set days
private Integer depth
private Boolean disabled
private Integer endTime
private Set flags
private Set groups
private Set hosts
private String id
private Set jobAttributes
private Integer maxJob
private Integer maxTime
private Set messages
private Set nodeFeatures
private String os
private Credential owner
private String partition
private TimeWindow period
private IntLimit procLimit
private IntLimit psLimit
private Set qoses
private Set reservationAccessList
private String reservationGroup
private Map resources
private Integer rollbackOffset
private static final long serialVersionUID
private Integer startTime
private Integer taskCount
private Integer tasksPerNode
private Integer timeLimit
private Set triggers
private String type
private Set users
Constructor Detail |
---|
StandingReservation()
Method Detail |
---|
ReservationAccess getAccess()
Set getAccounts()
Set getAclRules()
String getChargeAccount()
String getChargeUser()
Set getClasses()
Set getClusters()
String getComment()
Set getDays()
Integer getDepth()
Boolean getDisabled()
Integer getEndTime()
Set getFlags()
Set getGroups()
Set getHosts()
String getId()
Set getJobAttributes()
Integer getMaxJob()
Integer getMaxTime()
Set getMessages()
Set getNodeFeatures()
String getOs()
Credential getOwner()
String getPartition()
TimeWindow getPeriod()
IntLimit getProcLimit()
IntLimit getPsLimit()
Set getQoses()
Set getReservationAccessList()
String getReservationGroup()
Map getResources()
Integer getRollbackOffset()
Integer getStartTime()
Integer getTaskCount()
Integer getTasksPerNode()
Integer getTimeLimit()
Set getTriggers()
String getType()
Set getUsers()
void setAccess(ReservationAccess access)
void setAccounts(Set accounts)
void setAclRules(Set aclRules)
void setChargeAccount(String chargeAccount)
void setChargeUser(String chargeUser)
void setClasses(Set classes)
void setClusters(Set clusters)
void setComment(String comment)
void setDays(Set days)
void setDepth(Integer depth)
void setDisabled(Boolean disabled)
void setEndTime(Integer endTime)
void setFlags(Set flags)
void setGroups(Set groups)
void setHosts(Set hosts)
void setId(String id)
void setJobAttributes(Set jobAttributes)
void setMaxJob(Integer maxJob)
void setMaxTime(Integer maxTime)
void setMessages(Set messages)
void setNodeFeatures(Set nodeFeatures)
void setOs(String os)
void setOwner(Credential owner)
void setPartition(String partition)
void setPeriod(TimeWindow period)
void setProcLimit(IntLimit procLimit)
void setPsLimit(IntLimit psLimit)
void setQoses(Set qoses)
void setReservationAccessList(Set reservationAccessList)
void setReservationGroup(String reservationGroup)
void setResources(Map resources)
void setRollbackOffset(Integer rollbackOffset)
void setStartTime(Integer startTime)
void setTaskCount(Integer taskCount)
void setTasksPerNode(Integer tasksPerNode)
void setTimeLimit(Integer timeLimit)
void setTriggers(Set triggers)
void setType(String type)
void setUsers(Set users)
String toString()
Groovy Documentation