Class List Method List File List

# Class: Com::Vmware::Vcenter::Vm::Hardware::ConnectionState

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

## Overview

The ``Com::Vmware::Vcenter::Vm::Hardware::ConnectionState`` enumerated type defines the valid states for a removable device that is configured to be connected.

## Constant Summary

CONNECTED =

      ConnectionState.new('CONNECTED')

RECOVERABLE_ERROR =

      ConnectionState.new('RECOVERABLE_ERROR')

UNRECOVERABLE_ERROR =

      ConnectionState.new('UNRECOVERABLE_ERROR')

NOT_CONNECTED =

      ConnectionState.new('NOT_CONNECTED')

UNKNOWN =

      ConnectionState.new('UNKNOWN')

## Instance Attribute Summary (collapse)

- - (Com::Vmware::Vcenter::Vm::Hardware::ConnectionState) connected

  The device is connected and working correctly.

- - (Com::Vmware::Vcenter::Vm::Hardware::ConnectionState) not_connected

  The device is not connected.

- - (Com::Vmware::Vcenter::Vm::Hardware::ConnectionState) recoverable_error

  Device connection failed due to a recoverable error; for example, the virtual device backing is currently in use by another virtual machine.

- - (Com::Vmware::Vcenter::Vm::Hardware::ConnectionState) unknown

  The device status is unknown.

- - (Com::Vmware::Vcenter::Vm::Hardware::ConnectionState) unrecoverable_error

  Device connection failed due to an unrecoverable error; for example, the virtual device backing does not exist.

## 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::Vm::Hardware::ConnectionState`) connected

The device is connected and working correctly.

Returns:

- (`Com::Vmware::Vcenter::Vm::Hardware::ConnectionState`)

    6164
    6165
    6166
    6167
    6168
    6169
    6170
    6171
    6172
    6173
    6174
    6175
    6176
    6177
    6178
    6179
    6180
    6181
    6182
    6183
    6184
    6185
    6186
    6187
    6188
    6189
    6190
    6191
    6192
    6193
    6194
    6195
    6196
    6197
    6198
    6199
    6200
    6201
    6202
    6203
    6204
    6205
    6206
    6207
    6208
    6209
    6210
    6211
    6212
    6213
    6214
    6215
    6216
    6217
    6218
    6219
    6220
    6221
    6222
    6223
    6224
    6225
    6226
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 6164

    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.vm.hardware.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::Vm::Hardware::ConnectionState]
        #     The device is connected and working correctly.
        CONNECTED = ConnectionState.new('CONNECTED')

        # @!attribute [rw] recoverable_error
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::ConnectionState]
        #     Device connection failed due to a recoverable error; for example, the virtual device backing is currently in use by another virtual machine.
        RECOVERABLE_ERROR = ConnectionState.new('RECOVERABLE_ERROR')

        # @!attribute [rw] unrecoverable_error
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::ConnectionState]
        #     Device connection failed due to an unrecoverable error; for example, the virtual device backing does not exist.
        UNRECOVERABLE_ERROR = ConnectionState.new('UNRECOVERABLE_ERROR')

        # @!attribute [rw] not_connected
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::ConnectionState]
        #     The device is not connected.
        NOT_CONNECTED = ConnectionState.new('NOT_CONNECTED')

        # @!attribute [rw] unknown
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::ConnectionState]
        #     The device status is unknown.
        UNKNOWN = ConnectionState.new('UNKNOWN')

    end

### - (`Com::Vmware::Vcenter::Vm::Hardware::ConnectionState`) not_connected

The device is not connected.

Returns:

- (`Com::Vmware::Vcenter::Vm::Hardware::ConnectionState`)

    6164
    6165
    6166
    6167
    6168
    6169
    6170
    6171
    6172
    6173
    6174
    6175
    6176
    6177
    6178
    6179
    6180
    6181
    6182
    6183
    6184
    6185
    6186
    6187
    6188
    6189
    6190
    6191
    6192
    6193
    6194
    6195
    6196
    6197
    6198
    6199
    6200
    6201
    6202
    6203
    6204
    6205
    6206
    6207
    6208
    6209
    6210
    6211
    6212
    6213
    6214
    6215
    6216
    6217
    6218
    6219
    6220
    6221
    6222
    6223
    6224
    6225
    6226
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 6164

    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.vm.hardware.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::Vm::Hardware::ConnectionState]
        #     The device is connected and working correctly.
        CONNECTED = ConnectionState.new('CONNECTED')

        # @!attribute [rw] recoverable_error
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::ConnectionState]
        #     Device connection failed due to a recoverable error; for example, the virtual device backing is currently in use by another virtual machine.
        RECOVERABLE_ERROR = ConnectionState.new('RECOVERABLE_ERROR')

        # @!attribute [rw] unrecoverable_error
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::ConnectionState]
        #     Device connection failed due to an unrecoverable error; for example, the virtual device backing does not exist.
        UNRECOVERABLE_ERROR = ConnectionState.new('UNRECOVERABLE_ERROR')

        # @!attribute [rw] not_connected
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::ConnectionState]
        #     The device is not connected.
        NOT_CONNECTED = ConnectionState.new('NOT_CONNECTED')

        # @!attribute [rw] unknown
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::ConnectionState]
        #     The device status is unknown.
        UNKNOWN = ConnectionState.new('UNKNOWN')

    end

### - (`Com::Vmware::Vcenter::Vm::Hardware::ConnectionState`) recoverable_error

Device connection failed due to a recoverable error; for example, the virtual device backing is currently in use by another virtual machine.

Returns:

- (`Com::Vmware::Vcenter::Vm::Hardware::ConnectionState`)

    6164
    6165
    6166
    6167
    6168
    6169
    6170
    6171
    6172
    6173
    6174
    6175
    6176
    6177
    6178
    6179
    6180
    6181
    6182
    6183
    6184
    6185
    6186
    6187
    6188
    6189
    6190
    6191
    6192
    6193
    6194
    6195
    6196
    6197
    6198
    6199
    6200
    6201
    6202
    6203
    6204
    6205
    6206
    6207
    6208
    6209
    6210
    6211
    6212
    6213
    6214
    6215
    6216
    6217
    6218
    6219
    6220
    6221
    6222
    6223
    6224
    6225
    6226
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 6164

    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.vm.hardware.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::Vm::Hardware::ConnectionState]
        #     The device is connected and working correctly.
        CONNECTED = ConnectionState.new('CONNECTED')

        # @!attribute [rw] recoverable_error
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::ConnectionState]
        #     Device connection failed due to a recoverable error; for example, the virtual device backing is currently in use by another virtual machine.
        RECOVERABLE_ERROR = ConnectionState.new('RECOVERABLE_ERROR')

        # @!attribute [rw] unrecoverable_error
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::ConnectionState]
        #     Device connection failed due to an unrecoverable error; for example, the virtual device backing does not exist.
        UNRECOVERABLE_ERROR = ConnectionState.new('UNRECOVERABLE_ERROR')

        # @!attribute [rw] not_connected
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::ConnectionState]
        #     The device is not connected.
        NOT_CONNECTED = ConnectionState.new('NOT_CONNECTED')

        # @!attribute [rw] unknown
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::ConnectionState]
        #     The device status is unknown.
        UNKNOWN = ConnectionState.new('UNKNOWN')

    end

### - (`Com::Vmware::Vcenter::Vm::Hardware::ConnectionState`) unknown

The device status is unknown.

Returns:

- (`Com::Vmware::Vcenter::Vm::Hardware::ConnectionState`)

    6164
    6165
    6166
    6167
    6168
    6169
    6170
    6171
    6172
    6173
    6174
    6175
    6176
    6177
    6178
    6179
    6180
    6181
    6182
    6183
    6184
    6185
    6186
    6187
    6188
    6189
    6190
    6191
    6192
    6193
    6194
    6195
    6196
    6197
    6198
    6199
    6200
    6201
    6202
    6203
    6204
    6205
    6206
    6207
    6208
    6209
    6210
    6211
    6212
    6213
    6214
    6215
    6216
    6217
    6218
    6219
    6220
    6221
    6222
    6223
    6224
    6225
    6226
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 6164

    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.vm.hardware.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::Vm::Hardware::ConnectionState]
        #     The device is connected and working correctly.
        CONNECTED = ConnectionState.new('CONNECTED')

        # @!attribute [rw] recoverable_error
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::ConnectionState]
        #     Device connection failed due to a recoverable error; for example, the virtual device backing is currently in use by another virtual machine.
        RECOVERABLE_ERROR = ConnectionState.new('RECOVERABLE_ERROR')

        # @!attribute [rw] unrecoverable_error
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::ConnectionState]
        #     Device connection failed due to an unrecoverable error; for example, the virtual device backing does not exist.
        UNRECOVERABLE_ERROR = ConnectionState.new('UNRECOVERABLE_ERROR')

        # @!attribute [rw] not_connected
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::ConnectionState]
        #     The device is not connected.
        NOT_CONNECTED = ConnectionState.new('NOT_CONNECTED')

        # @!attribute [rw] unknown
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::ConnectionState]
        #     The device status is unknown.
        UNKNOWN = ConnectionState.new('UNKNOWN')

    end

### - (`Com::Vmware::Vcenter::Vm::Hardware::ConnectionState`) unrecoverable_error

Device connection failed due to an unrecoverable error; for example, the virtual device backing does not exist.

Returns:

- (`Com::Vmware::Vcenter::Vm::Hardware::ConnectionState`)

    6164
    6165
    6166
    6167
    6168
    6169
    6170
    6171
    6172
    6173
    6174
    6175
    6176
    6177
    6178
    6179
    6180
    6181
    6182
    6183
    6184
    6185
    6186
    6187
    6188
    6189
    6190
    6191
    6192
    6193
    6194
    6195
    6196
    6197
    6198
    6199
    6200
    6201
    6202
    6203
    6204
    6205
    6206
    6207
    6208
    6209
    6210
    6211
    6212
    6213
    6214
    6215
    6216
    6217
    6218
    6219
    6220
    6221
    6222
    6223
    6224
    6225
    6226
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 6164

    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.vm.hardware.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::Vm::Hardware::ConnectionState]
        #     The device is connected and working correctly.
        CONNECTED = ConnectionState.new('CONNECTED')

        # @!attribute [rw] recoverable_error
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::ConnectionState]
        #     Device connection failed due to a recoverable error; for example, the virtual device backing is currently in use by another virtual machine.
        RECOVERABLE_ERROR = ConnectionState.new('RECOVERABLE_ERROR')

        # @!attribute [rw] unrecoverable_error
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::ConnectionState]
        #     Device connection failed due to an unrecoverable error; for example, the virtual device backing does not exist.
        UNRECOVERABLE_ERROR = ConnectionState.new('UNRECOVERABLE_ERROR')

        # @!attribute [rw] not_connected
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::ConnectionState]
        #     The device is not connected.
        NOT_CONNECTED = ConnectionState.new('NOT_CONNECTED')

        # @!attribute [rw] unknown
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::ConnectionState]
        #     The device status is unknown.
        UNKNOWN = ConnectionState.new('UNKNOWN')

    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

    6170
    6171
    6172
    6173
    6174
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 6170

    def binding_type
        @binding_type ||= VAPI::Bindings::EnumType.new(
            'com.vmware.vcenter.vm.hardware.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

    6181
    6182
    6183
    6184
    6185
    6186
    6187
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 6181

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