com.vmware.vapi.std.errors

Class NotAllowedInCurrentState

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.vmware.vapi.bindings.ApiError

com.vmware.vapi.std.errors.Error

com.vmware.vapi.std.errors.NotAllowedInCurrentState

All Implemented Interfaces:

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

public class NotAllowedInCurrentState
extends Error
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

The NotAllowedInCurrentState exception indicates that the requested method is not allowed with a resource or service in its current state. This could be because the method is performing a configuration change that is not allowed in the current state or because method itself is not allowed in the current state.

Examples:

• Trying to add a virtual device that cannot be hot plugged to a running virtual machine.
• Trying to upgrade the virtual hardware version for a suspended virtual machine.
• Trying to power off, reset, or suspend a virtual machine that is not powered on.

Counterexamples:

• Trying to power off a virtual machine that is in the process of being powered on. The ResourceBusy exception would be used instead.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class com.vmware.vapi.std.errors.Error

Error.Type

Field Summary

Fields inherited from class com.vmware.vapi.std.errors.Error

__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	NotAllowedInCurrentState() Default constructor.
	NotAllowedInCurrentState(java.util.List<LocalizableMessage> messages, com.vmware.vapi.bindings.Structure data) This constructor is provided for backwards compatibility purposes only.
protected	NotAllowedInCurrentState(com.vmware.vapi.data.StructValue __dynamicStructureFields)
protected	NotAllowedInCurrentState(com.vmware.vapi.data.StructValue __dynamicStructureFields, Error.Type errorType)

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.ErrorType	_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.ErrorType	_getType()
boolean	_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
static NotAllowedInCurrentState	_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 NotAllowedInCurrentState	_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.String	getMessage()
int	hashCode()

Methods inherited from class com.vmware.vapi.std.errors.Error

getData, getErrorType, getMessages, setData, setMessages

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vmware.vapi.bindings.StaticStructure

toString

Constructor Detail

NotAllowedInCurrentState

public NotAllowedInCurrentState(java.util.List<LocalizableMessage> messages,
                                com.vmware.vapi.bindings.Structure data)

This constructor is provided for backwards compatibility purposes only. Please use the Builder class instead.

NotAllowedInCurrentState

public NotAllowedInCurrentState()

Default constructor.

NotAllowedInCurrentState

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

NotAllowedInCurrentState

protected NotAllowedInCurrentState(com.vmware.vapi.data.StructValue __dynamicStructureFields,
                                   Error.Type errorType)

Method Detail

_getType

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

Specified by:

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

Overrides:

_getType in class Error

_getDataValue

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

Specified by:

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

Overrides:

_getDataValue in class Error

_updateDataValue

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

Overrides:

_updateDataValue in class Error

_validate

public void _validate()

Specified by:

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

Overrides:

_validate in class Error

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class Error

hashCode

public int hashCode()

Overrides:

hashCode in class Error

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class Error

_hasTypeNameOf

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

Specified by:

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

Overrides:

_hasTypeNameOf in class Error

_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

Overrides:

_convertTo in class Error

_setDynamicField

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

Specified by:

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

Overrides:

_setDynamicField in class Error

_getDynamicField

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

Specified by:

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

Overrides:

_getDynamicField in class Error

_getDynamicFieldNames

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

Specified by:

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

Overrides:

_getDynamicFieldNames in class Error

_getClassType

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

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

Returns:

ErrorType instance representing the static bindings type for this Error.

_getCanonicalName

public java.lang.String _getCanonicalName()

Specified by:

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

Overrides:

_getCanonicalName in class Error

_getCanonicalTypeName

public static java.lang.String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static NotAllowedInCurrentState _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 NotAllowedInCurrentState _newInstance2(com.vmware.vapi.data.StructValue structValue)

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