Class List Method List File List

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

Inherits:
  VAPI::Bindings::VapiEnum
  - Object
  - VAPI::Bindings::VapiEnum
  - Com::Vmware::Appliance::Health::Softwarepackages::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::Softwarepackages::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::Softwarepackages::HealthLevel) gray

  No health data is available for this service.

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

  Service is healthy.

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

  The service health is degraded.

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

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

- - (Com::Vmware::Appliance::Health::Softwarepackages::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::Softwarepackages::HealthLevel`) gray

No health data is available for this service.

Returns:

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

    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    534
    535
    536
    537
    538
    539
    540
    541
    542
    543
    544
    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb', line 516

    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.softwarepackages.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::Softwarepackages::HealthLevel]
        #     The service health is degraded. The service might have serious problems
        ORANGE = HealthLevel.new('ORANGE')

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

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

        # @!attribute [rw] red
        #     @return [Com::Vmware::Appliance::Health::Softwarepackages::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::Softwarepackages::HealthLevel]
        #     The service is healthy state, but experiencing some levels of problems.
        YELLOW = HealthLevel.new('YELLOW')

    end

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

Service is healthy.

Returns:

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

    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    534
    535
    536
    537
    538
    539
    540
    541
    542
    543
    544
    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb', line 516

    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.softwarepackages.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::Softwarepackages::HealthLevel]
        #     The service health is degraded. The service might have serious problems
        ORANGE = HealthLevel.new('ORANGE')

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

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

        # @!attribute [rw] red
        #     @return [Com::Vmware::Appliance::Health::Softwarepackages::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::Softwarepackages::HealthLevel]
        #     The service is healthy state, but experiencing some levels of problems.
        YELLOW = HealthLevel.new('YELLOW')

    end

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

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

Returns:

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

    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    534
    535
    536
    537
    538
    539
    540
    541
    542
    543
    544
    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb', line 516

    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.softwarepackages.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::Softwarepackages::HealthLevel]
        #     The service health is degraded. The service might have serious problems
        ORANGE = HealthLevel.new('ORANGE')

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

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

        # @!attribute [rw] red
        #     @return [Com::Vmware::Appliance::Health::Softwarepackages::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::Softwarepackages::HealthLevel]
        #     The service is healthy state, but experiencing some levels of problems.
        YELLOW = HealthLevel.new('YELLOW')

    end

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

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

Returns:

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

    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    534
    535
    536
    537
    538
    539
    540
    541
    542
    543
    544
    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb', line 516

    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.softwarepackages.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::Softwarepackages::HealthLevel]
        #     The service health is degraded. The service might have serious problems
        ORANGE = HealthLevel.new('ORANGE')

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

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

        # @!attribute [rw] red
        #     @return [Com::Vmware::Appliance::Health::Softwarepackages::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::Softwarepackages::HealthLevel]
        #     The service is healthy state, but experiencing some levels of problems.
        YELLOW = HealthLevel.new('YELLOW')

    end

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

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

Returns:

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

    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    534
    535
    536
    537
    538
    539
    540
    541
    542
    543
    544
    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb', line 516

    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.softwarepackages.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::Softwarepackages::HealthLevel]
        #     The service health is degraded. The service might have serious problems
        ORANGE = HealthLevel.new('ORANGE')

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

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

        # @!attribute [rw] red
        #     @return [Com::Vmware::Appliance::Health::Softwarepackages::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::Softwarepackages::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

    522
    523
    524
    525
    526
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb', line 522

    def binding_type
        @binding_type ||= VAPI::Bindings::EnumType.new(
            'com.vmware.appliance.health.softwarepackages.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

    533
    534
    535
    536
    537
    538
    539
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb', line 533

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