Class List Method List File List

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

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

## Overview

``Com::Vmware::Appliance::Recovery::Restore::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::Restore::Job::BackupRestoreProcessState) failed

  Failed.

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

  In progress.

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

  Not started.

- - (Com::Vmware::Appliance::Recovery::Restore::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::Restore::Job::BackupRestoreProcessState`) failed

Failed

Returns:

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

    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/restore.rb', line 464

    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.restore.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::Restore::Job::BackupRestoreProcessState]
        #     Failed
        FAILED = BackupRestoreProcessState.new('FAILED')

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

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

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

    end

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

In progress

Returns:

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

    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/restore.rb', line 464

    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.restore.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::Restore::Job::BackupRestoreProcessState]
        #     Failed
        FAILED = BackupRestoreProcessState.new('FAILED')

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

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

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

    end

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

Not started

Returns:

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

    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/restore.rb', line 464

    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.restore.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::Restore::Job::BackupRestoreProcessState]
        #     Failed
        FAILED = BackupRestoreProcessState.new('FAILED')

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

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

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

    end

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

Completed successfully

Returns:

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

    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/restore.rb', line 464

    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.restore.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::Restore::Job::BackupRestoreProcessState]
        #     Failed
        FAILED = BackupRestoreProcessState.new('FAILED')

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

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

        # @!attribute [rw] succeeded
        #     @return [Com::Vmware::Appliance::Recovery::Restore::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

    470
    471
    472
    473
    474
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/restore.rb', line 470

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

    481
    482
    483
    484
    485
    486
    487
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/restore.rb', line 481

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