com.vmware.nsx.model

Class ApiError

java.lang.Object

com.vmware.nsx.model.ApiError

All Implemented Interfaces:

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

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

Detailed information about an API Error

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	ApiError() Default constructor.
protected	ApiError(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 ApiError	_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 ApiError	_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	getDetails() Further details about the error
java.lang.Long	getErrorCode() A numeric error code format: int64
com.vmware.vapi.bindings.Structure	getErrorData() Additional data about the error
java.lang.String	getErrorMessage() A description of the error
java.lang.String	getModuleName() The module name where the error occurred
java.util.List<RelatedApiError>	getRelatedErrors() Other errors related to this error
int	hashCode()
void	setDetails(java.lang.String details) Further details about the error
void	setErrorCode(java.lang.Long errorCode) A numeric error code format: int64
void	setErrorData(com.vmware.vapi.bindings.Structure errorData) Additional data about the error
void	setErrorMessage(java.lang.String errorMessage) A description of the error
void	setModuleName(java.lang.String moduleName) The module name where the error occurred
void	setRelatedErrors(java.util.List<RelatedApiError> relatedErrors) Other errors related to this error
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

ApiError

public ApiError()

Default constructor.

ApiError

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

Method Detail

getDetails

public java.lang.String getDetails()

Further details about the error

Returns:

The current value of the property.

setDetails

public void setDetails(java.lang.String details)

Further details about the error

Parameters:

details - New value for the property.

getErrorCode

public java.lang.Long getErrorCode()

A numeric error code format: int64

Returns:

The current value of the property.

setErrorCode

public void setErrorCode(java.lang.Long errorCode)

A numeric error code format: int64

Parameters:

errorCode - New value for the property.

getErrorData

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

Additional data about the error

Returns:

The current value of the property.

setErrorData

public void setErrorData(com.vmware.vapi.bindings.Structure errorData)

Additional data about the error

Parameters:

errorData - New value for the property.

getErrorMessage

public java.lang.String getErrorMessage()

A description of the error

Returns:

The current value of the property.

setErrorMessage

public void setErrorMessage(java.lang.String errorMessage)

A description of the error

Parameters:

errorMessage - New value for the property.

getModuleName

public java.lang.String getModuleName()

The module name where the error occurred

Returns:

The current value of the property.

setModuleName

public void setModuleName(java.lang.String moduleName)

The module name where the error occurred

Parameters:

moduleName - New value for the property.

getRelatedErrors

public java.util.List<RelatedApiError> getRelatedErrors()

Other errors related to this error

Returns:

The current value of the property.

setRelatedErrors

public void setRelatedErrors(java.util.List<RelatedApiError> relatedErrors)

Other errors related to this error

Parameters:

relatedErrors - 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 ApiError _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 ApiError _newInstance2(com.vmware.vapi.data.StructValue structValue)

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