Class List Method List File List

# Class: Com::Vmware::Content::Library::Item::TransferStatus

Inherits:
  VAPI::Bindings::VapiEnum
  - Object
  - VAPI::Bindings::VapiEnum
  - Com::Vmware::Content::Library::Item::TransferStatus
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb

## Overview

The ``Com::Vmware::Content::Library::Item::TransferStatus`` enumerated type defines the transfer state of a file.

## Constant Summary

WAITING_FOR_TRANSFER =

      TransferStatus.new('WAITING_FOR_TRANSFER')

TRANSFERRING =

      TransferStatus.new('TRANSFERRING')

READY =

      TransferStatus.new('READY')

VALIDATING =

      TransferStatus.new('VALIDATING')

ERROR =

      TransferStatus.new('ERROR')

## Instance Attribute Summary (collapse)

- - (Com::Vmware::Content::Library::Item::TransferStatus) error

  Indicates that there was an error transferring or validating the file.

- - (Com::Vmware::Content::Library::Item::TransferStatus) ready

  Indicates that the file has been fully transferred and is ready to be used.

- - (Com::Vmware::Content::Library::Item::TransferStatus) transferring

  Indicates that data is being transferred to the file.

- - (Com::Vmware::Content::Library::Item::TransferStatus) validating

  Indicates that the file is being validated (checksum, type adapters).

- - (Com::Vmware::Content::Library::Item::TransferStatus) waiting_for_transfer

  Indicates that a file has been defined for a library item and its content needs to be uploaded.

## Class Method Summary (collapse)

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

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

- + (TransferStatus) from_string(value)

  Converts from a string value (perhaps off the wire) to an instance of this enum type.

## Instance Attribute Details

### - (`Com::Vmware::Content::Library::Item::TransferStatus`) error

Indicates that there was an error transferring or validating the file.

Returns:

- (`Com::Vmware::Content::Library::Item::TransferStatus`)

    1334
    1335
    1336
    1337
    1338
    1339
    1340
    1341
    1342
    1343
    1344
    1345
    1346
    1347
    1348
    1349
    1350
    1351
    1352
    1353
    1354
    1355
    1356
    1357
    1358
    1359
    1360
    1361
    1362
    1363
    1364
    1365
    1366
    1367
    1368
    1369
    1370
    1371
    1372
    1373
    1374
    1375
    1376
    1377
    1378
    1379
    1380
    1381
    1382
    1383
    1384
    1385
    1386
    1387
    1388
    1389
    1390
    1391
    1392
    1393
    1394
    1395
    1396
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1334

    class TransferStatus < 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.content.library.item.transfer_status',
                    TransferStatus)
            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 [TransferStatus] 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
                    TransferStatus.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] waiting_for_transfer
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that a file has been defined for a library item and its content needs to be uploaded.
        WAITING_FOR_TRANSFER = TransferStatus.new('WAITING_FOR_TRANSFER')

        # @!attribute [rw] transferring
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that data is being transferred to the file.
        TRANSFERRING = TransferStatus.new('TRANSFERRING')

        # @!attribute [rw] ready
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that the file has been fully transferred and is ready to be used.
        READY = TransferStatus.new('READY')

        # @!attribute [rw] validating
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that the file is being validated (checksum, type adapters).
        VALIDATING = TransferStatus.new('VALIDATING')

        # @!attribute [rw] error
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that there was an error transferring or validating the file.
        ERROR = TransferStatus.new('ERROR')

    end

### - (`Com::Vmware::Content::Library::Item::TransferStatus`) ready

Indicates that the file has been fully transferred and is ready to be used.

Returns:

- (`Com::Vmware::Content::Library::Item::TransferStatus`)

    1334
    1335
    1336
    1337
    1338
    1339
    1340
    1341
    1342
    1343
    1344
    1345
    1346
    1347
    1348
    1349
    1350
    1351
    1352
    1353
    1354
    1355
    1356
    1357
    1358
    1359
    1360
    1361
    1362
    1363
    1364
    1365
    1366
    1367
    1368
    1369
    1370
    1371
    1372
    1373
    1374
    1375
    1376
    1377
    1378
    1379
    1380
    1381
    1382
    1383
    1384
    1385
    1386
    1387
    1388
    1389
    1390
    1391
    1392
    1393
    1394
    1395
    1396
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1334

    class TransferStatus < 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.content.library.item.transfer_status',
                    TransferStatus)
            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 [TransferStatus] 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
                    TransferStatus.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] waiting_for_transfer
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that a file has been defined for a library item and its content needs to be uploaded.
        WAITING_FOR_TRANSFER = TransferStatus.new('WAITING_FOR_TRANSFER')

        # @!attribute [rw] transferring
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that data is being transferred to the file.
        TRANSFERRING = TransferStatus.new('TRANSFERRING')

        # @!attribute [rw] ready
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that the file has been fully transferred and is ready to be used.
        READY = TransferStatus.new('READY')

        # @!attribute [rw] validating
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that the file is being validated (checksum, type adapters).
        VALIDATING = TransferStatus.new('VALIDATING')

        # @!attribute [rw] error
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that there was an error transferring or validating the file.
        ERROR = TransferStatus.new('ERROR')

    end

### - (`Com::Vmware::Content::Library::Item::TransferStatus`) transferring

Indicates that data is being transferred to the file.

Returns:

- (`Com::Vmware::Content::Library::Item::TransferStatus`)

    1334
    1335
    1336
    1337
    1338
    1339
    1340
    1341
    1342
    1343
    1344
    1345
    1346
    1347
    1348
    1349
    1350
    1351
    1352
    1353
    1354
    1355
    1356
    1357
    1358
    1359
    1360
    1361
    1362
    1363
    1364
    1365
    1366
    1367
    1368
    1369
    1370
    1371
    1372
    1373
    1374
    1375
    1376
    1377
    1378
    1379
    1380
    1381
    1382
    1383
    1384
    1385
    1386
    1387
    1388
    1389
    1390
    1391
    1392
    1393
    1394
    1395
    1396
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1334

    class TransferStatus < 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.content.library.item.transfer_status',
                    TransferStatus)
            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 [TransferStatus] 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
                    TransferStatus.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] waiting_for_transfer
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that a file has been defined for a library item and its content needs to be uploaded.
        WAITING_FOR_TRANSFER = TransferStatus.new('WAITING_FOR_TRANSFER')

        # @!attribute [rw] transferring
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that data is being transferred to the file.
        TRANSFERRING = TransferStatus.new('TRANSFERRING')

        # @!attribute [rw] ready
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that the file has been fully transferred and is ready to be used.
        READY = TransferStatus.new('READY')

        # @!attribute [rw] validating
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that the file is being validated (checksum, type adapters).
        VALIDATING = TransferStatus.new('VALIDATING')

        # @!attribute [rw] error
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that there was an error transferring or validating the file.
        ERROR = TransferStatus.new('ERROR')

    end

### - (`Com::Vmware::Content::Library::Item::TransferStatus`) validating

Indicates that the file is being validated (checksum, type adapters).

Returns:

- (`Com::Vmware::Content::Library::Item::TransferStatus`)

    1334
    1335
    1336
    1337
    1338
    1339
    1340
    1341
    1342
    1343
    1344
    1345
    1346
    1347
    1348
    1349
    1350
    1351
    1352
    1353
    1354
    1355
    1356
    1357
    1358
    1359
    1360
    1361
    1362
    1363
    1364
    1365
    1366
    1367
    1368
    1369
    1370
    1371
    1372
    1373
    1374
    1375
    1376
    1377
    1378
    1379
    1380
    1381
    1382
    1383
    1384
    1385
    1386
    1387
    1388
    1389
    1390
    1391
    1392
    1393
    1394
    1395
    1396
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1334

    class TransferStatus < 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.content.library.item.transfer_status',
                    TransferStatus)
            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 [TransferStatus] 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
                    TransferStatus.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] waiting_for_transfer
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that a file has been defined for a library item and its content needs to be uploaded.
        WAITING_FOR_TRANSFER = TransferStatus.new('WAITING_FOR_TRANSFER')

        # @!attribute [rw] transferring
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that data is being transferred to the file.
        TRANSFERRING = TransferStatus.new('TRANSFERRING')

        # @!attribute [rw] ready
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that the file has been fully transferred and is ready to be used.
        READY = TransferStatus.new('READY')

        # @!attribute [rw] validating
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that the file is being validated (checksum, type adapters).
        VALIDATING = TransferStatus.new('VALIDATING')

        # @!attribute [rw] error
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that there was an error transferring or validating the file.
        ERROR = TransferStatus.new('ERROR')

    end

### - (`Com::Vmware::Content::Library::Item::TransferStatus`) waiting_for_transfer

Indicates that a file has been defined for a library item and its content needs to be uploaded.

Returns:

- (`Com::Vmware::Content::Library::Item::TransferStatus`)

    1334
    1335
    1336
    1337
    1338
    1339
    1340
    1341
    1342
    1343
    1344
    1345
    1346
    1347
    1348
    1349
    1350
    1351
    1352
    1353
    1354
    1355
    1356
    1357
    1358
    1359
    1360
    1361
    1362
    1363
    1364
    1365
    1366
    1367
    1368
    1369
    1370
    1371
    1372
    1373
    1374
    1375
    1376
    1377
    1378
    1379
    1380
    1381
    1382
    1383
    1384
    1385
    1386
    1387
    1388
    1389
    1390
    1391
    1392
    1393
    1394
    1395
    1396
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1334

    class TransferStatus < 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.content.library.item.transfer_status',
                    TransferStatus)
            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 [TransferStatus] 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
                    TransferStatus.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] waiting_for_transfer
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that a file has been defined for a library item and its content needs to be uploaded.
        WAITING_FOR_TRANSFER = TransferStatus.new('WAITING_FOR_TRANSFER')

        # @!attribute [rw] transferring
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that data is being transferred to the file.
        TRANSFERRING = TransferStatus.new('TRANSFERRING')

        # @!attribute [rw] ready
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that the file has been fully transferred and is ready to be used.
        READY = TransferStatus.new('READY')

        # @!attribute [rw] validating
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that the file is being validated (checksum, type adapters).
        VALIDATING = TransferStatus.new('VALIDATING')

        # @!attribute [rw] error
        #     @return [Com::Vmware::Content::Library::Item::TransferStatus]
        #     Indicates that there was an error transferring or validating the file.
        ERROR = TransferStatus.new('ERROR')

    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

    1340
    1341
    1342
    1343
    1344
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1340

    def binding_type
        @binding_type ||= VAPI::Bindings::EnumType.new(
            'com.vmware.content.library.item.transfer_status',
            TransferStatus)
    end

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

- (`TransferStatus`) —

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

    1351
    1352
    1353
    1354
    1355
    1356
    1357
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1351

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