Class List Method List File List

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

Inherits:
  VAPI::Bindings::VapiEnum
  - Object
  - VAPI::Bindings::VapiEnum
  - Com::Vmware::Appliance::Recovery::Backup::Job::LocationType
  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::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::Job::LocationType) ftp

  Destination is FTP server.

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

  Destination is FTPS server.

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

  Destination is HTTP server.

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

  Destination is HTTPS server.

- - (Com::Vmware::Appliance::Recovery::Backup::Job::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::Job::LocationType`) ftp

Destination is FTP server

Returns:

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

    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 450

    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.job.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::Job::LocationType]
        #     Destination is FTPS server
        FTPS = LocationType.new('FTPS')

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

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

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

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

    end

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

Destination is FTPS server

Returns:

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

    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 450

    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.job.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::Job::LocationType]
        #     Destination is FTPS server
        FTPS = LocationType.new('FTPS')

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

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

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

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

    end

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

Destination is HTTP server

Returns:

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

    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 450

    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.job.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::Job::LocationType]
        #     Destination is FTPS server
        FTPS = LocationType.new('FTPS')

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

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

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

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

    end

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

Destination is HTTPS server

Returns:

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

    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 450

    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.job.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::Job::LocationType]
        #     Destination is FTPS server
        FTPS = LocationType.new('FTPS')

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

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

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

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

    end

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

Destination is SSH server

Returns:

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

    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 450

    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.job.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::Job::LocationType]
        #     Destination is FTPS server
        FTPS = LocationType.new('FTPS')

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

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

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

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

    456
    457
    458
    459
    460
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 456

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

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

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