Class List Method List File List

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

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Content::Library::Item::Downloadsession::File::Info
  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::Info`` class defines the downloaded file.

## Instance Attribute Summary (collapse)

- - (Fixnum) bytes_transferred

  The number of bytes that have been transferred by the server so far for making this file prepared for download.

- - (Com::Vmware::Content::Library::Item::File::ChecksumInfo?) checksum_info

  The checksum information of the file.

- - (Com::Vmware::Content::Library::Item::TransferEndpoint?) download_endpoint

  Endpoint at which the file is available for download.

- - (Com::Vmware::Vapi::Std::LocalizableMessage?) error_message

  Error message for a failed preparation when the prepare status is :attr:`Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus.ERROR` .

- - (String) name

  The name of the file.

- - (Fixnum?) size

  The file size, in bytes.

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

  The preparation status ( ``UNPREPARED``, ``PREPARE_REQUESTED``, ``PREPARING``, ``PREPARED``, ``ERROR`` ) of the file.

## Class Method Summary (collapse)

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

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

## Instance Method Summary (collapse)

- - (Info) initialize(ruby_values = nil, struct_value = nil) constructor

  Constructs a new instance.

## Constructor Details

### - (`Info`) initialize(ruby_values = nil, struct_value = nil)

Constructs a new instance.

Parameters:

- ruby_values (`Hash`) (defaults to: `nil`) —

  a map of initial property values (optional)

- struct_value (`VAPI::Data::StructValue`) (defaults to: `nil`) —

  a raw StructValue from the wire (optional)

    220
    221
    222
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/downloadsession.rb', line 220

    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end

## Instance Attribute Details

### - (`Fixnum`) bytes_transferred

The number of bytes that have been transferred by the server so far for making this file prepared for download. This value may stay at zero till the client starts downloading the file.

Returns:

- (`Fixnum`)

    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/downloadsession.rb', line 185

    class Info < VAPI::Bindings::VapiStruct

        class << self
            # Holds (gets or creates) the binding type metadata for this structure type.
            # @scope class
            # @return [VAPI::Bindings::StructType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::StructType.new(
                    'com.vmware.content.library.item.downloadsession.file.info',
                    {
                        'name' => VAPI::Bindings::StringType.instance,
                        'size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'bytes_transferred' => VAPI::Bindings::IntegerType.instance,
                        'status' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus'),
                        'download_endpoint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::TransferEndpoint')),
                        'checksum_info' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::File::ChecksumInfo')),
                        'error_message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :size,
                      :bytes_transferred,
                      :status,
                      :download_endpoint,
                      :checksum_info,
                      :error_message

        # Constructs a new instance.
        # @param ruby_values [Hash] a map of initial property values (optional)
        # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
        def initialize(ruby_values=nil, struct_value=nil)
            super(self.class.binding_type, ruby_values, struct_value)
        end
    end

### - (`Com::Vmware::Content::Library::Item::File::ChecksumInfo`?) checksum_info

The checksum information of the file. When the download is complete, you can retrieve the checksum from the :func:`Com::Vmware::Content::Library::Item::Downloadsession::File.get` method to verify the checksum for the downloaded file. The checksum is always calculated for the downloaded file, but this field won’t be set until the download is complete.

Returns:

- (`Com::Vmware::Content::Library::Item::File::ChecksumInfo`, `nil`)

    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/downloadsession.rb', line 185

    class Info < VAPI::Bindings::VapiStruct

        class << self
            # Holds (gets or creates) the binding type metadata for this structure type.
            # @scope class
            # @return [VAPI::Bindings::StructType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::StructType.new(
                    'com.vmware.content.library.item.downloadsession.file.info',
                    {
                        'name' => VAPI::Bindings::StringType.instance,
                        'size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'bytes_transferred' => VAPI::Bindings::IntegerType.instance,
                        'status' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus'),
                        'download_endpoint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::TransferEndpoint')),
                        'checksum_info' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::File::ChecksumInfo')),
                        'error_message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :size,
                      :bytes_transferred,
                      :status,
                      :download_endpoint,
                      :checksum_info,
                      :error_message

        # Constructs a new instance.
        # @param ruby_values [Hash] a map of initial property values (optional)
        # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
        def initialize(ruby_values=nil, struct_value=nil)
            super(self.class.binding_type, ruby_values, struct_value)
        end
    end

### - (`Com::Vmware::Content::Library::Item::TransferEndpoint`?) download_endpoint

Endpoint at which the file is available for download. The value is valid only when the :attr:`Com::Vmware::Content::Library::Item::Downloadsession::File::Info.status` is :attr:`Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus.PREPARED` . This field won’t be set until the file status is :attr:`Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus.PREPARED` .

Returns:

- (`Com::Vmware::Content::Library::Item::TransferEndpoint`, `nil`)

    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/downloadsession.rb', line 185

    class Info < VAPI::Bindings::VapiStruct

        class << self
            # Holds (gets or creates) the binding type metadata for this structure type.
            # @scope class
            # @return [VAPI::Bindings::StructType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::StructType.new(
                    'com.vmware.content.library.item.downloadsession.file.info',
                    {
                        'name' => VAPI::Bindings::StringType.instance,
                        'size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'bytes_transferred' => VAPI::Bindings::IntegerType.instance,
                        'status' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus'),
                        'download_endpoint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::TransferEndpoint')),
                        'checksum_info' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::File::ChecksumInfo')),
                        'error_message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :size,
                      :bytes_transferred,
                      :status,
                      :download_endpoint,
                      :checksum_info,
                      :error_message

        # Constructs a new instance.
        # @param ruby_values [Hash] a map of initial property values (optional)
        # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
        def initialize(ruby_values=nil, struct_value=nil)
            super(self.class.binding_type, ruby_values, struct_value)
        end
    end

### - (`Com::Vmware::Vapi::Std::LocalizableMessage`?) error_message

Error message for a failed preparation when the prepare status is :attr:`Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus.ERROR` . This field won’t be set unless there was an error with the file transfer.

Returns:

- (`Com::Vmware::Vapi::Std::LocalizableMessage`, `nil`)

    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/downloadsession.rb', line 185

    class Info < VAPI::Bindings::VapiStruct

        class << self
            # Holds (gets or creates) the binding type metadata for this structure type.
            # @scope class
            # @return [VAPI::Bindings::StructType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::StructType.new(
                    'com.vmware.content.library.item.downloadsession.file.info',
                    {
                        'name' => VAPI::Bindings::StringType.instance,
                        'size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'bytes_transferred' => VAPI::Bindings::IntegerType.instance,
                        'status' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus'),
                        'download_endpoint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::TransferEndpoint')),
                        'checksum_info' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::File::ChecksumInfo')),
                        'error_message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :size,
                      :bytes_transferred,
                      :status,
                      :download_endpoint,
                      :checksum_info,
                      :error_message

        # Constructs a new instance.
        # @param ruby_values [Hash] a map of initial property values (optional)
        # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
        def initialize(ruby_values=nil, struct_value=nil)
            super(self.class.binding_type, ruby_values, struct_value)
        end
    end

### - (`String`) name

The name of the file.

Returns:

- (`String`)

    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/downloadsession.rb', line 185

    class Info < VAPI::Bindings::VapiStruct

        class << self
            # Holds (gets or creates) the binding type metadata for this structure type.
            # @scope class
            # @return [VAPI::Bindings::StructType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::StructType.new(
                    'com.vmware.content.library.item.downloadsession.file.info',
                    {
                        'name' => VAPI::Bindings::StringType.instance,
                        'size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'bytes_transferred' => VAPI::Bindings::IntegerType.instance,
                        'status' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus'),
                        'download_endpoint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::TransferEndpoint')),
                        'checksum_info' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::File::ChecksumInfo')),
                        'error_message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :size,
                      :bytes_transferred,
                      :status,
                      :download_endpoint,
                      :checksum_info,
                      :error_message

        # Constructs a new instance.
        # @param ruby_values [Hash] a map of initial property values (optional)
        # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
        def initialize(ruby_values=nil, struct_value=nil)
            super(self.class.binding_type, ruby_values, struct_value)
        end
    end

### - (`Fixnum`?) size

The file size, in bytes. This field may not be available immediately. It is guaranteed to be set when the client finishes downloading the file.

Returns:

- (`Fixnum`, `nil`)

    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/downloadsession.rb', line 185

    class Info < VAPI::Bindings::VapiStruct

        class << self
            # Holds (gets or creates) the binding type metadata for this structure type.
            # @scope class
            # @return [VAPI::Bindings::StructType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::StructType.new(
                    'com.vmware.content.library.item.downloadsession.file.info',
                    {
                        'name' => VAPI::Bindings::StringType.instance,
                        'size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'bytes_transferred' => VAPI::Bindings::IntegerType.instance,
                        'status' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus'),
                        'download_endpoint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::TransferEndpoint')),
                        'checksum_info' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::File::ChecksumInfo')),
                        'error_message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :size,
                      :bytes_transferred,
                      :status,
                      :download_endpoint,
                      :checksum_info,
                      :error_message

        # Constructs a new instance.
        # @param ruby_values [Hash] a map of initial property values (optional)
        # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
        def initialize(ruby_values=nil, struct_value=nil)
            super(self.class.binding_type, ruby_values, struct_value)
        end
    end

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

The preparation status ( ``UNPREPARED``, ``PREPARE_REQUESTED``, ``PREPARING``, ``PREPARED``, ``ERROR`` ) of the file.

Returns:

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

    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/downloadsession.rb', line 185

    class Info < VAPI::Bindings::VapiStruct

        class << self
            # Holds (gets or creates) the binding type metadata for this structure type.
            # @scope class
            # @return [VAPI::Bindings::StructType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::StructType.new(
                    'com.vmware.content.library.item.downloadsession.file.info',
                    {
                        'name' => VAPI::Bindings::StringType.instance,
                        'size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'bytes_transferred' => VAPI::Bindings::IntegerType.instance,
                        'status' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus'),
                        'download_endpoint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::TransferEndpoint')),
                        'checksum_info' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::File::ChecksumInfo')),
                        'error_message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :size,
                      :bytes_transferred,
                      :status,
                      :download_endpoint,
                      :checksum_info,
                      :error_message

        # Constructs a new instance.
        # @param ruby_values [Hash] a map of initial property values (optional)
        # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
        def initialize(ruby_values=nil, struct_value=nil)
            super(self.class.binding_type, ruby_values, struct_value)
        end
    end

## Class Method Details

### + (`VAPI::Bindings::StructType`) binding_type

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

Returns:

- (`VAPI::Bindings::StructType`) —

  the binding type

    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/downloadsession.rb', line 191

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.content.library.item.downloadsession.file.info',
            {
                'name' => VAPI::Bindings::StringType.instance,
                'size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                'bytes_transferred' => VAPI::Bindings::IntegerType.instance,
                'status' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::Downloadsession::File::PrepareStatus'),
                'download_endpoint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::TransferEndpoint')),
                'checksum_info' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::File::ChecksumInfo')),
                'error_message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
            },
            Info,
            false,
            nil)
    end