Class: Com::Vmware::Vapi::Std::Errors::ArgumentLocations

Inherits:
VAPI::Bindings::VapiStruct
  • 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::ArgumentLocations`` class describes which part(s) of the input to the method caused the error . 


 Some types of  errors  are caused by the value of one of the inputs to the  method , possibly due to an interaction with other inputs to the  method . This  class  is intended to be used as the payload to identify those inputs when the  method  reports  errors  like   :class:`Com::Vmware::Vapi::Std::Errors::InvalidArgument`   or   :class:`Com::Vmware::Vapi::Std::Errors::NotFound`  . See   :attr:`Com::Vmware::Vapi::Std::Errors::Error.data`  .

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (ArgumentLocations) initialize(ruby_values = nil, struct_value = nil)

Constructs a new instance.

Parameters:

  • ruby_values (Hash) (defaults to: nil) —

    a map of initial property values (optional)

  • struct_value (VAPI::Data::StructValue) (defaults to: nil) —

    a raw StructValue from the wire (optional) 



58
59
60
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb', line 58

def initialize(ruby_values=nil, struct_value=nil)
    super(self.class.binding_type, ruby_values, struct_value)
end

Instance Attribute Details

- (String) primary

String describing the location of the input that triggered the error .

Returns:

  • (String) 


33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb', line 33

class ArgumentLocations < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vapi.std.errors.argument_locations',
                {
                    'primary' => VAPI::Bindings::StringType.instance,
                    'secondary' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                },
                ArgumentLocations,
                false,
                nil)
        end
    end

    attr_accessor :primary,
                  :secondary

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (Array<String>) secondary

List (possibly empty) of strings describing the locations of other inputs that caused the the primary input to trigger the error .

Returns:

  • (Array<String>) 


33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb', line 33

class ArgumentLocations < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vapi.std.errors.argument_locations',
                {
                    'primary' => VAPI::Bindings::StringType.instance,
                    'secondary' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                },
                ArgumentLocations,
                false,
                nil)
        end
    end

    attr_accessor :primary,
                  :secondary

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

Class Method Details

+ (VAPI::Bindings::StructType) binding_type

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

Returns:

  • (VAPI::Bindings::StructType) —

    the binding type 



39
40
41
42
43
44
45
46
47
48
49
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb', line 39

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.vapi.std.errors.argument_locations',
        {
            'primary' => VAPI::Bindings::StringType.instance,
            'secondary' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
        },
        ArgumentLocations,
        false,
        nil)
end