Class List Method List File List

# Class: Com::Vmware::Appliance::Techpreview::Networking::Routes::Route

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Appliance::Techpreview::Networking::Routes::Route
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb

## Overview

``Com::Vmware::Appliance::Techpreview::Networking::Routes::Route`` class Structure that describes how routing is performed for a particular destination and prefix. A destination/prefix of 0.0.0.0/0 ( for IPv4) or ::/0 (for IPv6) refers to the default gateway.

## Instance Attribute Summary (collapse)

- - (String) destination

  Destination address that defines this route.

- - (String) gateway

  Gateway address.

- - (String) interface_name

  Output device interface, for example, “nic0”.

- - (Fixnum) prefix

  Destination CIDR prefix that defines this route.

## 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)

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

  Constructs a new instance.

## Constructor Details

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

    1666
    1667
    1668
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1666

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

## Instance Attribute Details

### - (`String`) destination

Destination address that defines this route.

Returns:

- (`String`)

    1637
    1638
    1639
    1640
    1641
    1642
    1643
    1644
    1645
    1646
    1647
    1648
    1649
    1650
    1651
    1652
    1653
    1654
    1655
    1656
    1657
    1658
    1659
    1660
    1661
    1662
    1663
    1664
    1665
    1666
    1667
    1668
    1669
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1637

    class Route < 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.appliance.techpreview.networking.routes.route',
                    {
                        'destination' => VAPI::Bindings::StringType.instance,
                        'prefix' => VAPI::Bindings::IntegerType.instance,
                        'gateway' => VAPI::Bindings::StringType.instance,
                        'interface_name' => VAPI::Bindings::StringType.instance,
                    },
                    Route,
                    false,
                    nil)
            end
        end

        attr_accessor :destination,
                      :prefix,
                      :gateway,
                      :interface_name

        # 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

### - (`String`) gateway

Gateway address.

Returns:

- (`String`)

    1637
    1638
    1639
    1640
    1641
    1642
    1643
    1644
    1645
    1646
    1647
    1648
    1649
    1650
    1651
    1652
    1653
    1654
    1655
    1656
    1657
    1658
    1659
    1660
    1661
    1662
    1663
    1664
    1665
    1666
    1667
    1668
    1669
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1637

    class Route < 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.appliance.techpreview.networking.routes.route',
                    {
                        'destination' => VAPI::Bindings::StringType.instance,
                        'prefix' => VAPI::Bindings::IntegerType.instance,
                        'gateway' => VAPI::Bindings::StringType.instance,
                        'interface_name' => VAPI::Bindings::StringType.instance,
                    },
                    Route,
                    false,
                    nil)
            end
        end

        attr_accessor :destination,
                      :prefix,
                      :gateway,
                      :interface_name

        # 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

### - (`String`) interface_name

Output device interface, for example, “nic0”.

Returns:

- (`String`)

    1637
    1638
    1639
    1640
    1641
    1642
    1643
    1644
    1645
    1646
    1647
    1648
    1649
    1650
    1651
    1652
    1653
    1654
    1655
    1656
    1657
    1658
    1659
    1660
    1661
    1662
    1663
    1664
    1665
    1666
    1667
    1668
    1669
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1637

    class Route < 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.appliance.techpreview.networking.routes.route',
                    {
                        'destination' => VAPI::Bindings::StringType.instance,
                        'prefix' => VAPI::Bindings::IntegerType.instance,
                        'gateway' => VAPI::Bindings::StringType.instance,
                        'interface_name' => VAPI::Bindings::StringType.instance,
                    },
                    Route,
                    false,
                    nil)
            end
        end

        attr_accessor :destination,
                      :prefix,
                      :gateway,
                      :interface_name

        # 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

### - (`Fixnum`) prefix

Destination CIDR prefix that defines this route. See www.oav.net/mirrors/cidr.html for netmask-to-prefix conversion.

Returns:

- (`Fixnum`)

    1637
    1638
    1639
    1640
    1641
    1642
    1643
    1644
    1645
    1646
    1647
    1648
    1649
    1650
    1651
    1652
    1653
    1654
    1655
    1656
    1657
    1658
    1659
    1660
    1661
    1662
    1663
    1664
    1665
    1666
    1667
    1668
    1669
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1637

    class Route < 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.appliance.techpreview.networking.routes.route',
                    {
                        'destination' => VAPI::Bindings::StringType.instance,
                        'prefix' => VAPI::Bindings::IntegerType.instance,
                        'gateway' => VAPI::Bindings::StringType.instance,
                        'interface_name' => VAPI::Bindings::StringType.instance,
                    },
                    Route,
                    false,
                    nil)
            end
        end

        attr_accessor :destination,
                      :prefix,
                      :gateway,
                      :interface_name

        # 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

    1643
    1644
    1645
    1646
    1647
    1648
    1649
    1650
    1651
    1652
    1653
    1654
    1655
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1643

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.appliance.techpreview.networking.routes.route',
            {
                'destination' => VAPI::Bindings::StringType.instance,
                'prefix' => VAPI::Bindings::IntegerType.instance,
                'gateway' => VAPI::Bindings::StringType.instance,
                'interface_name' => VAPI::Bindings::StringType.instance,
            },
            Route,
            false,
            nil)
    end