com.vmware.nsx.model

Class CPUReservation

java.lang.Object

com.vmware.nsx.model.CPUReservation

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

public final class CPUReservation
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

Relative to the form factor pre-defined reservation value. We recommended that you use the predefined measures of CPU reservation shares to reduce the CPU reservation of a VM. Reservation shares are relative to the default form-factor value. Though absolute values for CPU reservation is supported, we advise to use this option with caution as incorrect or high reservation values could lead to deployment failure or lead to resource starvation for other VMs running on the same host.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CPUReservation.Builder Builder class for CPUReservation.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields
static java.lang.String	RESERVATION_IN_SHARES_EXTRA_HIGH_PRIORITY
static java.lang.String	RESERVATION_IN_SHARES_HIGH_PRIORITY
static java.lang.String	RESERVATION_IN_SHARES_LOW_PRIORITY
static java.lang.String	RESERVATION_IN_SHARES_NORMAL_PRIORITY

Constructor Summary

Constructors

Modifier	Constructor and Description
	CPUReservation() Default constructor.
protected	CPUReservation(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Summary

Modifier and Type	Method and Description
<T extends com.vmware.vapi.bindings.Structure> T	_convertTo(java.lang.Class<T> clazz)
java.lang.String	_getCanonicalName()
static java.lang.String	_getCanonicalTypeName() Returns the canonical type name.
static com.vmware.vapi.bindings.type.StructType	_getClassType() WARNING: Internal method, subject to change in future versions.
com.vmware.vapi.data.StructValue	_getDataValue()
com.vmware.vapi.data.DataValue	_getDynamicField(java.lang.String fieldName)
java.util.Set<java.lang.String>	_getDynamicFieldNames()
com.vmware.vapi.bindings.type.StructType	_getType()
boolean	_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
static CPUReservation	_newInstance(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
static CPUReservation	_newInstance2(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
void	_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)
protected void	_updateDataValue(com.vmware.vapi.data.StructValue structValue)
void	_validate()
boolean	equals(java.lang.Object obj)
java.lang.Long	getReservationInMhz() The CPU reservation in MHz is the guaranteed minimum amount of clock cycles that the vmkernel CPU scheduler will give the Edge VM in case of contention.
java.lang.String	getReservationInShares() Possible values are: RESERVATION_IN_SHARES_EXTRA_HIGH_PRIORITY RESERVATION_IN_SHARES_HIGH_PRIORITY RESERVATION_IN_SHARES_NORMAL_PRIORITY RESERVATION_IN_SHARES_LOW_PRIORITY Shares specify the relative importance of a virtual machine on a given host.
int	hashCode()
void	setReservationInMhz(java.lang.Long reservationInMhz) The CPU reservation in MHz is the guaranteed minimum amount of clock cycles that the vmkernel CPU scheduler will give the Edge VM in case of contention.
void	setReservationInShares(java.lang.String reservationInShares) Possible values are: RESERVATION_IN_SHARES_EXTRA_HIGH_PRIORITY RESERVATION_IN_SHARES_HIGH_PRIORITY RESERVATION_IN_SHARES_NORMAL_PRIORITY RESERVATION_IN_SHARES_LOW_PRIORITY Shares specify the relative importance of a virtual machine on a given host.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

RESERVATION_IN_SHARES_EXTRA_HIGH_PRIORITY

public static final java.lang.String RESERVATION_IN_SHARES_EXTRA_HIGH_PRIORITY

See Also:

Constant Field Values

RESERVATION_IN_SHARES_HIGH_PRIORITY

public static final java.lang.String RESERVATION_IN_SHARES_HIGH_PRIORITY

See Also:

Constant Field Values

RESERVATION_IN_SHARES_NORMAL_PRIORITY

public static final java.lang.String RESERVATION_IN_SHARES_NORMAL_PRIORITY

See Also:

Constant Field Values

RESERVATION_IN_SHARES_LOW_PRIORITY

public static final java.lang.String RESERVATION_IN_SHARES_LOW_PRIORITY

See Also:

Constant Field Values

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

CPUReservation

public CPUReservation()

Default constructor.

CPUReservation

protected CPUReservation(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Detail

getReservationInMhz

public java.lang.Long getReservationInMhz()

The CPU reservation in MHz is the guaranteed minimum amount of clock cycles that the vmkernel CPU scheduler will give the Edge VM in case of contention. If an Edge VM is not using its reserved resources, then other machines can use them thus preventing waste of CPU cycles on the physical host. Note: We recommend use of reservation_in_shares instead of this absolute configuration. When you specify this value, set reservation_in_shares to LOW_PRIORITY. format: int32

Returns:

The current value of the property.

setReservationInMhz

public void setReservationInMhz(java.lang.Long reservationInMhz)

The CPU reservation in MHz is the guaranteed minimum amount of clock cycles that the vmkernel CPU scheduler will give the Edge VM in case of contention. If an Edge VM is not using its reserved resources, then other machines can use them thus preventing waste of CPU cycles on the physical host. Note: We recommend use of reservation_in_shares instead of this absolute configuration. When you specify this value, set reservation_in_shares to LOW_PRIORITY. format: int32

Parameters:

reservationInMhz - New value for the property.

getReservationInShares

public java.lang.String getReservationInShares()

Possible values are:

• RESERVATION_IN_SHARES_EXTRA_HIGH_PRIORITY
• RESERVATION_IN_SHARES_HIGH_PRIORITY
• RESERVATION_IN_SHARES_NORMAL_PRIORITY
• RESERVATION_IN_SHARES_LOW_PRIORITY

Shares specify the relative importance of a virtual machine on a given host. When you assign shares to a virtual machine, you always specify the priority for that virtual machine relative to other powered-on virtual machines on the same host. The default priority for shares is HIGH_PRIORITY.

Returns:

The current value of the property.

setReservationInShares

public void setReservationInShares(java.lang.String reservationInShares)

Possible values are:

• RESERVATION_IN_SHARES_EXTRA_HIGH_PRIORITY
• RESERVATION_IN_SHARES_HIGH_PRIORITY
• RESERVATION_IN_SHARES_NORMAL_PRIORITY
• RESERVATION_IN_SHARES_LOW_PRIORITY

Shares specify the relative importance of a virtual machine on a given host. When you assign shares to a virtual machine, you always specify the priority for that virtual machine relative to other powered-on virtual machines on the same host. The default priority for shares is HIGH_PRIORITY.

Parameters:

reservationInShares - New value for the property.

_getType

public com.vmware.vapi.bindings.type.StructType _getType()

Specified by:

_getType in interface com.vmware.vapi.bindings.StaticStructure

_getDataValue

public com.vmware.vapi.data.StructValue _getDataValue()

Specified by:

_getDataValue in interface com.vmware.vapi.bindings.Structure

_updateDataValue

protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)

_validate

public void _validate()

Specified by:

_validate in interface com.vmware.vapi.bindings.StaticStructure

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Specified by:

toString in interface com.vmware.vapi.bindings.StaticStructure

Overrides:

toString in class java.lang.Object

_hasTypeNameOf

public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)

Specified by:

_hasTypeNameOf in interface com.vmware.vapi.bindings.Structure

_convertTo

public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)

Specified by:

_convertTo in interface com.vmware.vapi.bindings.Structure

_setDynamicField

public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)

Specified by:

_setDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicField

public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)

Specified by:

_getDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicFieldNames

public java.util.Set<java.lang.String> _getDynamicFieldNames()

Specified by:

_getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure

_getClassType

public static com.vmware.vapi.bindings.type.StructType _getClassType()

WARNING: Internal method, subject to change in future versions.

Returns:

StructType instance representing the static bindings type for this Structure.

_getCanonicalName

public java.lang.String _getCanonicalName()

Specified by:

_getCanonicalName in interface com.vmware.vapi.bindings.Structure

_getCanonicalTypeName

public static java.lang.String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static CPUReservation _newInstance(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value.
WARNING: The returned object is not fully initialized.

Parameters:

structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.

Returns:

the static bindings StructType

_newInstance2

public static CPUReservation _newInstance2(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.