Class List Method List File List

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

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Appliance::Techpreview::Networking::Routes::RouteReadOnly
  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::RouteReadOnly`` 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”.

- - (Boolean) is_static

  Static provides information about installation of the route.

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

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

  Constructs a new instance.

## Constructor Details

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

    1618
    1619
    1620
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1618

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

    1587
    1588
    1589
    1590
    1591
    1592
    1593
    1594
    1595
    1596
    1597
    1598
    1599
    1600
    1601
    1602
    1603
    1604
    1605
    1606
    1607
    1608
    1609
    1610
    1611
    1612
    1613
    1614
    1615
    1616
    1617
    1618
    1619
    1620
    1621
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1587

    class RouteReadOnly < 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_read_only',
                    {
                        'destination' => VAPI::Bindings::StringType.instance,
                        'prefix' => VAPI::Bindings::IntegerType.instance,
                        'gateway' => VAPI::Bindings::StringType.instance,
                        'interface_name' => VAPI::Bindings::StringType.instance,
                        'is_static' => VAPI::Bindings::BooleanType.instance,
                    },
                    RouteReadOnly,
                    false,
                    nil)
            end
        end

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

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

    1587
    1588
    1589
    1590
    1591
    1592
    1593
    1594
    1595
    1596
    1597
    1598
    1599
    1600
    1601
    1602
    1603
    1604
    1605
    1606
    1607
    1608
    1609
    1610
    1611
    1612
    1613
    1614
    1615
    1616
    1617
    1618
    1619
    1620
    1621
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1587

    class RouteReadOnly < 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_read_only',
                    {
                        'destination' => VAPI::Bindings::StringType.instance,
                        'prefix' => VAPI::Bindings::IntegerType.instance,
                        'gateway' => VAPI::Bindings::StringType.instance,
                        'interface_name' => VAPI::Bindings::StringType.instance,
                        'is_static' => VAPI::Bindings::BooleanType.instance,
                    },
                    RouteReadOnly,
                    false,
                    nil)
            end
        end

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

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

    1587
    1588
    1589
    1590
    1591
    1592
    1593
    1594
    1595
    1596
    1597
    1598
    1599
    1600
    1601
    1602
    1603
    1604
    1605
    1606
    1607
    1608
    1609
    1610
    1611
    1612
    1613
    1614
    1615
    1616
    1617
    1618
    1619
    1620
    1621
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1587

    class RouteReadOnly < 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_read_only',
                    {
                        'destination' => VAPI::Bindings::StringType.instance,
                        'prefix' => VAPI::Bindings::IntegerType.instance,
                        'gateway' => VAPI::Bindings::StringType.instance,
                        'interface_name' => VAPI::Bindings::StringType.instance,
                        'is_static' => VAPI::Bindings::BooleanType.instance,
                    },
                    RouteReadOnly,
                    false,
                    nil)
            end
        end

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

        # 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

### - (`Boolean`) is_static

Static provides information about installation of the route. True indicates the route was installed by the administrator. False indicates the route was autoconfigured

Returns:

- (`Boolean`)

    1587
    1588
    1589
    1590
    1591
    1592
    1593
    1594
    1595
    1596
    1597
    1598
    1599
    1600
    1601
    1602
    1603
    1604
    1605
    1606
    1607
    1608
    1609
    1610
    1611
    1612
    1613
    1614
    1615
    1616
    1617
    1618
    1619
    1620
    1621
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1587

    class RouteReadOnly < 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_read_only',
                    {
                        'destination' => VAPI::Bindings::StringType.instance,
                        'prefix' => VAPI::Bindings::IntegerType.instance,
                        'gateway' => VAPI::Bindings::StringType.instance,
                        'interface_name' => VAPI::Bindings::StringType.instance,
                        'is_static' => VAPI::Bindings::BooleanType.instance,
                    },
                    RouteReadOnly,
                    false,
                    nil)
            end
        end

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

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

    1587
    1588
    1589
    1590
    1591
    1592
    1593
    1594
    1595
    1596
    1597
    1598
    1599
    1600
    1601
    1602
    1603
    1604
    1605
    1606
    1607
    1608
    1609
    1610
    1611
    1612
    1613
    1614
    1615
    1616
    1617
    1618
    1619
    1620
    1621
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1587

    class RouteReadOnly < 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_read_only',
                    {
                        'destination' => VAPI::Bindings::StringType.instance,
                        'prefix' => VAPI::Bindings::IntegerType.instance,
                        'gateway' => VAPI::Bindings::StringType.instance,
                        'interface_name' => VAPI::Bindings::StringType.instance,
                        'is_static' => VAPI::Bindings::BooleanType.instance,
                    },
                    RouteReadOnly,
                    false,
                    nil)
            end
        end

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

        # 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

    1593
    1594
    1595
    1596
    1597
    1598
    1599
    1600
    1601
    1602
    1603
    1604
    1605
    1606
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1593

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