Class List Method List File List

# Class: Com::Vmware::Vapi::Std::Errors::UnexpectedInput

Inherits:
  Error
  - Object
  - VAPI::Bindings::VapiError
  - Error
  - Com::Vmware::Vapi::Std::Errors::UnexpectedInput
  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::UnexpectedInput`` error indicates that the request contained a parameter or field whose name is not known by the server.

     Every  method  expects  parameters  with known names. Some of those  parameters  may be (or contain)  classes , and the  method  expects those  classes  to contain  fields  with known names. If the  method  receives  parameters  or  fields  with names that is does not expect, this  error  may be reported.

     This  error  can be reported by the API infrastructure for any  method , but it is specific to the API infrastructure, and should never be reported by the implementation of any  method .

     Examples:

      * A client using stubs generated from the interface specification for version2 of a  class  invokes the  method  passing one or more  parameters  that were added in version2, but they are communicating with a server that only supports version1 of the  class .
       * A client provides an unexpected  parameter  or  field  name when invoking the  method  using a dynamic interface (for example REST).

## Instance Attribute Summary

### Attributes inherited from Error

#data, #messages

## Class Method Summary (collapse)

- + (VAPI::Bindings::ErrorType) binding_type

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

## Instance Method Summary (collapse)

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

  Constructs a new instance.

## Constructor Details

### - (`UnexpectedInput`) 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)

    255
    256
    257
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb', line 255

    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

    239
    240
    241
    242
    243
    244
    245
    246
    247
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb', line 239

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