Class List Method List File List

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

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Content::Library::Item::File::Info
  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::File::Info`` class provides information about a file in Content Library Service storage.

     A file is an actual stored object for a library item. An item will have zero files initially, but one or more can be uploaded to the item.

## Instance Attribute Summary (collapse)

- - (Boolean) cached

  Indicates whether the file is on disk or not.

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

  A checksum for validating the content of the file.

- - (String) name

  The name of the file.

- - (Fixnum) size

  The file size, in bytes.

- - (String) version

  The version of this file; incremented when a new copy of the file is uploaded.

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

    462
    463
    464
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 462

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

## Instance Attribute Details

### - (`Boolean`) cached

Indicates whether the file is on disk or not.

Returns:

- (`Boolean`)

    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 431

    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.file.info',
                    {
                        'checksum_info' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::File::ChecksumInfo')),
                        'name' => VAPI::Bindings::StringType.instance,
                        'size' => VAPI::Bindings::IntegerType.instance,
                        'cached' => VAPI::Bindings::BooleanType.instance,
                        'version' => VAPI::Bindings::StringType.instance,
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :checksum_info,
                      :name,
                      :size,
                      :cached,
                      :version

        # 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

A checksum for validating the content of the file.

     This value can be used to verify that a transfer was completed without errors.

A checksum cannot always be calculated, and the value will be nil if the file does not have content.

Returns:

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

    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 431

    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.file.info',
                    {
                        'checksum_info' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::File::ChecksumInfo')),
                        'name' => VAPI::Bindings::StringType.instance,
                        'size' => VAPI::Bindings::IntegerType.instance,
                        'cached' => VAPI::Bindings::BooleanType.instance,
                        'version' => VAPI::Bindings::StringType.instance,
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :checksum_info,
                      :name,
                      :size,
                      :cached,
                      :version

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

     This value will be unique within the library item for each file. It cannot be an empty string.

Returns:

- (`String`)

    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 431

    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.file.info',
                    {
                        'checksum_info' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::File::ChecksumInfo')),
                        'name' => VAPI::Bindings::StringType.instance,
                        'size' => VAPI::Bindings::IntegerType.instance,
                        'cached' => VAPI::Bindings::BooleanType.instance,
                        'version' => VAPI::Bindings::StringType.instance,
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :checksum_info,
                      :name,
                      :size,
                      :cached,
                      :version

        # 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. The file size is the storage used and not the uploaded or provisioned size. For example, when uploading a disk to a datastore, the amount of storage that the disk consumes may be different from the disk file size. When the file is not cached, the size is 0.

Returns:

- (`Fixnum`)

    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 431

    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.file.info',
                    {
                        'checksum_info' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::File::ChecksumInfo')),
                        'name' => VAPI::Bindings::StringType.instance,
                        'size' => VAPI::Bindings::IntegerType.instance,
                        'cached' => VAPI::Bindings::BooleanType.instance,
                        'version' => VAPI::Bindings::StringType.instance,
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :checksum_info,
                      :name,
                      :size,
                      :cached,
                      :version

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

The version of this file; incremented when a new copy of the file is uploaded.

Returns:

- (`String`)

    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 431

    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.file.info',
                    {
                        'checksum_info' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::File::ChecksumInfo')),
                        'name' => VAPI::Bindings::StringType.instance,
                        'size' => VAPI::Bindings::IntegerType.instance,
                        'cached' => VAPI::Bindings::BooleanType.instance,
                        'version' => VAPI::Bindings::StringType.instance,
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :checksum_info,
                      :name,
                      :size,
                      :cached,
                      :version

        # 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

    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 437

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.content.library.item.file.info',
            {
                'checksum_info' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::File::ChecksumInfo')),
                'name' => VAPI::Bindings::StringType.instance,
                'size' => VAPI::Bindings::IntegerType.instance,
                'cached' => VAPI::Bindings::BooleanType.instance,
                'version' => VAPI::Bindings::StringType.instance,
            },
            Info,
            false,
            nil)
    end