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

java.lang.Object
  com.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.

accountingAccount

private String accountingAccount

Accountable Account. Valid during POST.

accountingGroup

private String accountingGroup

Accountable Group. Valid during POST.

accountingQOS

private String accountingQOS

Accountable QOS. Valid during POST.

accountingUser

private String accountingUser

Accountable User. Valid during POST.

aclRules

private Set aclRules

(AclRule collection) The set of access control rules associated with this reservation. Valid during POST.

See Also:

AclRule

allocatedNodeCount

private Integer allocatedNodeCount

The number of allocated nodes for this reservation.

allocatedNodes

private Set allocatedNodes

(DomainProxyVersion1 collection) The nodes allocated to the reservation.

See Also:

DomainProxyVersion1

allocatedProcessorCount

private Integer allocatedProcessorCount

The number of allocated processors.

allocatedTaskCount

private Integer allocatedTaskCount

The number of allocated tasks.

comments

private String comments

Reservation's comments or description. Valid during POST.

creationDate

private Date creationDate

Creation date. Automatically set by Moab when a user creates the reservation.

duration

private Long duration

The duration of the reservation (in seconds). Valid during POST.

endDate

private 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. Valid during POST.

excludeJobs

private Set excludeJobs

(String collection) The list of jobs to exclude. Client must also set the IGNJOBRSV reservation flag. Otherwise, results are undefined. Used only during reservation creation. Valid during POST.

See Also:

String

expireDate

private Date expireDate

The date/time when the reservation expires and vacates.

flags

private Set flags

(ReservationFlag collection) The flags associated with the reservation. Valid during POST.

See Also:

ReservationFlag

globalId

private String globalId

Global reservation ID.

hostListExpression

private 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. Note: Either hostListExpression or taskCount must be set to create a reservation. Valid during POST.

id

private String id

The unique ID of the reservation.

idPrefix

private String idPrefix

The user-specified prefix for this reservation. If provided, Moab combines the idPrefix with an integer, and the combination is the unique identifier for this reservation. Valid during POST.

isActive

private Boolean isActive

State whether or not this reservation is currently active.

isTracked

private Boolean isTracked

States whether reservation resource usage is tracked.

label

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. Valid during POST.

maxTasks

private Integer maxTasks

The maximum number of tasks for this reservation.

messages

private Set messages

(MessageVersion1 collection) Messages for the reservation.

See Also:

MessageVersion1

owner

private EmbeddedCredential owner

The owner of the reservation Valid during POST.

partitionId

private String partitionId

The ID of the partition this reservation is for. Valid during POST.

profile

private String profile

The profile that this reservation is using. A profile is a specification of attributes that all reservations share. Used only during reservation creation. Valid during POST.

requirements

private ReservationRequirement requirements

The reservation's requirements. Valid during POST.

reservationGroup

private String reservationGroup

The reservation group to which the reservation belongs. Valid during POST.

resources

private Map resources

(Map of String => Integer) The reservation's resources. This field is a map, where the key is PROCS, MEM DISK, SWAP, or one or more user-defined keys. Valid during POST.

See Also:

Integer

startDate

private 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. Valid during POST.

statistics

private ReservationStatistics statistics

The reservation's statistical information.

subType

private String subType

The reservation sub-type. Valid during POST.

taskCount

private Integer taskCount

The number of tasks that must be allocated to satisfy the reservation request. Note: Either hostListExpression or taskCount must be set to create a reservation.

trigger

private Trigger trigger

Trigger for reservation. Used only during reservation creation. Valid during POST.

triggerIds

private Set triggerIds

(String collection) The IDs of the triggers attached to this reservation.

See Also:

String

uniqueIndex

private String uniqueIndex

The globally-unique reservation index.

variables

private Map variables

(Map of String => String) The set of variables for this reservation. Valid during PUT. Valid during POST.

See Also:

Map

Reservation

Reservation()

getAccountingAccount

String getAccountingAccount()

Accountable Account. Valid during POST.

getAccountingGroup

String getAccountingGroup()

Accountable Group. Valid during POST.

getAccountingQOS

String getAccountingQOS()

Accountable QOS. Valid during POST.

getAccountingUser

String getAccountingUser()

Accountable User. Valid during POST.

getAclRules

Set getAclRules()

(AclRule collection) The set of access control rules associated with this reservation. Valid during POST.

See Also:

AclRule

getAllocatedNodeCount

Integer getAllocatedNodeCount()

The number of allocated nodes for this reservation.

getAllocatedNodes

Set getAllocatedNodes()

(DomainProxyVersion1 collection) The nodes allocated to the reservation.

See Also:

DomainProxyVersion1

getAllocatedProcessorCount

Integer getAllocatedProcessorCount()

The number of allocated processors.

getAllocatedTaskCount

Integer getAllocatedTaskCount()

The number of allocated tasks.

getComments

String getComments()

Reservation's comments or description. Valid during POST.

getCreationDate

Date getCreationDate()

Creation date. Automatically set by Moab when a user creates the reservation.

getDuration

Long getDuration()

The duration of the reservation (in seconds). Valid during POST.

getEndDate

Date getEndDate()

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

getExcludeJobs

Set getExcludeJobs()

(String collection) The list of jobs to exclude. Client must also set the IGNJOBRSV reservation flag. Otherwise, results are undefined. Used only during reservation creation. Valid during POST.

See Also:

String

getExpireDate

Date getExpireDate()

The date/time when the reservation expires and vacates.

getFlags

Set getFlags()

(ReservationFlag collection) The flags associated with the reservation. Valid during POST.

See Also:

ReservationFlag

getGlobalId

String getGlobalId()

Global reservation ID.

getHostListExpression

String getHostListExpression()

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. Note: Either hostListExpression or taskCount must be set to create a reservation. Valid during POST.

getId

String getId()

The unique ID of the reservation.

getIdPrefix

String getIdPrefix()

The user-specified prefix for this reservation. If provided, Moab combines the idPrefix with an integer, and the combination is the unique identifier for this reservation. Valid during POST.

getIsActive

Boolean getIsActive()

State whether or not this reservation is currently active.

getIsTracked

Boolean getIsTracked()

States whether reservation resource usage is tracked.

getLabel

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. Valid during POST.

getMaxTasks

Integer getMaxTasks()

The maximum number of tasks for this reservation.

getMessages

Set getMessages()

(MessageVersion1 collection) Messages for the reservation.

See Also:

MessageVersion1

getOwner

EmbeddedCredential getOwner()

The owner of the reservation Valid during POST.

getPartitionId

String getPartitionId()

The ID of the partition this reservation is for. Valid during POST.

getProfile

String getProfile()

The profile that this reservation is using. A profile is a specification of attributes that all reservations share. Used only during reservation creation. Valid during POST.

getRequirements

ReservationRequirement getRequirements()

The reservation's requirements. Valid during POST.

getReservationGroup

String getReservationGroup()

The reservation group to which the reservation belongs. Valid during POST.

getResources

Map getResources()

(Map of String => Integer) The reservation's resources. This field is a map, where the key is PROCS, MEM DISK, SWAP, or one or more user-defined keys. Valid during POST.

See Also:

Integer

getStartDate

Date getStartDate()

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

getStatistics

ReservationStatistics getStatistics()

The reservation's statistical information.

getSubType

String getSubType()

The reservation sub-type. Valid during POST.

getTaskCount

Integer getTaskCount()

The number of tasks that must be allocated to satisfy the reservation request. Note: Either hostListExpression or taskCount must be set to create a reservation.

getTrigger

Trigger getTrigger()

Trigger for reservation. Used only during reservation creation. Valid during POST.

getTriggerIds

Set getTriggerIds()

(String collection) The IDs of the triggers attached to this reservation.

See Also:

String

getUniqueIndex

String getUniqueIndex()

The globally-unique reservation index.

getVariables

Map getVariables()

(Map of String => String) The set of variables for this reservation. Valid during PUT. Valid during POST.

See Also:

Map

setAccountingAccount

void setAccountingAccount(String accountingAccount)

Accountable Account. Valid during POST.

setAccountingGroup

void setAccountingGroup(String accountingGroup)

Accountable Group. Valid during POST.

setAccountingQOS

void setAccountingQOS(String accountingQOS)

Accountable QOS. Valid during POST.

setAccountingUser

void setAccountingUser(String accountingUser)

Accountable User. Valid during POST.

setAclRules

void setAclRules(Set aclRules)

(AclRule collection) The set of access control rules associated with this reservation. Valid during POST.

See Also:

AclRule

setAllocatedNodeCount

void setAllocatedNodeCount(Integer allocatedNodeCount)

The number of allocated nodes for this reservation.

setAllocatedNodes

void setAllocatedNodes(Set allocatedNodes)

(DomainProxyVersion1 collection) The nodes allocated to the reservation.

See Also:

DomainProxyVersion1

setAllocatedProcessorCount

void setAllocatedProcessorCount(Integer allocatedProcessorCount)

The number of allocated processors.

setAllocatedTaskCount

void setAllocatedTaskCount(Integer allocatedTaskCount)

The number of allocated tasks.

setComments

void setComments(String comments)

Reservation's comments or description. Valid during POST.

setCreationDate

void setCreationDate(Date creationDate)

Creation date. Automatically set by Moab when a user creates the reservation.

setDuration

void setDuration(Long duration)

The duration of the reservation (in seconds). Valid during POST.

setEndDate

void setEndDate(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. Valid during POST.

setExcludeJobs

void setExcludeJobs(Set excludeJobs)

(String collection) The list of jobs to exclude. Client must also set the IGNJOBRSV reservation flag. Otherwise, results are undefined. Used only during reservation creation. Valid during POST.

See Also:

String

setExpireDate

void setExpireDate(Date expireDate)

The date/time when the reservation expires and vacates.

setFlags

void setFlags(Set flags)

(ReservationFlag collection) The flags associated with the reservation. Valid during POST.

See Also:

ReservationFlag

setGlobalId

void setGlobalId(String globalId)

Global reservation ID.

setHostListExpression

void setHostListExpression(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. Note: Either hostListExpression or taskCount must be set to create a reservation. Valid during POST.

setId

void setId(String id)

The unique ID of the reservation.

setIdPrefix

void setIdPrefix(String idPrefix)

The user-specified prefix for this reservation. If provided, Moab combines the idPrefix with an integer, and the combination is the unique identifier for this reservation. Valid during POST.

setIsActive

void setIsActive(Boolean isActive)

State whether or not this reservation is currently active.

setIsTracked

void setIsTracked(Boolean isTracked)

States whether reservation resource usage is tracked.

setLabel

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. Valid during POST.

setMaxTasks

void setMaxTasks(Integer maxTasks)

The maximum number of tasks for this reservation.

setMessages

void setMessages(Set messages)

(MessageVersion1 collection) Messages for the reservation.

See Also:

MessageVersion1

setOwner

void setOwner(EmbeddedCredential owner)

The owner of the reservation Valid during POST.

setPartitionId

void setPartitionId(String partitionId)

The ID of the partition this reservation is for. Valid during POST.

setProfile

void setProfile(String profile)

The profile that this reservation is using. A profile is a specification of attributes that all reservations share. Used only during reservation creation. Valid during POST.

setRequirements

void setRequirements(ReservationRequirement requirements)

The reservation's requirements. Valid during POST.

setReservationGroup

void setReservationGroup(String reservationGroup)

The reservation group to which the reservation belongs. Valid during POST.

setResources

void setResources(Map resources)

(Map of String => Integer) The reservation's resources. This field is a map, where the key is PROCS, MEM DISK, SWAP, or one or more user-defined keys. Valid during POST.

See Also:

Integer

setStartDate

void setStartDate(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. Valid during POST.

setStatistics

void setStatistics(ReservationStatistics statistics)

The reservation's statistical information.

setSubType

void setSubType(String subType)

The reservation sub-type. Valid during POST.

setTaskCount

void setTaskCount(Integer taskCount)

The number of tasks that must be allocated to satisfy the reservation request. Note: Either hostListExpression or taskCount must be set to create a reservation.

setTrigger

void setTrigger(Trigger trigger)

Trigger for reservation. Used only during reservation creation. Valid during POST.

setTriggerIds

void setTriggerIds(Set triggerIds)

(String collection) The IDs of the triggers attached to this reservation.

See Also:

String

setUniqueIndex

void setUniqueIndex(String uniqueIndex)

The globally-unique reservation index.

setVariables

void setVariables(Map variables)

(Map of String => String) The set of variables for this reservation. Valid during PUT. Valid during POST.

See Also:

Map

toString

String toString()

Groovy Documentation