Class: Com::Vmware::Vapi::Std::Errors::ServiceUnavailable

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::ServiceUnavailable`` error indicates that the class is unavailable. 


 Examples:  

  * Attempt to invoke a  method  when the server is too busy. 
   * Attempt to invoke a  method  when the server is undergoing maintenance. 
   * An  method  fails to contact VMware Tools running inside the virtual machine. 
  
   

 Counterexamples:  

  * A client provides an invalid service or operation identifier when invoking the  method  using a dynamic interface (for example REST). The   :class:`Com::Vmware::Vapi::Std::Errors::OperationNotFound`    error  would be used instead. 
   * A client invokes the  method  from the  class , but that  class  has not been installed. The   :class:`Com::Vmware::Vapi::Std::Errors::OperationNotFound`    error  would be used instead.

Instance Attribute Summary

Attributes inherited from Error

#data, #messages

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

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



484
485
486
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb', line 484

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 



468
469
470
471
472
473
474
475
476
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb', line 468

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