Package org.ovirt.engine.sdk4.types

Enum VmPoolType

java.lang.Object

java.lang.Enum<VmPoolType>

org.ovirt.engine.sdk4.types.VmPoolType

All Implemented Interfaces:

Serializable, Comparable<VmPoolType>

public enum VmPoolType
extends Enum<VmPoolType>

Type represeting the deallocation policy of virtual machines in a virtual machines pool.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTOMATIC	This policy indicates that virtual machines in the pool are automcatically deallocated by the system.
MANUAL	This policy indicates that virtual machines in the pool are deallocated manually by the administrator.

Method Summary

Modifier and Type	Method	Description
static VmPoolType	fromValue(String value)
String	value()
static VmPoolType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static VmPoolType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AUTOMATIC

public static final VmPoolType AUTOMATIC

This policy indicates that virtual machines in the pool are automcatically deallocated by the system. With this policy, when a virtual machine that is part of the pool and is assigned to a user is shut-down, it is detached from the user, its state is restored to the pool's default state, and the virtual machine returns to pool (i.e., the virtual machine can then be assigned to another user).

MANUAL

public static final VmPoolType MANUAL

This policy indicates that virtual machines in the pool are deallocated manually by the administrator. With this policy, a virtual machine that is part of the pool remains assigned to its user and preserves its state on shut-down. In order to return the virtual machine back to the pool, the administrator needs to deallocate it explicitly by removing the user's permissions on that virtual machine.

Method Detail

values

public static VmPoolType[] values()

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

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

Returns:

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

valueOf

public static VmPoolType valueOf(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:

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

NullPointerException - if the argument is null

value

public String value()

fromValue

public static VmPoolType fromValue(String value)