Class List Method List File List

# Class: Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus

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

## Overview

The ``Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus`` enumerated type defines the state of the file in preparation for download.

## Constant Summary

UNPREPARED =

      PrepareStatus.new('UNPREPARED')

PREPARE_REQUESTED =

      PrepareStatus.new('PREPARE_REQUESTED')

PREPARING =

      PrepareStatus.new('PREPARING')

PREPARED =

      PrepareStatus.new('PREPARED')

ERROR =

      PrepareStatus.new('ERROR')

## Instance Attribute Summary (collapse)

- - (Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus) error

  Prepare failed.

- - (Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus) prepare_requested

  A prepare has been requested, however the server hasn’t started the preparation yet.

- - (Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus) prepared

  Prepare succeeded.

- - (Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus) preparing

  A prepare has been requested and the file is in the process of being prepared.

- - (Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus) unprepared

  The file hasn’t been requested for preparation.

## Class Method Summary (collapse)

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

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

- + (PrepareStatus) 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::Downloadsession::File::PrepareStatus`) error

Prepare failed.

Returns:

- (`Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus`)

    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
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/downloadsession.rb', line 243

    class PrepareStatus < 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.downloadsession.file.prepare_status',
                    PrepareStatus)
            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 [PrepareStatus] 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
                    PrepareStatus.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] unprepared
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     The file hasn't been requested for preparation.
        UNPREPARED = PrepareStatus.new('UNPREPARED')

        # @!attribute [rw] prepare_requested
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     A prepare has been requested, however the server hasn't started the preparation yet.
        PREPARE_REQUESTED = PrepareStatus.new('PREPARE_REQUESTED')

        # @!attribute [rw] preparing
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     A prepare has been requested and the file is in the process of being prepared.
        PREPARING = PrepareStatus.new('PREPARING')

        # @!attribute [rw] prepared
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     Prepare succeeded. The file is ready for download.
        PREPARED = PrepareStatus.new('PREPARED')

        # @!attribute [rw] error
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     Prepare failed.
        ERROR = PrepareStatus.new('ERROR')

    end

### - (`Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus`) prepare_requested

A prepare has been requested, however the server hasn’t started the preparation yet.

Returns:

- (`Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus`)

    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
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/downloadsession.rb', line 243

    class PrepareStatus < 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.downloadsession.file.prepare_status',
                    PrepareStatus)
            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 [PrepareStatus] 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
                    PrepareStatus.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] unprepared
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     The file hasn't been requested for preparation.
        UNPREPARED = PrepareStatus.new('UNPREPARED')

        # @!attribute [rw] prepare_requested
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     A prepare has been requested, however the server hasn't started the preparation yet.
        PREPARE_REQUESTED = PrepareStatus.new('PREPARE_REQUESTED')

        # @!attribute [rw] preparing
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     A prepare has been requested and the file is in the process of being prepared.
        PREPARING = PrepareStatus.new('PREPARING')

        # @!attribute [rw] prepared
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     Prepare succeeded. The file is ready for download.
        PREPARED = PrepareStatus.new('PREPARED')

        # @!attribute [rw] error
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     Prepare failed.
        ERROR = PrepareStatus.new('ERROR')

    end

### - (`Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus`) prepared

Prepare succeeded. The file is ready for download.

Returns:

- (`Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus`)

    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
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/downloadsession.rb', line 243

    class PrepareStatus < 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.downloadsession.file.prepare_status',
                    PrepareStatus)
            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 [PrepareStatus] 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
                    PrepareStatus.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] unprepared
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     The file hasn't been requested for preparation.
        UNPREPARED = PrepareStatus.new('UNPREPARED')

        # @!attribute [rw] prepare_requested
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     A prepare has been requested, however the server hasn't started the preparation yet.
        PREPARE_REQUESTED = PrepareStatus.new('PREPARE_REQUESTED')

        # @!attribute [rw] preparing
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     A prepare has been requested and the file is in the process of being prepared.
        PREPARING = PrepareStatus.new('PREPARING')

        # @!attribute [rw] prepared
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     Prepare succeeded. The file is ready for download.
        PREPARED = PrepareStatus.new('PREPARED')

        # @!attribute [rw] error
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     Prepare failed.
        ERROR = PrepareStatus.new('ERROR')

    end

### - (`Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus`) preparing

A prepare has been requested and the file is in the process of being prepared.

Returns:

- (`Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus`)

    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
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/downloadsession.rb', line 243

    class PrepareStatus < 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.downloadsession.file.prepare_status',
                    PrepareStatus)
            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 [PrepareStatus] 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
                    PrepareStatus.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] unprepared
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     The file hasn't been requested for preparation.
        UNPREPARED = PrepareStatus.new('UNPREPARED')

        # @!attribute [rw] prepare_requested
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     A prepare has been requested, however the server hasn't started the preparation yet.
        PREPARE_REQUESTED = PrepareStatus.new('PREPARE_REQUESTED')

        # @!attribute [rw] preparing
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     A prepare has been requested and the file is in the process of being prepared.
        PREPARING = PrepareStatus.new('PREPARING')

        # @!attribute [rw] prepared
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     Prepare succeeded. The file is ready for download.
        PREPARED = PrepareStatus.new('PREPARED')

        # @!attribute [rw] error
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     Prepare failed.
        ERROR = PrepareStatus.new('ERROR')

    end

### - (`Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus`) unprepared

The file hasn’t been requested for preparation.

Returns:

- (`Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus`)

    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
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/downloadsession.rb', line 243

    class PrepareStatus < 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.downloadsession.file.prepare_status',
                    PrepareStatus)
            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 [PrepareStatus] 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
                    PrepareStatus.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] unprepared
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     The file hasn't been requested for preparation.
        UNPREPARED = PrepareStatus.new('UNPREPARED')

        # @!attribute [rw] prepare_requested
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     A prepare has been requested, however the server hasn't started the preparation yet.
        PREPARE_REQUESTED = PrepareStatus.new('PREPARE_REQUESTED')

        # @!attribute [rw] preparing
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     A prepare has been requested and the file is in the process of being prepared.
        PREPARING = PrepareStatus.new('PREPARING')

        # @!attribute [rw] prepared
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     Prepare succeeded. The file is ready for download.
        PREPARED = PrepareStatus.new('PREPARED')

        # @!attribute [rw] error
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus]
        #     Prepare failed.
        ERROR = PrepareStatus.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

    249
    250
    251
    252
    253
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/downloadsession.rb', line 249

    def binding_type
        @binding_type ||= VAPI::Bindings::EnumType.new(
            'com.vmware.content.library.item.downloadsession.file.prepare_status',
            PrepareStatus)
    end

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

- (`PrepareStatus`) —

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

    260
    261
    262
    263
    264
    265
    266
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/downloadsession.rb', line 260

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