Class List Method List File List

# Class: Com::Vmware::Content::Library::Item::Updatesession::File::AddSpec

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

## Overview

The ``Com::Vmware::Content::Library::Item::Updatesession::File::AddSpec`` class describes the properties of the file to be uploaded.

## Instance Attribute Summary (collapse)

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

  The checksum of the file.

- - (String) name

  The name of the file being uploaded.

- - (Fixnum?) size

  The file size, in bytes.

- - (Com::Vmware::Content::Library::Item::TransferEndpoint) source_endpoint

  Location from which the Content Library Service will fetch the file, rather than requiring a client to upload the file.

- - (Com::Vmware::Content::Library::Item::Updatesession::File::SourceType) source_type

  The source type ( ``NONE``, ``PUSH``, ``PULL`` ) from which the file content will be retrieved.

## 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)

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

  Constructs a new instance.

## Constructor Details

### - (`AddSpec`) 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)

    277
    278
    279
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/updatesession.rb', line 277

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

## Instance Attribute Details

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

The checksum of the file. If specified, the server will verify the checksum once the file is received. If there is a mismatch, the upload will fail. If not specified the server does not verify the checksum.

Returns:

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

    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/updatesession.rb', line 246

    class AddSpec < 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.updatesession.file.add_spec',
                    {
                        'name' => VAPI::Bindings::StringType.instance,
                        'source_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::Updatesession::File::SourceType'),
                        'source_endpoint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::TransferEndpoint')),
                        'size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'checksum_info' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::File::ChecksumInfo')),
                    },
                    AddSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :source_type,
                      :source_endpoint,
                      :size,
                      :checksum_info

        # 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 being uploaded.

Returns:

- (`String`)

    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/updatesession.rb', line 246

    class AddSpec < 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.updatesession.file.add_spec',
                    {
                        'name' => VAPI::Bindings::StringType.instance,
                        'source_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::Updatesession::File::SourceType'),
                        'source_endpoint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::TransferEndpoint')),
                        'size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'checksum_info' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::File::ChecksumInfo')),
                    },
                    AddSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :source_type,
                      :source_endpoint,
                      :size,
                      :checksum_info

        # 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. If specified the server will verify it received the correct size.

Returns:

- (`Fixnum`, `nil`)

    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/updatesession.rb', line 246

    class AddSpec < 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.updatesession.file.add_spec',
                    {
                        'name' => VAPI::Bindings::StringType.instance,
                        'source_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::Updatesession::File::SourceType'),
                        'source_endpoint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::TransferEndpoint')),
                        'size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'checksum_info' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::File::ChecksumInfo')),
                    },
                    AddSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :source_type,
                      :source_endpoint,
                      :size,
                      :checksum_info

        # 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`) source_endpoint

Location from which the Content Library Service will fetch the file, rather than requiring a client to upload the file. This field is optional and it is only relevant when the value of ``sourceType`` is :attr:`Com::Vmware::Content::Library::Item::Updatesession::File::SourceType.PULL` .

Returns:

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

    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/updatesession.rb', line 246

    class AddSpec < 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.updatesession.file.add_spec',
                    {
                        'name' => VAPI::Bindings::StringType.instance,
                        'source_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::Updatesession::File::SourceType'),
                        'source_endpoint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::TransferEndpoint')),
                        'size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'checksum_info' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::File::ChecksumInfo')),
                    },
                    AddSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :source_type,
                      :source_endpoint,
                      :size,
                      :checksum_info

        # 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::Updatesession::File::SourceType`) source_type

The source type ( ``NONE``, ``PUSH``, ``PULL`` ) from which the file content will be retrieved.

Returns:

- (`Com::Vmware::Content::Library::Item::Updatesession::File::SourceType`)

    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/updatesession.rb', line 246

    class AddSpec < 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.updatesession.file.add_spec',
                    {
                        'name' => VAPI::Bindings::StringType.instance,
                        'source_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::Updatesession::File::SourceType'),
                        'source_endpoint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::TransferEndpoint')),
                        'size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'checksum_info' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::File::ChecksumInfo')),
                    },
                    AddSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :source_type,
                      :source_endpoint,
                      :size,
                      :checksum_info

        # 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

    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/updatesession.rb', line 252

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.content.library.item.updatesession.file.add_spec',
            {
                'name' => VAPI::Bindings::StringType.instance,
                'source_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::Updatesession::File::SourceType'),
                'source_endpoint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::TransferEndpoint')),
                'size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                'checksum_info' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::File::ChecksumInfo')),
            },
            AddSpec,
            false,
            nil)
    end