Class List Method List File List

# Class: Com::Vmware::Appliance::Health::Storage::HealthLevel

Inherits:
  VAPI::Bindings::VapiEnum
  - Object
  - VAPI::Bindings::VapiEnum
  - Com::Vmware::Appliance::Health::Storage::HealthLevel
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb

## Overview

``Com::Vmware::Appliance::Health::Storage::HealthLevel`` enumerated type Defines health levels

## Constant Summary

ORANGE =

      HealthLevel.new('ORANGE')

GRAY =

      HealthLevel.new('GRAY')

GREEN =

      HealthLevel.new('GREEN')

RED =

      HealthLevel.new('RED')

YELLOW =

      HealthLevel.new('YELLOW')

## Instance Attribute Summary (collapse)

- - (Com::Vmware::Appliance::Health::Storage::HealthLevel) gray

  No health data is available for this service.

- - (Com::Vmware::Appliance::Health::Storage::HealthLevel) green

  Service is healthy.

- - (Com::Vmware::Appliance::Health::Storage::HealthLevel) orange

  The service health is degraded.

- - (Com::Vmware::Appliance::Health::Storage::HealthLevel) red

  The service is unavaiable and is not functioning properly or will stop functioning soon.

- - (Com::Vmware::Appliance::Health::Storage::HealthLevel) yellow

  The service is healthy state, but experiencing some levels of problems.

## Class Method Summary (collapse)

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

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

- + (HealthLevel) from_string(value)

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

## Instance Attribute Details

### - (`Com::Vmware::Appliance::Health::Storage::HealthLevel`) gray

No health data is available for this service.

Returns:

- (`Com::Vmware::Appliance::Health::Storage::HealthLevel`)

    645
    646
    647
    648
    649
    650
    651
    652
    653
    654
    655
    656
    657
    658
    659
    660
    661
    662
    663
    664
    665
    666
    667
    668
    669
    670
    671
    672
    673
    674
    675
    676
    677
    678
    679
    680
    681
    682
    683
    684
    685
    686
    687
    688
    689
    690
    691
    692
    693
    694
    695
    696
    697
    698
    699
    700
    701
    702
    703
    704
    705
    706
    707
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb', line 645

    class HealthLevel < 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.appliance.health.storage.health_level',
                    HealthLevel)
            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 [HealthLevel] 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
                    HealthLevel.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] orange
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     The service health is degraded. The service might have serious problems
        ORANGE = HealthLevel.new('ORANGE')

        # @!attribute [rw] gray
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     No health data is available for this service.
        GRAY = HealthLevel.new('GRAY')

        # @!attribute [rw] green
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     Service is healthy.
        GREEN = HealthLevel.new('GREEN')

        # @!attribute [rw] red
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     The service is unavaiable and is not functioning properly or will stop functioning soon.
        RED = HealthLevel.new('RED')

        # @!attribute [rw] yellow
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     The service is healthy state, but experiencing some levels of problems.
        YELLOW = HealthLevel.new('YELLOW')

    end

### - (`Com::Vmware::Appliance::Health::Storage::HealthLevel`) green

Service is healthy.

Returns:

- (`Com::Vmware::Appliance::Health::Storage::HealthLevel`)

    645
    646
    647
    648
    649
    650
    651
    652
    653
    654
    655
    656
    657
    658
    659
    660
    661
    662
    663
    664
    665
    666
    667
    668
    669
    670
    671
    672
    673
    674
    675
    676
    677
    678
    679
    680
    681
    682
    683
    684
    685
    686
    687
    688
    689
    690
    691
    692
    693
    694
    695
    696
    697
    698
    699
    700
    701
    702
    703
    704
    705
    706
    707
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb', line 645

    class HealthLevel < 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.appliance.health.storage.health_level',
                    HealthLevel)
            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 [HealthLevel] 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
                    HealthLevel.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] orange
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     The service health is degraded. The service might have serious problems
        ORANGE = HealthLevel.new('ORANGE')

        # @!attribute [rw] gray
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     No health data is available for this service.
        GRAY = HealthLevel.new('GRAY')

        # @!attribute [rw] green
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     Service is healthy.
        GREEN = HealthLevel.new('GREEN')

        # @!attribute [rw] red
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     The service is unavaiable and is not functioning properly or will stop functioning soon.
        RED = HealthLevel.new('RED')

        # @!attribute [rw] yellow
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     The service is healthy state, but experiencing some levels of problems.
        YELLOW = HealthLevel.new('YELLOW')

    end

### - (`Com::Vmware::Appliance::Health::Storage::HealthLevel`) orange

The service health is degraded. The service might have serious problems

Returns:

- (`Com::Vmware::Appliance::Health::Storage::HealthLevel`)

    645
    646
    647
    648
    649
    650
    651
    652
    653
    654
    655
    656
    657
    658
    659
    660
    661
    662
    663
    664
    665
    666
    667
    668
    669
    670
    671
    672
    673
    674
    675
    676
    677
    678
    679
    680
    681
    682
    683
    684
    685
    686
    687
    688
    689
    690
    691
    692
    693
    694
    695
    696
    697
    698
    699
    700
    701
    702
    703
    704
    705
    706
    707
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb', line 645

    class HealthLevel < 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.appliance.health.storage.health_level',
                    HealthLevel)
            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 [HealthLevel] 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
                    HealthLevel.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] orange
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     The service health is degraded. The service might have serious problems
        ORANGE = HealthLevel.new('ORANGE')

        # @!attribute [rw] gray
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     No health data is available for this service.
        GRAY = HealthLevel.new('GRAY')

        # @!attribute [rw] green
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     Service is healthy.
        GREEN = HealthLevel.new('GREEN')

        # @!attribute [rw] red
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     The service is unavaiable and is not functioning properly or will stop functioning soon.
        RED = HealthLevel.new('RED')

        # @!attribute [rw] yellow
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     The service is healthy state, but experiencing some levels of problems.
        YELLOW = HealthLevel.new('YELLOW')

    end

### - (`Com::Vmware::Appliance::Health::Storage::HealthLevel`) red

The service is unavaiable and is not functioning properly or will stop functioning soon.

Returns:

- (`Com::Vmware::Appliance::Health::Storage::HealthLevel`)

    645
    646
    647
    648
    649
    650
    651
    652
    653
    654
    655
    656
    657
    658
    659
    660
    661
    662
    663
    664
    665
    666
    667
    668
    669
    670
    671
    672
    673
    674
    675
    676
    677
    678
    679
    680
    681
    682
    683
    684
    685
    686
    687
    688
    689
    690
    691
    692
    693
    694
    695
    696
    697
    698
    699
    700
    701
    702
    703
    704
    705
    706
    707
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb', line 645

    class HealthLevel < 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.appliance.health.storage.health_level',
                    HealthLevel)
            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 [HealthLevel] 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
                    HealthLevel.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] orange
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     The service health is degraded. The service might have serious problems
        ORANGE = HealthLevel.new('ORANGE')

        # @!attribute [rw] gray
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     No health data is available for this service.
        GRAY = HealthLevel.new('GRAY')

        # @!attribute [rw] green
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     Service is healthy.
        GREEN = HealthLevel.new('GREEN')

        # @!attribute [rw] red
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     The service is unavaiable and is not functioning properly or will stop functioning soon.
        RED = HealthLevel.new('RED')

        # @!attribute [rw] yellow
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     The service is healthy state, but experiencing some levels of problems.
        YELLOW = HealthLevel.new('YELLOW')

    end

### - (`Com::Vmware::Appliance::Health::Storage::HealthLevel`) yellow

The service is healthy state, but experiencing some levels of problems.

Returns:

- (`Com::Vmware::Appliance::Health::Storage::HealthLevel`)

    645
    646
    647
    648
    649
    650
    651
    652
    653
    654
    655
    656
    657
    658
    659
    660
    661
    662
    663
    664
    665
    666
    667
    668
    669
    670
    671
    672
    673
    674
    675
    676
    677
    678
    679
    680
    681
    682
    683
    684
    685
    686
    687
    688
    689
    690
    691
    692
    693
    694
    695
    696
    697
    698
    699
    700
    701
    702
    703
    704
    705
    706
    707
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb', line 645

    class HealthLevel < 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.appliance.health.storage.health_level',
                    HealthLevel)
            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 [HealthLevel] 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
                    HealthLevel.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] orange
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     The service health is degraded. The service might have serious problems
        ORANGE = HealthLevel.new('ORANGE')

        # @!attribute [rw] gray
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     No health data is available for this service.
        GRAY = HealthLevel.new('GRAY')

        # @!attribute [rw] green
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     Service is healthy.
        GREEN = HealthLevel.new('GREEN')

        # @!attribute [rw] red
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     The service is unavaiable and is not functioning properly or will stop functioning soon.
        RED = HealthLevel.new('RED')

        # @!attribute [rw] yellow
        #     @return [Com::Vmware::Appliance::Health::Storage::HealthLevel]
        #     The service is healthy state, but experiencing some levels of problems.
        YELLOW = HealthLevel.new('YELLOW')

    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

    651
    652
    653
    654
    655
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb', line 651

    def binding_type
        @binding_type ||= VAPI::Bindings::EnumType.new(
            'com.vmware.appliance.health.storage.health_level',
            HealthLevel)
    end

### + (`HealthLevel`) 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:

- (`HealthLevel`) —

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

    662
    663
    664
    665
    666
    667
    668
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb', line 662

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