Class: Com::Vmware::Appliance::Vmon::Service::State

Inherits:
VAPI::Bindings::VapiEnum
  • Object
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::State`` enumerated type defines valid Run State for services.

Constant Summary

STARTING = 
State.new('STARTING')
STOPPING = 
State.new('STOPPING')
STARTED = 
State.new('STARTED')
STOPPED = 
State.new('STOPPED')

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Attribute Details

- (Com::Vmware::Appliance::Vmon::Service::State) started

Service Run State is Started, it is fully functional

Returns:



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/vmon.rb', line 419

class State < 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.state',
                State)
        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 [State] 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
                State.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] starting
    #     @return [Com::Vmware::Appliance::Vmon::Service::State]
    #     Service Run State is Starting, it is still not functional
    STARTING = State.new('STARTING')

    # @!attribute [rw] stopping
    #     @return [Com::Vmware::Appliance::Vmon::Service::State]
    #     Service Run State is Stopping, it is not functional
    STOPPING = State.new('STOPPING')

    # @!attribute [rw] started
    #     @return [Com::Vmware::Appliance::Vmon::Service::State]
    #     Service Run State is Started, it is fully functional
    STARTED = State.new('STARTED')

    # @!attribute [rw] stopped
    #     @return [Com::Vmware::Appliance::Vmon::Service::State]
    #     Service Run State is Stopped
    STOPPED = State.new('STOPPED')

end

- (Com::Vmware::Appliance::Vmon::Service::State) starting

Service Run State is Starting, it is still not functional

Returns:



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/vmon.rb', line 419

class State < 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.state',
                State)
        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 [State] 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
                State.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] starting
    #     @return [Com::Vmware::Appliance::Vmon::Service::State]
    #     Service Run State is Starting, it is still not functional
    STARTING = State.new('STARTING')

    # @!attribute [rw] stopping
    #     @return [Com::Vmware::Appliance::Vmon::Service::State]
    #     Service Run State is Stopping, it is not functional
    STOPPING = State.new('STOPPING')

    # @!attribute [rw] started
    #     @return [Com::Vmware::Appliance::Vmon::Service::State]
    #     Service Run State is Started, it is fully functional
    STARTED = State.new('STARTED')

    # @!attribute [rw] stopped
    #     @return [Com::Vmware::Appliance::Vmon::Service::State]
    #     Service Run State is Stopped
    STOPPED = State.new('STOPPED')

end

- (Com::Vmware::Appliance::Vmon::Service::State) stopped

Service Run State is Stopped

Returns:



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/vmon.rb', line 419

class State < 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.state',
                State)
        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 [State] 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
                State.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] starting
    #     @return [Com::Vmware::Appliance::Vmon::Service::State]
    #     Service Run State is Starting, it is still not functional
    STARTING = State.new('STARTING')

    # @!attribute [rw] stopping
    #     @return [Com::Vmware::Appliance::Vmon::Service::State]
    #     Service Run State is Stopping, it is not functional
    STOPPING = State.new('STOPPING')

    # @!attribute [rw] started
    #     @return [Com::Vmware::Appliance::Vmon::Service::State]
    #     Service Run State is Started, it is fully functional
    STARTED = State.new('STARTED')

    # @!attribute [rw] stopped
    #     @return [Com::Vmware::Appliance::Vmon::Service::State]
    #     Service Run State is Stopped
    STOPPED = State.new('STOPPED')

end

- (Com::Vmware::Appliance::Vmon::Service::State) stopping

Service Run State is Stopping, it is not functional

Returns:



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/vmon.rb', line 419

class State < 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.state',
                State)
        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 [State] 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
                State.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] starting
    #     @return [Com::Vmware::Appliance::Vmon::Service::State]
    #     Service Run State is Starting, it is still not functional
    STARTING = State.new('STARTING')

    # @!attribute [rw] stopping
    #     @return [Com::Vmware::Appliance::Vmon::Service::State]
    #     Service Run State is Stopping, it is not functional
    STOPPING = State.new('STOPPING')

    # @!attribute [rw] started
    #     @return [Com::Vmware::Appliance::Vmon::Service::State]
    #     Service Run State is Started, it is fully functional
    STARTED = State.new('STARTED')

    # @!attribute [rw] stopped
    #     @return [Com::Vmware::Appliance::Vmon::Service::State]
    #     Service Run State is Stopped
    STOPPED = State.new('STOPPED')

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 



425
426
427
428
429
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/vmon.rb', line 425

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

+ (State) 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:

  • (State) —

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



436
437
438
439
440
441
442
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/vmon.rb', line 436

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