Class: Com::Vmware::Appliance::Recovery::Restore::Job::ReturnStatus

Inherits:
VAPI::Bindings::VapiEnum
  • Object
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::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)

Class Method Summary (collapse)

Instance Attribute Details

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

Check failed

Returns:



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/restore.rb', line 315

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.restore.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::Restore::Job::ReturnStatus]
    #     Check failed
    FAIL = ReturnStatus.new('FAIL')

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

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

end

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

Check passed

Returns:



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/restore.rb', line 315

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.restore.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::Restore::Job::ReturnStatus]
    #     Check failed
    FAIL = ReturnStatus.new('FAIL')

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

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

end

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

Passed with warnings

Returns:



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/restore.rb', line 315

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.restore.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::Restore::Job::ReturnStatus]
    #     Check failed
    FAIL = ReturnStatus.new('FAIL')

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

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



321
322
323
324
325
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/restore.rb', line 321

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



332
333
334
335
336
337
338
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/restore.rb', line 332

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