Class List Method List File List

# Class: Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState

Inherits:
  VAPI::Bindings::VapiEnum
  - Object
  - VAPI::Bindings::VapiEnum
  - Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb

## Overview

``Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState`` enumerated type Defines state of backup/restore process

## Constant Summary

FAILED =

      BackupRestoreProcessState.new('FAILED')

INPROGRESS =

      BackupRestoreProcessState.new('INPROGRESS')

NONE =

      BackupRestoreProcessState.new('NONE')

SUCCEEDED =

      BackupRestoreProcessState.new('SUCCEEDED')

## Instance Attribute Summary (collapse)

- - (Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState) failed

  Failed.

- - (Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState) inprogress

  In progress.

- - (Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState) none

  Not started.

- - (Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState) succeeded

  Completed successfully.

## Class Method Summary (collapse)

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

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

- + (BackupRestoreProcessState) 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::Recovery::Backup::Job::BackupRestoreProcessState`) failed

Failed

Returns:

- (`Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState`)

    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
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 528

    class BackupRestoreProcessState < 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.recovery.backup.job.backup_restore_process_state',
                    BackupRestoreProcessState)
            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 [BackupRestoreProcessState] 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
                    BackupRestoreProcessState.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] failed
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState]
        #     Failed
        FAILED = BackupRestoreProcessState.new('FAILED')

        # @!attribute [rw] inprogress
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState]
        #     In progress
        INPROGRESS = BackupRestoreProcessState.new('INPROGRESS')

        # @!attribute [rw] none
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState]
        #     Not started
        NONE = BackupRestoreProcessState.new('NONE')

        # @!attribute [rw] succeeded
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState]
        #     Completed successfully
        SUCCEEDED = BackupRestoreProcessState.new('SUCCEEDED')

    end

### - (`Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState`) inprogress

In progress

Returns:

- (`Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState`)

    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
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 528

    class BackupRestoreProcessState < 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.recovery.backup.job.backup_restore_process_state',
                    BackupRestoreProcessState)
            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 [BackupRestoreProcessState] 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
                    BackupRestoreProcessState.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] failed
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState]
        #     Failed
        FAILED = BackupRestoreProcessState.new('FAILED')

        # @!attribute [rw] inprogress
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState]
        #     In progress
        INPROGRESS = BackupRestoreProcessState.new('INPROGRESS')

        # @!attribute [rw] none
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState]
        #     Not started
        NONE = BackupRestoreProcessState.new('NONE')

        # @!attribute [rw] succeeded
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState]
        #     Completed successfully
        SUCCEEDED = BackupRestoreProcessState.new('SUCCEEDED')

    end

### - (`Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState`) none

Not started

Returns:

- (`Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState`)

    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
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 528

    class BackupRestoreProcessState < 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.recovery.backup.job.backup_restore_process_state',
                    BackupRestoreProcessState)
            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 [BackupRestoreProcessState] 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
                    BackupRestoreProcessState.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] failed
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState]
        #     Failed
        FAILED = BackupRestoreProcessState.new('FAILED')

        # @!attribute [rw] inprogress
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState]
        #     In progress
        INPROGRESS = BackupRestoreProcessState.new('INPROGRESS')

        # @!attribute [rw] none
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState]
        #     Not started
        NONE = BackupRestoreProcessState.new('NONE')

        # @!attribute [rw] succeeded
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState]
        #     Completed successfully
        SUCCEEDED = BackupRestoreProcessState.new('SUCCEEDED')

    end

### - (`Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState`) succeeded

Completed successfully

Returns:

- (`Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState`)

    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
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 528

    class BackupRestoreProcessState < 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.recovery.backup.job.backup_restore_process_state',
                    BackupRestoreProcessState)
            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 [BackupRestoreProcessState] 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
                    BackupRestoreProcessState.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] failed
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState]
        #     Failed
        FAILED = BackupRestoreProcessState.new('FAILED')

        # @!attribute [rw] inprogress
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState]
        #     In progress
        INPROGRESS = BackupRestoreProcessState.new('INPROGRESS')

        # @!attribute [rw] none
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState]
        #     Not started
        NONE = BackupRestoreProcessState.new('NONE')

        # @!attribute [rw] succeeded
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState]
        #     Completed successfully
        SUCCEEDED = BackupRestoreProcessState.new('SUCCEEDED')

    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

    534
    535
    536
    537
    538
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 534

    def binding_type
        @binding_type ||= VAPI::Bindings::EnumType.new(
            'com.vmware.appliance.recovery.backup.job.backup_restore_process_state',
            BackupRestoreProcessState)
    end

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

- (`BackupRestoreProcessState`) —

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

    545
    546
    547
    548
    549
    550
    551
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 545

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