Class List Method List File List

# Class: Com::Vmware::Appliance::Techpreview::NtpService::TestStatus

Inherits:
  VAPI::Bindings::VapiEnum
  - Object
  - VAPI::Bindings::VapiEnum
  - Com::Vmware::Appliance::Techpreview::NtpService::TestStatus
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview.rb

## Overview

``Com::Vmware::Appliance::Techpreview::Ntp::TestStatus`` enumerated type Health indicator

## Constant Summary

ORANGE =

      TestStatus.new('ORANGE')

GREEN =

      TestStatus.new('GREEN')

RED =

      TestStatus.new('RED')

## Instance Attribute Summary (collapse)

- - (Com::Vmware::Appliance::Techpreview::Ntp::TestStatus) green

  All tests were successful for given data.

- - (Com::Vmware::Appliance::Techpreview::Ntp::TestStatus) orange

  In case data has more than one test, this indicates not all tests were successful.

- - (Com::Vmware::Appliance::Techpreview::Ntp::TestStatus) red

  All tests failed for given data.

## Class Method Summary (collapse)

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

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

- + (TestStatus) 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::Techpreview::Ntp::TestStatus`) green

All tests were successful for given data

Returns:

- (`Com::Vmware::Appliance::Techpreview::Ntp::TestStatus`)

    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview.rb', line 284

    class TestStatus < 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.techpreview.ntp.test_status',
                    TestStatus)
            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 [TestStatus] 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
                    TestStatus.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::Techpreview::Ntp::TestStatus]
        #     In case data has more than one test, this indicates not all tests were successful
        ORANGE = TestStatus.new('ORANGE')

        # @!attribute [rw] green
        #     @return [Com::Vmware::Appliance::Techpreview::Ntp::TestStatus]
        #     All tests were successful for given data
        GREEN = TestStatus.new('GREEN')

        # @!attribute [rw] red
        #     @return [Com::Vmware::Appliance::Techpreview::Ntp::TestStatus]
        #     All tests failed for given data
        RED = TestStatus.new('RED')

    end

### - (`Com::Vmware::Appliance::Techpreview::Ntp::TestStatus`) orange

In case data has more than one test, this indicates not all tests were successful

Returns:

- (`Com::Vmware::Appliance::Techpreview::Ntp::TestStatus`)

    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview.rb', line 284

    class TestStatus < 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.techpreview.ntp.test_status',
                    TestStatus)
            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 [TestStatus] 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
                    TestStatus.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::Techpreview::Ntp::TestStatus]
        #     In case data has more than one test, this indicates not all tests were successful
        ORANGE = TestStatus.new('ORANGE')

        # @!attribute [rw] green
        #     @return [Com::Vmware::Appliance::Techpreview::Ntp::TestStatus]
        #     All tests were successful for given data
        GREEN = TestStatus.new('GREEN')

        # @!attribute [rw] red
        #     @return [Com::Vmware::Appliance::Techpreview::Ntp::TestStatus]
        #     All tests failed for given data
        RED = TestStatus.new('RED')

    end

### - (`Com::Vmware::Appliance::Techpreview::Ntp::TestStatus`) red

All tests failed for given data

Returns:

- (`Com::Vmware::Appliance::Techpreview::Ntp::TestStatus`)

    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview.rb', line 284

    class TestStatus < 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.techpreview.ntp.test_status',
                    TestStatus)
            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 [TestStatus] 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
                    TestStatus.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::Techpreview::Ntp::TestStatus]
        #     In case data has more than one test, this indicates not all tests were successful
        ORANGE = TestStatus.new('ORANGE')

        # @!attribute [rw] green
        #     @return [Com::Vmware::Appliance::Techpreview::Ntp::TestStatus]
        #     All tests were successful for given data
        GREEN = TestStatus.new('GREEN')

        # @!attribute [rw] red
        #     @return [Com::Vmware::Appliance::Techpreview::Ntp::TestStatus]
        #     All tests failed for given data
        RED = TestStatus.new('RED')

    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

    290
    291
    292
    293
    294
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview.rb', line 290

    def binding_type
        @binding_type ||= VAPI::Bindings::EnumType.new(
            'com.vmware.appliance.techpreview.ntp.test_status',
            TestStatus)
    end

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

- (`TestStatus`) —

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

    301
    302
    303
    304
    305
    306
    307
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview.rb', line 301

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