Class List Method List File List

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

Inherits:
  VAPI::Bindings::VapiEnum
  - Object
  - VAPI::Bindings::VapiEnum
  - Com::Vmware::Appliance::Recovery::Backup::Job::ReturnStatus
  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::ReturnStatus`` enumerated type Defines the state of precheck

## Constant Summary

FAIL =

      ReturnStatus.new('FAIL')

WARNING =

      ReturnStatus.new('WARNING')

OK =

      ReturnStatus.new('OK')

## Instance Attribute Summary (collapse)

- - (Com::Vmware::Appliance::Recovery::Backup::Job::ReturnStatus) fail

  Check failed.

- - (Com::Vmware::Appliance::Recovery::Backup::Job::ReturnStatus) ok

  Check passed.

- - (Com::Vmware::Appliance::Recovery::Backup::Job::ReturnStatus) warning

  Passed with warnings.

## Class Method Summary (collapse)

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

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

- + (ReturnStatus) 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::ReturnStatus`) fail

Check failed

Returns:

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

    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 379

    class ReturnStatus < 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.return_status',
                    ReturnStatus)
            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 [ReturnStatus] 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
                    ReturnStatus.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] fail
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::ReturnStatus]
        #     Check failed
        FAIL = ReturnStatus.new('FAIL')

        # @!attribute [rw] warning
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::ReturnStatus]
        #     Passed with warnings
        WARNING = ReturnStatus.new('WARNING')

        # @!attribute [rw] ok
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::ReturnStatus]
        #     Check passed
        OK = ReturnStatus.new('OK')

    end

### - (`Com::Vmware::Appliance::Recovery::Backup::Job::ReturnStatus`) ok

Check passed

Returns:

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

    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 379

    class ReturnStatus < 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.return_status',
                    ReturnStatus)
            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 [ReturnStatus] 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
                    ReturnStatus.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] fail
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::ReturnStatus]
        #     Check failed
        FAIL = ReturnStatus.new('FAIL')

        # @!attribute [rw] warning
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::ReturnStatus]
        #     Passed with warnings
        WARNING = ReturnStatus.new('WARNING')

        # @!attribute [rw] ok
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::ReturnStatus]
        #     Check passed
        OK = ReturnStatus.new('OK')

    end

### - (`Com::Vmware::Appliance::Recovery::Backup::Job::ReturnStatus`) warning

Passed with warnings

Returns:

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

    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 379

    class ReturnStatus < 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.return_status',
                    ReturnStatus)
            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 [ReturnStatus] 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
                    ReturnStatus.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] fail
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::ReturnStatus]
        #     Check failed
        FAIL = ReturnStatus.new('FAIL')

        # @!attribute [rw] warning
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::ReturnStatus]
        #     Passed with warnings
        WARNING = ReturnStatus.new('WARNING')

        # @!attribute [rw] ok
        #     @return [Com::Vmware::Appliance::Recovery::Backup::Job::ReturnStatus]
        #     Check passed
        OK = ReturnStatus.new('OK')

    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

    385
    386
    387
    388
    389
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 385

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

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

- (`ReturnStatus`) —

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

    396
    397
    398
    399
    400
    401
    402
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 396

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