com.vmware.vapi.std.errors

Class Error

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.vmware.vapi.bindings.ApiError

com.vmware.vapi.std.errors.Error

All Implemented Interfaces:

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

Direct Known Subclasses:

AlreadyExists, AlreadyInDesiredState, Canceled, ConcurrentChange, FeatureInUse, InternalServerError, InvalidArgument, InvalidElementConfiguration, InvalidElementType, InvalidRequest, NotAllowedInCurrentState, NotFound, OperationNotFound, ResourceBusy, ResourceInaccessible, ResourceInUse, ServiceUnavailable, TimedOut, UnableToAllocateResource, Unauthenticated, Unauthorized, UnexpectedInput, Unsupported, UnverifiedPeer

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

The Error exception describes theproperties common to all standard exceptions.

This exception serves two purposes:

1. It is the exception that clients in many programming languages can catch to handle all standard exceptions. Typically those clients will display one or more of the localizable messages from getMessages() to a human.
2. It is the exception that methods can report when they need to report some exception, but the exception doesn't fit into any other standard exception, and in fact the only reasonable way for a client to react to the exception is to display the message(s) to a human.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Error.Builder Builder class for Error.
static class	Error.Type Enumeration of all standard errors.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	Error() Default constructor.
	Error(java.util.List<LocalizableMessage> messages, com.vmware.vapi.bindings.Structure data) This constructor is provided for backwards compatibility purposes only.
protected	Error(com.vmware.vapi.data.StructValue __dynamicStructureFields)
protected	Error(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 Error	_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 Error	_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)
com.vmware.vapi.bindings.Structure	getData() Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
Error.Type	getErrorType() Discriminator field to help API consumers identify the structure type.
java.lang.String	getMessage()
java.util.List<LocalizableMessage>	getMessages() Stack of one or more localizable messages for human exception consumers.
int	hashCode()
void	setData(com.vmware.vapi.bindings.Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
void	setMessages(java.util.List<LocalizableMessage> messages) Stack of one or more localizable messages for human exception consumers.

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, wait, wait, wait

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

toString

Field Detail

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

Error

public Error(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.

Error

public Error()

Default constructor.

Error

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

Error

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

Method Detail

getMessages

public java.util.List<LocalizableMessage> getMessages()

Stack of one or more localizable messages for human exception consumers.

The message at the top of the stack (first in the list) describes the exception from the perspective of the method the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

Returns:

The current value of the property.

setMessages

public void setMessages(java.util.List<LocalizableMessage> messages)

Stack of one or more localizable messages for human exception consumers.

The message at the top of the stack (first in the list) describes the exception from the perspective of the method the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

Parameters:

messages - New value for the property.

getData

public com.vmware.vapi.bindings.Structure getData()

Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.

Methods may provide data that clients can use when responding to exceptions. Since the data that clients need may be specific to the context of the method reporting the exception, different methods that report the same exception may provide different data in the exception. The documentation for each each method will describe what, if any, data it provides for each exception it reports.

The ArgumentLocations, FileLocations, and TransientIndication classes are intended as possible values for this property. DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some interfaces may provide their own specific classes for use as the value of this property when reporting exceptions from their methods.

Some methods will not set this property when reporting exceptions.

Returns:

The current value of the property.

setData

public void setData(com.vmware.vapi.bindings.Structure data)

Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.

Methods may provide data that clients can use when responding to exceptions. Since the data that clients need may be specific to the context of the method reporting the exception, different methods that report the same exception may provide different data in the exception. The documentation for each each method will describe what, if any, data it provides for each exception it reports.

The ArgumentLocations, FileLocations, and TransientIndication classes are intended as possible values for this property. DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some interfaces may provide their own specific classes for use as the value of this property when reporting exceptions from their methods.

Some methods will not set this property when reporting exceptions.

Parameters:

data - New value for the property.

getErrorType

public Error.Type getErrorType()

Discriminator field to help API consumers identify the structure type. This property was added in vSphere API 6.7.2. The value of this property is automatically populated. Can be null for compatibility with preceding implementations.

Returns:

The current value of the property.

_getType

public com.vmware.vapi.bindings.type.ErrorType _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

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

_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.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

_getCanonicalTypeName

public static java.lang.String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

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

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