Class: Com::Vmware::Appliance::Recovery::BackupService::ReturnStatus

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

Overview

``Com::Vmware::Appliance::Recovery::Backup::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::Backup::ReturnStatus) fail

Check failed

Returns:

  • (Com::Vmware::Appliance::Recovery::Backup::ReturnStatus) 


234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery.rb', line 234

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

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

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

end

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

Check passed

Returns:

  • (Com::Vmware::Appliance::Recovery::Backup::ReturnStatus) 


234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery.rb', line 234

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

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

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

end

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

Passed with warnings

Returns:

  • (Com::Vmware::Appliance::Recovery::Backup::ReturnStatus) 


234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery.rb', line 234

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

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

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



240
241
242
243
244
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery.rb', line 240

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



251
252
253
254
255
256
257
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery.rb', line 251

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