Class: Com::Vmware::Appliance::Health::Load::HealthLevel

Inherits:
VAPI::Bindings::VapiEnum
  • Object
show all
Defined in:
/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb

Overview

``Com::Vmware::Appliance::Health::Load::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)

Class Method Summary (collapse)

Instance Attribute Details

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

No health data is available for this service.

Returns:



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
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
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb', line 258

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

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

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

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

end

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

Service is healthy.

Returns:



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
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
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb', line 258

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

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

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

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

end

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

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

Returns:



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
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
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb', line 258

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

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

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

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

end

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

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

Returns:



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
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
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb', line 258

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

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

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

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

end

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

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

Returns:



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
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
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb', line 258

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

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

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

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



264
265
266
267
268
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb', line 264

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



275
276
277
278
279
280
281
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/health.rb', line 275

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