Package com.vmware.vapi.std.errors

Class InvalidRequest

  • All Implemented Interfaces:
    StaticStructure, Structure, java.io.Serializable
    public class InvalidRequest
extends Error
implements java.io.Serializable, StaticStructure
    The InvalidRequest exception indicates that the request is malformed in such a way that the server is unable to process it.

    Examples:

    • The XML in a SOAP request is not well-formed so the server cannot parse the request.
    • The XML in a SOAP request is well-formed but does not match the structure required by the SOAP specification.
    • A JSON-RPC request is not valid JSON.
    • The JSON sent in a JSON-RPC request is not a valid JSON-RPC Request object.
    • The Request object from a JSON-RPC request does not match the structure required by the API infrastructure.

    Counterexamples:

    • The parameter has a value that is not with the required range. The InvalidArgument exception would be used instead.
    • The name of the method specified in the request doesn't not match any known method. The NotFound exception would be used instead.

    Some transport protocols (for example JSON-RPC) include their own mechanism for reporting these kinds of errors, and the API infrastructure for a programming language may expose the errors using a language specific mechanism, so this exception might not be used.

    See Also:
    Serialized Form

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      <T extends Structure>
      T      		 _convertTo​(java.lang.Class<T> clazz)
      Converts this structure into an instance of the provided class structure if possible.
      java.lang.String _getCanonicalName()
      Returns the canonical name of the structure.
      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.
      StructValue _getDataValue()
      Returns this Structure represented in the dynamic DataValue model.
      DataValue _getDynamicField​(java.lang.String fieldName)
      Get a dynamic field value, doesn't allow access to static fields (which have getters/setters).
      java.util.Set<java.lang.String> _getDynamicFieldNames()
      Get the names of the dynamic fields in the structure.
      com.vmware.vapi.bindings.type.ErrorType _getType()
      WARNING: Internal method, subject to change in future versions.
      boolean _hasTypeNameOf​(java.lang.Class<? extends Structure> clazz)
      Checks if the runtime type name of this structure matches the type represented by the specified binding class.
      static InvalidRequest _newInstance​(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 InvalidRequest _newInstance2​(StructValue structValue)
      WARNING: Internal method, subject to change in future versions.
      Serves as a versioning mechanism.
      void _setDynamicField​(java.lang.String fieldName, DataValue fieldValue)
      Sets a dynamic field value.
      protected void _updateDataValue​(StructValue structValue)  
      void _validate()
      Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.
      boolean equals​(java.lang.Object obj)  
      java.lang.String getMessage()  
      int hashCode()  

      • 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

    • Constructor Detail

      • InvalidRequest

        public InvalidRequest​(java.util.List<LocalizableMessage> messages,
                      Structure data)
        This constructor is provided for backwards compatibility purposes only. Please use the Builder class instead.

      • InvalidRequest

        public InvalidRequest()
        Default constructor.

      • InvalidRequest

        protected InvalidRequest​(StructValue __dynamicStructureFields)

      • InvalidRequest

        protected InvalidRequest​(StructValue __dynamicStructureFields,
                         Error.Type errorType)

    • Method Detail

      • _getType

        public com.vmware.vapi.bindings.type.ErrorType _getType()
        Description copied from interface: StaticStructure
        WARNING: Internal method, subject to change in future versions. Returns StructType instance representing the static bindings type for this Structure.
        Specified by:
        _getType in interface StaticStructure
        Overrides:
        _getType in class Error
        Returns:
        the static bindings StructType

      • _getDataValue

        public StructValue _getDataValue()
        Description copied from interface: Structure
        Returns this Structure represented in the dynamic DataValue model.

        Attempts to change the returned StructValue representation are not required to change the state of this structure. Actually the behavior is implementation dependent and is unspecified. In general the returned value shouldn't be changed.

        Specified by:
        _getDataValue in interface Structure
        Overrides:
        _getDataValue in class Error
        Returns:
        StructValue representing this structure

      • _validate

        public void _validate()
        Description copied from interface: StaticStructure
        Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.

        More precisely, for each union: given value of the discriminant/tag field (@UnionTag in the IDL) of an union in this structure, validates that:

      • all fields of the union required for that value of the discriminant are set
      • fields of the union that are not allowed for that value of the discriminant are not set
      • any other fields of the structure (not participating in the union) do not affect the validation result
Specified by:
_validate in interface StaticStructure
Overrides:
_validate in class Error