com.ace.moab.api.reservation
Enum ReservationFlag

java.lang.Object
  java.lang.Enum<ReservationFlag>
      com.ace.moab.api.reservation.ReservationFlag

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ReservationFlag>

public enum ReservationFlag
extends java.lang.Enum<ReservationFlag>

This enumeration specifies the Reservation flag types of a reservation.

Enum Constant Summary

ACLOVERLAP
A reservation may also reserve resources that possess credentials that meet the reservation's ACL.

ADVRES
If set, the reservation is created in advance of needing it.

ADVRESJOBDESTROY
Cancel any jobs associated with the reservation when it is released.

ALLOWGRID
The reservation is set up for use in a grid environment.

ALLOWPRSV
Personal reservations can be created within the space of this standing reservation (and ONLY this standing reservation); by default, when a standing reservation is given the flag ALLOWPRSV it is given the ACL USER==ALL+ allowing all jobs and all users access.

BYNAME
Reservation only allows access to jobs that meet reservation ACLs and explicitly request the resources of this reservation using the job ADVRES flag.

DEDICATEDNODE
If set, only one active reservation is allowed on a node.

DEDICATEDRESOURCE
The reservation only placed on resources that are not reserved by any other reservation including jobs and other reservations.

ENFORCENODESET
Enforce node sets when creating reservation

EXCLUDEALLBUTSB
Reservation only shares resources with sandboxes.

EXCLUDEJOBS
Makes a reservation job exclusive where only one job can run in the reservation.

EXCLUDEMYGROUP
Exclude reservations within the same group

GRID
The reservation was created by a member in the grid.

IGNRSV
Forces the reservation onto nodes regardless of whether there are other reservations currently residing on the nodes.

IGNSTATE
Request ignores existing resource reservations allowing the reservation to be forced onto available resources even if this conflicts with other reservations.

ISACTIVE
If set, the reservation is currently active.

ISCLOSED
If set, the reservation is closed.

ISGLOBAL
If set the reservation applies to all resources.

OWNERPREEMPT
The owner of the reservation is given preemptor status for resources contained in the reservation.

PARENTLOCK
The reservation can only be destroyed by destroying its parent.

PREEMPTEE
The reservation is preemptible.

PRSV
The reservation is a non-adminstrator, non standing reservation, user-created reservation.

REQFULL
The reservation will fail if all resources requested cannot be allocated.

SINGLEUSE
The reservation is automatically removed after completion of the first job to use the reserved resources.

SPACEFLEX
The reservation is allowed to adjust resources allocated over time in an attempt to optimize resource utilization.

STANDINGRSV
If set, the reservation was created by a standing reservation instance.

STATIC
Makes a reservation ineligible to modified or canceled by an administrator.

SYSTEMJOB
The reservation was created by a system job.

TIMEFLEX
The reservation is allowed to adjust the reserved time frame in an attempt to optimize resource utilization.

TRIGHASFIRED
The reservation has one or more triggers that have fired on it.

VPC
If set, the reservation is attached to a virtual private cluster.

WASACTIVE
The reservation was previously active.

Method Summary

static java.util.List<java.lang.String>	getflagNames() Returns a list of the names of the reservation flags.
static ReservationFlag	parseString(java.lang.String string) Attempts to parse a string and convert it into a corresponding ReservationFlag enum value.
static ReservationFlag	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ReservationFlag[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ACLOVERLAP

public static final ReservationFlag ACLOVERLAP

A reservation may also reserve resources that possess credentials that meet the reservation's ACL.

ADVRES

public static final ReservationFlag ADVRES

If set, the reservation is created in advance of needing it.

ADVRESJOBDESTROY

public static final ReservationFlag ADVRESJOBDESTROY

Cancel any jobs associated with the reservation when it is released.

ALLOWGRID

public static final ReservationFlag ALLOWGRID

The reservation is set up for use in a grid environment.

ALLOWPRSV

public static final ReservationFlag ALLOWPRSV

Personal reservations can be created within the space of this standing reservation (and ONLY this standing reservation); by default, when a standing reservation is given the flag ALLOWPRSV it is given the ACL USER==ALL+ allowing all jobs and all users access.

BYNAME

public static final ReservationFlag BYNAME

Reservation only allows access to jobs that meet reservation ACLs and explicitly request the resources of this reservation using the job ADVRES flag.

DEDICATEDNODE

public static final ReservationFlag DEDICATEDNODE

If set, only one active reservation is allowed on a node.

DEDICATEDRESOURCE

public static final ReservationFlag DEDICATEDRESOURCE

The reservation only placed on resources that are not reserved by any other reservation including jobs and other reservations.

EXCLUDEJOBS

public static final ReservationFlag EXCLUDEJOBS

Makes a reservation job exclusive where only one job can run in the reservation.

ENFORCENODESET

public static final ReservationFlag ENFORCENODESET

Enforce node sets when creating reservation

EXCLUDEALLBUTSB

public static final ReservationFlag EXCLUDEALLBUTSB

Reservation only shares resources with sandboxes.

EXCLUDEMYGROUP

public static final ReservationFlag EXCLUDEMYGROUP

Exclude reservations within the same group

GRID

public static final ReservationFlag GRID

The reservation was created by a member in the grid.

IGNRSV

public static final ReservationFlag IGNRSV

Forces the reservation onto nodes regardless of whether there are other reservations currently residing on the nodes.

IGNSTATE

public static final ReservationFlag IGNSTATE

Request ignores existing resource reservations allowing the reservation to be forced onto available resources even if this conflicts with other reservations.

ISACTIVE

public static final ReservationFlag ISACTIVE

If set, the reservation is currently active.

ISCLOSED

public static final ReservationFlag ISCLOSED

If set, the reservation is closed.

ISGLOBAL

public static final ReservationFlag ISGLOBAL

If set the reservation applies to all resources.

OWNERPREEMPT

public static final ReservationFlag OWNERPREEMPT

The owner of the reservation is given preemptor status for resources contained in the reservation.

PARENTLOCK

public static final ReservationFlag PARENTLOCK

The reservation can only be destroyed by destroying its parent.

PREEMPTEE

public static final ReservationFlag PREEMPTEE

The reservation is preemptible.

PRSV

public static final ReservationFlag PRSV

The reservation is a non-adminstrator, non standing reservation, user-created reservation.

REQFULL

public static final ReservationFlag REQFULL

The reservation will fail if all resources requested cannot be allocated.

SINGLEUSE

public static final ReservationFlag SINGLEUSE

The reservation is automatically removed after completion of the first job to use the reserved resources.

SPACEFLEX

public static final ReservationFlag SPACEFLEX

The reservation is allowed to adjust resources allocated over time in an attempt to optimize resource utilization.

STANDINGRSV

public static final ReservationFlag STANDINGRSV

If set, the reservation was created by a standing reservation instance.

STATIC

public static final ReservationFlag STATIC

Makes a reservation ineligible to modified or canceled by an administrator.

SYSTEMJOB

public static final ReservationFlag SYSTEMJOB

The reservation was created by a system job.

TIMEFLEX

public static final ReservationFlag TIMEFLEX

The reservation is allowed to adjust the reserved time frame in an attempt to optimize resource utilization.

TRIGHASFIRED

public static final ReservationFlag TRIGHASFIRED

The reservation has one or more triggers that have fired on it.

VPC

public static final ReservationFlag VPC

If set, the reservation is attached to a virtual private cluster.

WASACTIVE

public static final ReservationFlag WASACTIVE

The reservation was previously active.

Method Detail

values

public static final ReservationFlag[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(ReservationFlag c : ReservationFlag.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static ReservationFlag valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

getflagNames

public static java.util.List<java.lang.String> getflagNames()

Returns a list of the names of the reservation flags.

Returns:

the names of the reservation flags.

parseString

public static ReservationFlag parseString(java.lang.String string)
                                   throws java.text.ParseException

Attempts to parse a string and convert it into a corresponding ReservationFlag enum value.

Parameters:

string - the string to parse into a corresponding ReservationFlag enum value.

Returns:

the corresponding ReservationFlag enum value.

Throws:

java.text.ParseException - thrown if the string cannot be parsed into a respective ReservationFlag.