Class List Method List File List

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

Inherits:
  Error
  - Object
  - VAPI::Bindings::VapiError
  - Error
  - Com::Vmware::Vapi::Std::Errors::TimedOut
  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::TimedOut`` error indicates that the method did not complete within the allowed amount of time. The allowed amount of time might be:

      * provided by the client as an input  parameter .
       * a fixed limit of the  class  implementation that is a documented part of the contract of the  class .
       * a configurable limit used by the implementation of the  class .
       * a dynamic limit computed by the implementation of the  class .

      The  method  may or may not complete after the  ``Com::Vmware::Vapi::Std::Errors::TimedOut``   error  was reported.

     Examples:

      * The  method  was unable to complete within the timeout duration specified by a  parameter  of the  method .

     Counterexamples:

      * A server implementation that puts requests into a queue before dispatching them might delete a request from the queue if it doesn't get dispatched within  *n*  minutes. The   :class:`Com::Vmware::Vapi::Std::Errors::ServiceUnavailable`    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)

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

  Constructs a new instance.

## Constructor Details

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

    441
    442
    443
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb', line 441

    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

    425
    426
    427
    428
    429
    430
    431
    432
    433
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb', line 425

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