Class: Com::Vmware::Vapi::Std::Errors::InvalidRequest

Inherits:
Error
  • Object
show all
Defined in:
/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb

Overview

The ``Com::Vmware::Vapi::Std::Errors::InvalidRequest`` error 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   :class:`Com::Vmware::Vapi::Std::Errors::InvalidArgument`    error  would be used instead. 
   * The name of the  method  specified in the request doesn't not match any known  method . The   :class:`Com::Vmware::Vapi::Std::Errors::NotFound`    error  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  error  might not be used.

Instance Attribute Summary

Attributes inherited from Error

#data, #messages

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (InvalidRequest) initialize(binding_type = self.class.binding_type, error_value = nil)

Constructs a new instance.

Parameters:

  • binding_type (VAPI::Bindings::BindingType) (defaults to: self.class.binding_type) —

    the specific BindingType declaration for this concrete VapiError type

  • error_value (VAPI::Data::ErrorValue) (defaults to: nil) —

    the error value (default nil) 



778
779
780
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb', line 778

def initialize(binding_type=self.class.binding_type, error_value=nil)
    super(binding_type, error_value)
end

Class Method Details

+ (VAPI::Bindings::ErrorType) binding_type

Holds (gets or creates) the binding type metadata for this error type.

Returns:

  • (VAPI::Bindings::ErrorType) —

    the binding type 



762
763
764
765
766
767
768
769
770
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb', line 762

def binding_type
    @binding_type ||= VAPI::Bindings::ErrorType.new(
        'com.vmware.vapi.std.errors.invalid_request',
        {
            'messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
            'data' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DynamicStructType.new()),
        },
        InvalidRequest)
end