Class List Method List File List

# Class: Com::Vmware::Appliance::Vmon::Service::Health

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

## Overview

The ``Com::Vmware::Appliance::Vmon::Service::Health`` enumerated type defines the possible values for health of a service.

## Constant Summary

DEGRADED =

      Health.new('DEGRADED')

HEALTHY =

      Health.new('HEALTHY')

HEALTHY_WITH_WARNINGS =

      Health.new('HEALTHY_WITH_WARNINGS')

## Instance Attribute Summary (collapse)

- - (Com::Vmware::Appliance::Vmon::Service::Health) degraded

  Service is in degraded state, it is not functional.

- - (Com::Vmware::Appliance::Vmon::Service::Health) healthy

  Service is in a healthy state and is fully functional.

- - (Com::Vmware::Appliance::Vmon::Service::Health) healthy_with_warnings

  Service is healthy with warnings.

## Class Method Summary (collapse)

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

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

- + (Health) 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::Vmon::Service::Health`) degraded

Service is in degraded state, it is not functional.

Returns:

- (`Com::Vmware::Appliance::Vmon::Service::Health`)

    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/vmon.rb', line 489

    class Health < 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.vmon.service.health',
                    Health)
            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 [Health] 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
                    Health.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] degraded
        #     @return [Com::Vmware::Appliance::Vmon::Service::Health]
        #     Service is in degraded state, it is not functional.
        DEGRADED = Health.new('DEGRADED')

        # @!attribute [rw] healthy
        #     @return [Com::Vmware::Appliance::Vmon::Service::Health]
        #     Service is in a healthy state and is fully functional.
        HEALTHY = Health.new('HEALTHY')

        # @!attribute [rw] healthy_with_warnings
        #     @return [Com::Vmware::Appliance::Vmon::Service::Health]
        #     Service is healthy with warnings.
        HEALTHY_WITH_WARNINGS = Health.new('HEALTHY_WITH_WARNINGS')

    end

### - (`Com::Vmware::Appliance::Vmon::Service::Health`) healthy

Service is in a healthy state and is fully functional.

Returns:

- (`Com::Vmware::Appliance::Vmon::Service::Health`)

    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/vmon.rb', line 489

    class Health < 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.vmon.service.health',
                    Health)
            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 [Health] 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
                    Health.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] degraded
        #     @return [Com::Vmware::Appliance::Vmon::Service::Health]
        #     Service is in degraded state, it is not functional.
        DEGRADED = Health.new('DEGRADED')

        # @!attribute [rw] healthy
        #     @return [Com::Vmware::Appliance::Vmon::Service::Health]
        #     Service is in a healthy state and is fully functional.
        HEALTHY = Health.new('HEALTHY')

        # @!attribute [rw] healthy_with_warnings
        #     @return [Com::Vmware::Appliance::Vmon::Service::Health]
        #     Service is healthy with warnings.
        HEALTHY_WITH_WARNINGS = Health.new('HEALTHY_WITH_WARNINGS')

    end

### - (`Com::Vmware::Appliance::Vmon::Service::Health`) healthy_with_warnings

Service is healthy with warnings.

Returns:

- (`Com::Vmware::Appliance::Vmon::Service::Health`)

    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/vmon.rb', line 489

    class Health < 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.vmon.service.health',
                    Health)
            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 [Health] 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
                    Health.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] degraded
        #     @return [Com::Vmware::Appliance::Vmon::Service::Health]
        #     Service is in degraded state, it is not functional.
        DEGRADED = Health.new('DEGRADED')

        # @!attribute [rw] healthy
        #     @return [Com::Vmware::Appliance::Vmon::Service::Health]
        #     Service is in a healthy state and is fully functional.
        HEALTHY = Health.new('HEALTHY')

        # @!attribute [rw] healthy_with_warnings
        #     @return [Com::Vmware::Appliance::Vmon::Service::Health]
        #     Service is healthy with warnings.
        HEALTHY_WITH_WARNINGS = Health.new('HEALTHY_WITH_WARNINGS')

    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

    495
    496
    497
    498
    499
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/vmon.rb', line 495

    def binding_type
        @binding_type ||= VAPI::Bindings::EnumType.new(
            'com.vmware.appliance.vmon.service.health',
            Health)
    end

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

- (`Health`) —

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

    506
    507
    508
    509
    510
    511
    512
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/vmon.rb', line 506

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