Class List Method List File List

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

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Vapi::Std::Errors::FileLocations
  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::FileLocations`` class identifies the file(s) that caused the method to report the error .

     Some types of  errors  are caused by a problem with one or more files. This  class  is intended to be used as the payload to identify those files when the  method  reports  errors  like   :class:`Com::Vmware::Vapi::Std::Errors::NotFound`  . See   :attr:`Com::Vmware::Vapi::Std::Errors::Error.data`  .

## Instance Attribute Summary (collapse)

- - (String) primary

  String identifying the file that triggered the error .

- - (Array<String>) secondary

  List (possibly empty) of strings identifying other files that caused the primary file to trigger the error .

## Class Method Summary (collapse)

- + (VAPI::Bindings::StructType) binding_type

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

## Instance Method Summary (collapse)

- - (FileLocations) initialize(ruby_values = nil, struct_value = nil) constructor

  Constructs a new instance.

## Constructor Details

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

    98
    99
    100
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb', line 98

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

## Instance Attribute Details

### - (`String`) primary

String identifying the file that triggered the error .

Returns:

- (`String`)

    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb', line 73

    class FileLocations < 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.file_locations',
                    {
                        'primary' => VAPI::Bindings::StringType.instance,
                        'secondary' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    },
                    FileLocations,
                    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 identifying other files that caused the primary file to trigger the error .

Returns:

- (`Array<String>`)

    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb', line 73

    class FileLocations < 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.file_locations',
                    {
                        'primary' => VAPI::Bindings::StringType.instance,
                        'secondary' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    },
                    FileLocations,
                    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

    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb', line 79

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