Class List Method List File List

# Class: Com::Vmware::Appliance::Recovery::BackupService::LocationType

Inherits:
  VAPI::Bindings::VapiEnum
  - Object
  - VAPI::Bindings::VapiEnum
  - Com::Vmware::Appliance::Recovery::BackupService::LocationType
  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::LocationType`` enumerated type Defines type of all locations for backup/restore

## Constant Summary

FTPS =

      LocationType.new('FTPS')

HTTP =

      LocationType.new('HTTP')

SCP =

      LocationType.new('SCP')

HTTPS =

      LocationType.new('HTTPS')

FTP =

      LocationType.new('FTP')

## Instance Attribute Summary (collapse)

- - (Com::Vmware::Appliance::Recovery::Backup::LocationType) ftp

  Destination is FTP server.

- - (Com::Vmware::Appliance::Recovery::Backup::LocationType) ftps

  Destination is FTPS server.

- - (Com::Vmware::Appliance::Recovery::Backup::LocationType) http

  Destination is HTTP server.

- - (Com::Vmware::Appliance::Recovery::Backup::LocationType) https

  Destination is HTTPS server.

- - (Com::Vmware::Appliance::Recovery::Backup::LocationType) scp

  Destination is SSH server.

## Class Method Summary (collapse)

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

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

- + (LocationType) 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::LocationType`) ftp

Destination is FTP server

Returns:

- (`Com::Vmware::Appliance::Recovery::Backup::LocationType`)

    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    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.rb', line 305

    class LocationType < 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.location_type',
                    LocationType)
            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 [LocationType] 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
                    LocationType.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] ftps
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is FTPS server
        FTPS = LocationType.new('FTPS')

        # @!attribute [rw] http
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is HTTP server
        HTTP = LocationType.new('HTTP')

        # @!attribute [rw] scp
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is SSH server
        SCP = LocationType.new('SCP')

        # @!attribute [rw] https
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is HTTPS server
        HTTPS = LocationType.new('HTTPS')

        # @!attribute [rw] ftp
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is FTP server
        FTP = LocationType.new('FTP')

    end

### - (`Com::Vmware::Appliance::Recovery::Backup::LocationType`) ftps

Destination is FTPS server

Returns:

- (`Com::Vmware::Appliance::Recovery::Backup::LocationType`)

    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    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.rb', line 305

    class LocationType < 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.location_type',
                    LocationType)
            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 [LocationType] 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
                    LocationType.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] ftps
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is FTPS server
        FTPS = LocationType.new('FTPS')

        # @!attribute [rw] http
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is HTTP server
        HTTP = LocationType.new('HTTP')

        # @!attribute [rw] scp
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is SSH server
        SCP = LocationType.new('SCP')

        # @!attribute [rw] https
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is HTTPS server
        HTTPS = LocationType.new('HTTPS')

        # @!attribute [rw] ftp
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is FTP server
        FTP = LocationType.new('FTP')

    end

### - (`Com::Vmware::Appliance::Recovery::Backup::LocationType`) http

Destination is HTTP server

Returns:

- (`Com::Vmware::Appliance::Recovery::Backup::LocationType`)

    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    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.rb', line 305

    class LocationType < 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.location_type',
                    LocationType)
            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 [LocationType] 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
                    LocationType.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] ftps
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is FTPS server
        FTPS = LocationType.new('FTPS')

        # @!attribute [rw] http
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is HTTP server
        HTTP = LocationType.new('HTTP')

        # @!attribute [rw] scp
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is SSH server
        SCP = LocationType.new('SCP')

        # @!attribute [rw] https
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is HTTPS server
        HTTPS = LocationType.new('HTTPS')

        # @!attribute [rw] ftp
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is FTP server
        FTP = LocationType.new('FTP')

    end

### - (`Com::Vmware::Appliance::Recovery::Backup::LocationType`) https

Destination is HTTPS server

Returns:

- (`Com::Vmware::Appliance::Recovery::Backup::LocationType`)

    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    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.rb', line 305

    class LocationType < 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.location_type',
                    LocationType)
            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 [LocationType] 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
                    LocationType.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] ftps
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is FTPS server
        FTPS = LocationType.new('FTPS')

        # @!attribute [rw] http
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is HTTP server
        HTTP = LocationType.new('HTTP')

        # @!attribute [rw] scp
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is SSH server
        SCP = LocationType.new('SCP')

        # @!attribute [rw] https
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is HTTPS server
        HTTPS = LocationType.new('HTTPS')

        # @!attribute [rw] ftp
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is FTP server
        FTP = LocationType.new('FTP')

    end

### - (`Com::Vmware::Appliance::Recovery::Backup::LocationType`) scp

Destination is SSH server

Returns:

- (`Com::Vmware::Appliance::Recovery::Backup::LocationType`)

    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    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.rb', line 305

    class LocationType < 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.location_type',
                    LocationType)
            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 [LocationType] 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
                    LocationType.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] ftps
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is FTPS server
        FTPS = LocationType.new('FTPS')

        # @!attribute [rw] http
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is HTTP server
        HTTP = LocationType.new('HTTP')

        # @!attribute [rw] scp
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is SSH server
        SCP = LocationType.new('SCP')

        # @!attribute [rw] https
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is HTTPS server
        HTTPS = LocationType.new('HTTPS')

        # @!attribute [rw] ftp
        #     @return [Com::Vmware::Appliance::Recovery::Backup::LocationType]
        #     Destination is FTP server
        FTP = LocationType.new('FTP')

    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

    311
    312
    313
    314
    315
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery.rb', line 311

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

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

- (`LocationType`) —

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

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

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