Class: Com::Vmware::Vcenter::Vm::HardwareService::UpgradeStatus

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

Overview

The ``Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus`` enumerated type defines the valid virtual hardware upgrade statuses for a virtual machine.

Constant Summary

NONE = 
UpgradeStatus.new('NONE')
PENDING = 
UpgradeStatus.new('PENDING')
SUCCESS = 
UpgradeStatus.new('SUCCESS')
FAILED = 
UpgradeStatus.new('FAILED')

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Attribute Details

- (Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus) failed

The most recent scheduled upgrade was not successful.

Returns:

  • (Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus) 


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
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm.rb', line 507

class UpgradeStatus < 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.vcenter.vm.hardware.upgrade_status',
                UpgradeStatus)
        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 [UpgradeStatus] 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
                UpgradeStatus.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] none
    #     @return [Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus]
    #     No scheduled upgrade has been attempted.
    NONE = UpgradeStatus.new('NONE')

    # @!attribute [rw] pending
    #     @return [Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus]
    #     Upgrade is scheduled but has not yet been run.
    PENDING = UpgradeStatus.new('PENDING')

    # @!attribute [rw] success
    #     @return [Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus]
    #     The most recent scheduled upgrade was successful.
    SUCCESS = UpgradeStatus.new('SUCCESS')

    # @!attribute [rw] failed
    #     @return [Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus]
    #     The most recent scheduled upgrade was not successful.
    FAILED = UpgradeStatus.new('FAILED')

end

- (Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus) none

No scheduled upgrade has been attempted.

Returns:

  • (Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus) 


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
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm.rb', line 507

class UpgradeStatus < 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.vcenter.vm.hardware.upgrade_status',
                UpgradeStatus)
        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 [UpgradeStatus] 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
                UpgradeStatus.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] none
    #     @return [Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus]
    #     No scheduled upgrade has been attempted.
    NONE = UpgradeStatus.new('NONE')

    # @!attribute [rw] pending
    #     @return [Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus]
    #     Upgrade is scheduled but has not yet been run.
    PENDING = UpgradeStatus.new('PENDING')

    # @!attribute [rw] success
    #     @return [Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus]
    #     The most recent scheduled upgrade was successful.
    SUCCESS = UpgradeStatus.new('SUCCESS')

    # @!attribute [rw] failed
    #     @return [Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus]
    #     The most recent scheduled upgrade was not successful.
    FAILED = UpgradeStatus.new('FAILED')

end

- (Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus) pending

Upgrade is scheduled but has not yet been run.

Returns:

  • (Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus) 


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
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm.rb', line 507

class UpgradeStatus < 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.vcenter.vm.hardware.upgrade_status',
                UpgradeStatus)
        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 [UpgradeStatus] 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
                UpgradeStatus.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] none
    #     @return [Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus]
    #     No scheduled upgrade has been attempted.
    NONE = UpgradeStatus.new('NONE')

    # @!attribute [rw] pending
    #     @return [Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus]
    #     Upgrade is scheduled but has not yet been run.
    PENDING = UpgradeStatus.new('PENDING')

    # @!attribute [rw] success
    #     @return [Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus]
    #     The most recent scheduled upgrade was successful.
    SUCCESS = UpgradeStatus.new('SUCCESS')

    # @!attribute [rw] failed
    #     @return [Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus]
    #     The most recent scheduled upgrade was not successful.
    FAILED = UpgradeStatus.new('FAILED')

end

- (Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus) success

The most recent scheduled upgrade was successful.

Returns:

  • (Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus) 


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
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm.rb', line 507

class UpgradeStatus < 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.vcenter.vm.hardware.upgrade_status',
                UpgradeStatus)
        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 [UpgradeStatus] 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
                UpgradeStatus.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] none
    #     @return [Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus]
    #     No scheduled upgrade has been attempted.
    NONE = UpgradeStatus.new('NONE')

    # @!attribute [rw] pending
    #     @return [Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus]
    #     Upgrade is scheduled but has not yet been run.
    PENDING = UpgradeStatus.new('PENDING')

    # @!attribute [rw] success
    #     @return [Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus]
    #     The most recent scheduled upgrade was successful.
    SUCCESS = UpgradeStatus.new('SUCCESS')

    # @!attribute [rw] failed
    #     @return [Com::Vmware::Vcenter::Vm::Hardware::UpgradeStatus]
    #     The most recent scheduled upgrade was not successful.
    FAILED = UpgradeStatus.new('FAILED')

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 



513
514
515
516
517
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm.rb', line 513

def binding_type
    @binding_type ||= VAPI::Bindings::EnumType.new(
        'com.vmware.vcenter.vm.hardware.upgrade_status',
        UpgradeStatus)
end

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

  • (UpgradeStatus) —

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



524
525
526
527
528
529
530
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm.rb', line 524

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