Class List Method List File List

# Class: Com::Vmware::Vcenter::Host::ConnectionState

Inherits:
  VAPI::Bindings::VapiEnum
  - Object
  - VAPI::Bindings::VapiEnum
  - Com::Vmware::Vcenter::Host::ConnectionState
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb

## Overview

The ``Com::Vmware::Vcenter::Host::ConnectionState`` enumerated type defines the connection status of a host.

## Constant Summary

CONNECTED =

      ConnectionState.new('CONNECTED')

DISCONNECTED =

      ConnectionState.new('DISCONNECTED')

NOT_RESPONDING =

      ConnectionState.new('NOT_RESPONDING')

## Instance Attribute Summary (collapse)

- - (Com::Vmware::Vcenter::Host::ConnectionState) connected

  Host is connected to the vCenter Server.

- - (Com::Vmware::Vcenter::Host::ConnectionState) disconnected

  Host is disconnected from the vCenter Server.

- - (Com::Vmware::Vcenter::Host::ConnectionState) not_responding

  VirtualCenter is not receiving heartbeats from the server.

## Class Method Summary (collapse)

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

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

- + (ConnectionState) from_string(value)

  Converts from a string value (perhaps off the wire) to an instance of this enum type.

## Instance Attribute Details

### - (`Com::Vmware::Vcenter::Host::ConnectionState`) connected

Host is connected to the vCenter Server

Returns:

- (`Com::Vmware::Vcenter::Host::ConnectionState`)

    1790
    1791
    1792
    1793
    1794
    1795
    1796
    1797
    1798
    1799
    1800
    1801
    1802
    1803
    1804
    1805
    1806
    1807
    1808
    1809
    1810
    1811
    1812
    1813
    1814
    1815
    1816
    1817
    1818
    1819
    1820
    1821
    1822
    1823
    1824
    1825
    1826
    1827
    1828
    1829
    1830
    1831
    1832
    1833
    1834
    1835
    1836
    1837
    1838
    1839
    1840
    1841
    1842
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1790

    class ConnectionState < VAPI::Bindings::VapiEnum

        class << self
            # Holds (gets or creates) the binding type metadata for this enumeration type.
            # @scope class
            # @return [VAPI::Bindings::EnumType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::EnumType.new(
                    'com.vmware.vcenter.host.connection_state',
                    ConnectionState)
            end

            # Converts from a string value (perhaps off the wire) to an instance
            # of this enum type.
            # @param value [String] the actual value of the enum instance
            # @return [ConnectionState] the instance found for the value, otherwise
            #         an unknown instance will be built for the value
            def from_string(value)
                begin
                    const_get(value)
                rescue NameError
                    ConnectionState.new('UNKNOWN', value)
                end
            end
        end

        private

        # Constructs a new instance.
        # @param value [String] the actual value of the enum instance
        # @param unknown [String] the unknown value when value is 'UKNOWN'
        def initialize(value, unknown=nil)
            super(self.class.binding_type, value, unknown)
        end

        public

        # @!attribute [rw] connected
        #     @return [Com::Vmware::Vcenter::Host::ConnectionState]
        #     Host is connected to the vCenter Server
        CONNECTED = ConnectionState.new('CONNECTED')

        # @!attribute [rw] disconnected
        #     @return [Com::Vmware::Vcenter::Host::ConnectionState]
        #     Host is disconnected from the vCenter Server
        DISCONNECTED = ConnectionState.new('DISCONNECTED')

        # @!attribute [rw] not_responding
        #     @return [Com::Vmware::Vcenter::Host::ConnectionState]
        #     VirtualCenter is not receiving heartbeats from the server. The state automatically changes to connected once heartbeats are received again.
        NOT_RESPONDING = ConnectionState.new('NOT_RESPONDING')

    end

### - (`Com::Vmware::Vcenter::Host::ConnectionState`) disconnected

Host is disconnected from the vCenter Server

Returns:

- (`Com::Vmware::Vcenter::Host::ConnectionState`)

    1790
    1791
    1792
    1793
    1794
    1795
    1796
    1797
    1798
    1799
    1800
    1801
    1802
    1803
    1804
    1805
    1806
    1807
    1808
    1809
    1810
    1811
    1812
    1813
    1814
    1815
    1816
    1817
    1818
    1819
    1820
    1821
    1822
    1823
    1824
    1825
    1826
    1827
    1828
    1829
    1830
    1831
    1832
    1833
    1834
    1835
    1836
    1837
    1838
    1839
    1840
    1841
    1842
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1790

    class ConnectionState < VAPI::Bindings::VapiEnum

        class << self
            # Holds (gets or creates) the binding type metadata for this enumeration type.
            # @scope class
            # @return [VAPI::Bindings::EnumType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::EnumType.new(
                    'com.vmware.vcenter.host.connection_state',
                    ConnectionState)
            end

            # Converts from a string value (perhaps off the wire) to an instance
            # of this enum type.
            # @param value [String] the actual value of the enum instance
            # @return [ConnectionState] the instance found for the value, otherwise
            #         an unknown instance will be built for the value
            def from_string(value)
                begin
                    const_get(value)
                rescue NameError
                    ConnectionState.new('UNKNOWN', value)
                end
            end
        end

        private

        # Constructs a new instance.
        # @param value [String] the actual value of the enum instance
        # @param unknown [String] the unknown value when value is 'UKNOWN'
        def initialize(value, unknown=nil)
            super(self.class.binding_type, value, unknown)
        end

        public

        # @!attribute [rw] connected
        #     @return [Com::Vmware::Vcenter::Host::ConnectionState]
        #     Host is connected to the vCenter Server
        CONNECTED = ConnectionState.new('CONNECTED')

        # @!attribute [rw] disconnected
        #     @return [Com::Vmware::Vcenter::Host::ConnectionState]
        #     Host is disconnected from the vCenter Server
        DISCONNECTED = ConnectionState.new('DISCONNECTED')

        # @!attribute [rw] not_responding
        #     @return [Com::Vmware::Vcenter::Host::ConnectionState]
        #     VirtualCenter is not receiving heartbeats from the server. The state automatically changes to connected once heartbeats are received again.
        NOT_RESPONDING = ConnectionState.new('NOT_RESPONDING')

    end

### - (`Com::Vmware::Vcenter::Host::ConnectionState`) not_responding

VirtualCenter is not receiving heartbeats from the server. The state automatically changes to connected once heartbeats are received again.

Returns:

- (`Com::Vmware::Vcenter::Host::ConnectionState`)

    1790
    1791
    1792
    1793
    1794
    1795
    1796
    1797
    1798
    1799
    1800
    1801
    1802
    1803
    1804
    1805
    1806
    1807
    1808
    1809
    1810
    1811
    1812
    1813
    1814
    1815
    1816
    1817
    1818
    1819
    1820
    1821
    1822
    1823
    1824
    1825
    1826
    1827
    1828
    1829
    1830
    1831
    1832
    1833
    1834
    1835
    1836
    1837
    1838
    1839
    1840
    1841
    1842
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1790

    class ConnectionState < VAPI::Bindings::VapiEnum

        class << self
            # Holds (gets or creates) the binding type metadata for this enumeration type.
            # @scope class
            # @return [VAPI::Bindings::EnumType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::EnumType.new(
                    'com.vmware.vcenter.host.connection_state',
                    ConnectionState)
            end

            # Converts from a string value (perhaps off the wire) to an instance
            # of this enum type.
            # @param value [String] the actual value of the enum instance
            # @return [ConnectionState] the instance found for the value, otherwise
            #         an unknown instance will be built for the value
            def from_string(value)
                begin
                    const_get(value)
                rescue NameError
                    ConnectionState.new('UNKNOWN', value)
                end
            end
        end

        private

        # Constructs a new instance.
        # @param value [String] the actual value of the enum instance
        # @param unknown [String] the unknown value when value is 'UKNOWN'
        def initialize(value, unknown=nil)
            super(self.class.binding_type, value, unknown)
        end

        public

        # @!attribute [rw] connected
        #     @return [Com::Vmware::Vcenter::Host::ConnectionState]
        #     Host is connected to the vCenter Server
        CONNECTED = ConnectionState.new('CONNECTED')

        # @!attribute [rw] disconnected
        #     @return [Com::Vmware::Vcenter::Host::ConnectionState]
        #     Host is disconnected from the vCenter Server
        DISCONNECTED = ConnectionState.new('DISCONNECTED')

        # @!attribute [rw] not_responding
        #     @return [Com::Vmware::Vcenter::Host::ConnectionState]
        #     VirtualCenter is not receiving heartbeats from the server. The state automatically changes to connected once heartbeats are received again.
        NOT_RESPONDING = ConnectionState.new('NOT_RESPONDING')

    end

## Class Method Details

### + (`VAPI::Bindings::EnumType`) binding_type

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

Returns:

- (`VAPI::Bindings::EnumType`) —

  the binding type

    1796
    1797
    1798
    1799
    1800
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1796

    def binding_type
        @binding_type ||= VAPI::Bindings::EnumType.new(
            'com.vmware.vcenter.host.connection_state',
            ConnectionState)
    end

### + (`ConnectionState`) from_string(value)

Converts from a string value (perhaps off the wire) to an instance of this enum type.

Parameters:

- value (`String`) —

  the actual value of the enum instance

Returns:

- (`ConnectionState`) —

  the instance found for the value, otherwise an unknown instance will be built for the value

    1807
    1808
    1809
    1810
    1811
    1812
    1813
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1807

    def from_string(value)
        begin
            const_get(value)
        rescue NameError
            ConnectionState.new('UNKNOWN', value)
        end
    end