Class: Com::Vmware::Vapi::Std::Errors::NotAllowedInCurrentState

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::NotAllowedInCurrentState`` error indicates that the requested method is not allowed with a resource or service in its current state. This could be because the method is performing a configuration change that is not allowed in the current state or because method itself is not allowed in the current state. 


 Examples:  

  * Trying to add a virtual device that cannot be hot plugged to a running virtual machine. 
   * Trying to upgrade the virtual hardware version for a suspended virtual machine. 
   * Trying to power off, reset, or suspend a virtual machine that is not powered on. 
  
   

 Counterexamples:  

  * Trying to power off a virtual machine that is in the process of being powered on. The   :class:`Com::Vmware::Vapi::Std::Errors::ResourceBusy`    error  would be used instead.

Instance Attribute Summary

Attributes inherited from Error

#data, #messages

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (NotAllowedInCurrentState) 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) 



730
731
732
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb', line 730

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 



714
715
716
717
718
719
720
721
722
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb', line 714

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