|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ace.mws.reservations.Reservation
class Reservation
A reservation is the mechanism by which Moab guarantees the availability of a set of resources at a particular time. Each reservation consists of three major components: (1) a set of resources, (2) a time frame, and (3) an access control list. It is a scheduler role to ensure that the access control list is not violated during the reservation's lifetime (that is, its time frame) on the resources listed. For example, a reservation may specify that node002 is reserved for user Tom on Friday. The scheduler is thus constrained to make certain that only Tom's jobs can use node002 at any time on Friday.
Field Summary | |
---|---|
private String |
accountingAccount
Accountable Account. |
private String |
accountingGroup
Accountable Group. |
private String |
accountingQOS
Accountable QOS. |
private String |
accountingUser
Accountable User. |
private Set |
aclRules
(AclRule collection) The set of access control rules associated with this reservation. |
private Integer |
allocatedNodeCount
The number of allocated nodes for this reservation. |
private Set |
allocatedNodes
(DomainProxyVersion1 collection) The nodes allocated to the reservation. |
private Integer |
allocatedProcessorCount
The number of allocated processors. |
private Integer |
allocatedTaskCount
The number of allocated tasks. |
private String |
comments
Reservation's comments or description. |
private Date |
creationDate
Creation date. |
private Long |
duration
The duration of the reservation (in seconds). |
private Date |
endDate
The end date of the reservation. |
private Set |
excludeJobs
(String collection) The list of jobs to exclude. |
private Date |
expireDate
The date/time when the reservation expires and vacates. |
private Set |
flags
(ReservationFlag collection) The flags associated with the reservation. |
private String |
globalId
Global reservation ID. |
private String |
hostListExpression
The list of nodes a user can select to reserve. |
private String |
id
The unique ID of the reservation. |
private String |
idPrefix
The user-specified prefix for this reservation. |
private Boolean |
isActive
State whether or not this reservation is currently active. |
private Boolean |
isTracked
States whether reservation resource usage is tracked. |
private String |
label
When a label is assigned to a reservation, the reservation can then be referenced by that label as well as by the reservation name. |
private Integer |
maxTasks
The maximum number of tasks for this reservation. |
private Set |
messages
(MessageVersion1 collection) Messages for the reservation. |
private EmbeddedCredential |
owner
The owner of the reservation Valid during POST. |
private String |
partitionId
The ID of the partition this reservation is for. |
private String |
profile
The profile that this reservation is using. |
private ReservationRequirement |
requirements
The reservation's requirements. |
private String |
reservationGroup
The reservation group to which the reservation belongs. |
private Map |
resources
(Map of String => Integer) The reservation's resources. |
private Date |
startDate
The start time for the reservation. |
private ReservationStatistics |
statistics
The reservation's statistical information. |
private String |
subType
The reservation sub-type. |
private Integer |
taskCount
The number of tasks that must be allocated to satisfy the reservation request. |
private Trigger |
trigger
Trigger for reservation. |
private Set |
triggerIds
(String collection) The IDs of the triggers attached to this reservation. |
private String |
uniqueIndex
The globally-unique reservation index. |
private Map |
variables
(Map of String => String) The set of variables for this reservation. |
Constructor Summary | |
Reservation()
|
Method Summary | |
---|---|
String
|
getAccountingAccount()
Accountable Account. |
String
|
getAccountingGroup()
Accountable Group. |
String
|
getAccountingQOS()
Accountable QOS. |
String
|
getAccountingUser()
Accountable User. |
Set
|
getAclRules()
(AclRule collection) The set of access control rules associated with this reservation. |
Integer
|
getAllocatedNodeCount()
The number of allocated nodes for this reservation. |
Set
|
getAllocatedNodes()
(DomainProxyVersion1 collection) The nodes allocated to the reservation. |
Integer
|
getAllocatedProcessorCount()
The number of allocated processors. |
Integer
|
getAllocatedTaskCount()
The number of allocated tasks. |
String
|
getComments()
Reservation's comments or description. |
Date
|
getCreationDate()
Creation date. |
Long
|
getDuration()
The duration of the reservation (in seconds). |
Date
|
getEndDate()
The end date of the reservation. |
Set
|
getExcludeJobs()
(String collection) The list of jobs to exclude. |
Date
|
getExpireDate()
The date/time when the reservation expires and vacates. |
Set
|
getFlags()
(ReservationFlag collection) The flags associated with the reservation. |
String
|
getGlobalId()
Global reservation ID. |
String
|
getHostListExpression()
The list of nodes a user can select to reserve. |
String
|
getId()
The unique ID of the reservation. |
String
|
getIdPrefix()
The user-specified prefix for this reservation. |
Boolean
|
getIsActive()
State whether or not this reservation is currently active. |
Boolean
|
getIsTracked()
States whether reservation resource usage is tracked. |
String
|
getLabel()
When a label is assigned to a reservation, the reservation can then be referenced by that label as well as by the reservation name. |
Integer
|
getMaxTasks()
The maximum number of tasks for this reservation. |
Set
|
getMessages()
(MessageVersion1 collection) Messages for the reservation. |
EmbeddedCredential
|
getOwner()
The owner of the reservation Valid during POST. |
String
|
getPartitionId()
The ID of the partition this reservation is for. |
String
|
getProfile()
The profile that this reservation is using. |
ReservationRequirement
|
getRequirements()
The reservation's requirements. |
String
|
getReservationGroup()
The reservation group to which the reservation belongs. |
Map
|
getResources()
(Map of String => Integer) The reservation's resources. |
Date
|
getStartDate()
The start time for the reservation. |
ReservationStatistics
|
getStatistics()
The reservation's statistical information. |
String
|
getSubType()
The reservation sub-type. |
Integer
|
getTaskCount()
The number of tasks that must be allocated to satisfy the reservation request. |
Trigger
|
getTrigger()
Trigger for reservation. |
Set
|
getTriggerIds()
(String collection) The IDs of the triggers attached to this reservation. |
String
|
getUniqueIndex()
The globally-unique reservation index. |
Map
|
getVariables()
(Map of String => String) The set of variables for this reservation. |
void
|
setAccountingAccount(String accountingAccount)
Accountable Account. |
void
|
setAccountingGroup(String accountingGroup)
Accountable Group. |
void
|
setAccountingQOS(String accountingQOS)
Accountable QOS. |
void
|
setAccountingUser(String accountingUser)
Accountable User. |
void
|
setAclRules(Set aclRules)
(AclRule collection) The set of access control rules associated with this reservation. |
void
|
setAllocatedNodeCount(Integer allocatedNodeCount)
The number of allocated nodes for this reservation. |
void
|
setAllocatedNodes(Set allocatedNodes)
(DomainProxyVersion1 collection) The nodes allocated to the reservation. |
void
|
setAllocatedProcessorCount(Integer allocatedProcessorCount)
The number of allocated processors. |
void
|
setAllocatedTaskCount(Integer allocatedTaskCount)
The number of allocated tasks. |
void
|
setComments(String comments)
Reservation's comments or description. |
void
|
setCreationDate(Date creationDate)
Creation date. |
void
|
setDuration(Long duration)
The duration of the reservation (in seconds). |
void
|
setEndDate(Date endDate)
The end date of the reservation. |
void
|
setExcludeJobs(Set excludeJobs)
(String collection) The list of jobs to exclude. |
void
|
setExpireDate(Date expireDate)
The date/time when the reservation expires and vacates. |
void
|
setFlags(Set flags)
(ReservationFlag collection) The flags associated with the reservation. |
void
|
setGlobalId(String globalId)
Global reservation ID. |
void
|
setHostListExpression(String hostListExpression)
The list of nodes a user can select to reserve. |
void
|
setId(String id)
The unique ID of the reservation. |
void
|
setIdPrefix(String idPrefix)
The user-specified prefix for this reservation. |
void
|
setIsActive(Boolean isActive)
State whether or not this reservation is currently active. |
void
|
setIsTracked(Boolean isTracked)
States whether reservation resource usage is tracked. |
void
|
setLabel(String label)
When a label is assigned to a reservation, the reservation can then be referenced by that label as well as by the reservation name. |
void
|
setMaxTasks(Integer maxTasks)
The maximum number of tasks for this reservation. |
void
|
setMessages(Set messages)
(MessageVersion1 collection) Messages for the reservation. |
void
|
setOwner(EmbeddedCredential owner)
The owner of the reservation Valid during POST. |
void
|
setPartitionId(String partitionId)
The ID of the partition this reservation is for. |
void
|
setProfile(String profile)
The profile that this reservation is using. |
void
|
setRequirements(ReservationRequirement requirements)
The reservation's requirements. |
void
|
setReservationGroup(String reservationGroup)
The reservation group to which the reservation belongs. |
void
|
setResources(Map resources)
(Map of String => Integer) The reservation's resources. |
void
|
setStartDate(Date startDate)
The start time for the reservation. |
void
|
setStatistics(ReservationStatistics statistics)
The reservation's statistical information. |
void
|
setSubType(String subType)
The reservation sub-type. |
void
|
setTaskCount(Integer taskCount)
The number of tasks that must be allocated to satisfy the reservation request. |
void
|
setTrigger(Trigger trigger)
Trigger for reservation. |
void
|
setTriggerIds(Set triggerIds)
(String collection) The IDs of the triggers attached to this reservation. |
void
|
setUniqueIndex(String uniqueIndex)
The globally-unique reservation index. |
void
|
setVariables(Map variables)
(Map of String => String) The set of variables for this reservation. |
String
|
toString()
|
Methods inherited from class Object | |
---|---|
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
Field Detail |
---|
private String accountingAccount
private String accountingGroup
private String accountingQOS
private String accountingUser
private Set aclRules
private Integer allocatedNodeCount
private Set allocatedNodes
private Integer allocatedProcessorCount
private Integer allocatedTaskCount
private String comments
private Date creationDate
private Long duration
private Date endDate
private Set excludeJobs
private Date expireDate
private Set flags
private String globalId
private String hostListExpression
private String id
private String idPrefix
private Boolean isActive
private Boolean isTracked
private String label
private Integer maxTasks
private Set messages
private EmbeddedCredential owner
private String partitionId
private String profile
private ReservationRequirement requirements
private String reservationGroup
private Map resources
private Date startDate
private ReservationStatistics statistics
private String subType
private Integer taskCount
private Trigger trigger
private Set triggerIds
private String uniqueIndex
private Map variables
Constructor Detail |
---|
Reservation()
Method Detail |
---|
String getAccountingAccount()
String getAccountingGroup()
String getAccountingQOS()
String getAccountingUser()
Set getAclRules()
Integer getAllocatedNodeCount()
Set getAllocatedNodes()
Integer getAllocatedProcessorCount()
Integer getAllocatedTaskCount()
String getComments()
Date getCreationDate()
Long getDuration()
Date getEndDate()
Set getExcludeJobs()
Date getExpireDate()
Set getFlags()
String getGlobalId()
String getHostListExpression()
String getId()
String getIdPrefix()
Boolean getIsActive()
Boolean getIsTracked()
String getLabel()
Integer getMaxTasks()
Set getMessages()
EmbeddedCredential getOwner()
String getPartitionId()
String getProfile()
ReservationRequirement getRequirements()
String getReservationGroup()
Map getResources()
Date getStartDate()
ReservationStatistics getStatistics()
String getSubType()
Integer getTaskCount()
Trigger getTrigger()
Set getTriggerIds()
String getUniqueIndex()
Map getVariables()
void setAccountingAccount(String accountingAccount)
void setAccountingGroup(String accountingGroup)
void setAccountingQOS(String accountingQOS)
void setAccountingUser(String accountingUser)
void setAclRules(Set aclRules)
void setAllocatedNodeCount(Integer allocatedNodeCount)
void setAllocatedNodes(Set allocatedNodes)
void setAllocatedProcessorCount(Integer allocatedProcessorCount)
void setAllocatedTaskCount(Integer allocatedTaskCount)
void setComments(String comments)
void setCreationDate(Date creationDate)
void setDuration(Long duration)
void setEndDate(Date endDate)
void setExcludeJobs(Set excludeJobs)
void setExpireDate(Date expireDate)
void setFlags(Set flags)
void setGlobalId(String globalId)
void setHostListExpression(String hostListExpression)
void setId(String id)
void setIdPrefix(String idPrefix)
void setIsActive(Boolean isActive)
void setIsTracked(Boolean isTracked)
void setLabel(String label)
void setMaxTasks(Integer maxTasks)
void setMessages(Set messages)
void setOwner(EmbeddedCredential owner)
void setPartitionId(String partitionId)
void setProfile(String profile)
void setRequirements(ReservationRequirement requirements)
void setReservationGroup(String reservationGroup)
void setResources(Map resources)
void setStartDate(Date startDate)
void setStatistics(ReservationStatistics statistics)
void setSubType(String subType)
void setTaskCount(Integer taskCount)
void setTrigger(Trigger trigger)
void setTriggerIds(Set triggerIds)
void setUniqueIndex(String uniqueIndex)
void setVariables(Map variables)
String toString()
Groovy Documentation