Class List Method List File List

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

Inherits:
  Error
  - Object
  - VAPI::Bindings::VapiError
  - Error
  - Com::Vmware::Vapi::Std::Errors::InvalidArgument
  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::InvalidArgument`` error indicates that the values received for one or more parameters are not acceptable.

     This  error  is reported by the API infrastructure, so it could occur in response to the invocation of any  method . It may also be reported as the result of  method -specific validation.

     Examples:

      * A  parameter  has a value that is not of the expected type.
       * A  parameter  has a value that is not in the required range.
       * A  parameter  has a value that is not one of the specifically allowed strings.
       * One  field  of a  class  is the tag for a tagged union, and has a specific value but another  field  of the  class  that is required to be specified when the tag has that value is not specified, or another  field  of the  class  that is required to be unspecified when the tag has that value is specified.

     Counterexamples:

      * Trying to create a new tag in tag category when a tag with the specified name already exists the tag category. The   :class:`Com::Vmware::Vapi::Std::Errors::AlreadyExists`    error  would be used instead.
       * Invoke the  method  to retrieve information about a virtual machine, passing an id that does not identify an existing virtual machine. The   :class:`Com::Vmware::Vapi::Std::Errors::NotFound`    error  would be used instead.
       * Attempt to put a virtual machine into a folder that can only contain hosts. The   :class:`Com::Vmware::Vapi::Std::Errors::InvalidElementType`    error  would be used instead.
       * Attempt to attach a SCSI virtual disk to an IDE port. The   :class:`Com::Vmware::Vapi::Std::Errors::InvalidElementType`    error  would be used instead.

## 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)

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

  Constructs a new instance.

## Constructor Details

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

    902
    903
    904
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb', line 902

    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

    886
    887
    888
    889
    890
    891
    892
    893
    894
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb', line 886

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