Class: Com::Vmware::Vcenter::Ovf::SizeParams

Inherits:
VAPI::Bindings::VapiStruct
  • Object
show all
Defined in:
/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb

Overview

The ``Com::Vmware::Vcenter::Ovf::SizeParams`` class contains estimates of the download and deployment sizes. 


 This information is based on the file references and the ovf:DiskSection in the OVF descriptor.  

 See   :func:`Com::Vmware::Vcenter::Ovf::LibraryItem.deploy`   and   :func:`Com::Vmware::Vcenter::Ovf::LibraryItem.filter`  .

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (SizeParams) 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) 



2342
2343
2344
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2342

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

Instance Attribute Details

- (Fixnum) approximate_download_size

A best guess as to the total amount of data that must be transferred to download the OVF package. 


 This may be inaccurate due to disk compression etc.

This field is not used in the input parameters when deploying an OVF package. This field is optional in the result when retrieving information about an OVF package. It will be nil if there is insufficient information to provide a proper estimate.

Returns:

  • (Fixnum) 


2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2311

class SizeParams < 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.vcenter.ovf.size_params',
                {
                    'approximate_download_size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'approximate_flat_deployment_size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'approximate_sparse_deployment_size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'variable_disk_size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                },
                SizeParams,
                false,
                nil)
        end
    end

    attr_accessor :approximate_download_size,
                  :approximate_flat_deployment_size,
                  :approximate_sparse_deployment_size,
                  :variable_disk_size,
                  :type

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

A best guess as to the total amount of space required to deploy the OVF package if using flat disks. This field is not used in the input parameters when deploying an OVF package. This field is optional in the result when retrieving information about an OVF package. It will be nil if there is insufficient information to provide a proper estimate.

Returns:

  • (Fixnum) 


2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2311

class SizeParams < 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.vcenter.ovf.size_params',
                {
                    'approximate_download_size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'approximate_flat_deployment_size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'approximate_sparse_deployment_size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'variable_disk_size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                },
                SizeParams,
                false,
                nil)
        end
    end

    attr_accessor :approximate_download_size,
                  :approximate_flat_deployment_size,
                  :approximate_sparse_deployment_size,
                  :variable_disk_size,
                  :type

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

A best guess as to the total amount of space required to deploy the OVF package using sparse disks. This field is not used in the input parameters when deploying an OVF package. This field is optional in the result when retrieving information about an OVF package. It will be nil if there is insufficient information to provide a proper estimate.

Returns:

  • (Fixnum) 


2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2311

class SizeParams < 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.vcenter.ovf.size_params',
                {
                    'approximate_download_size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'approximate_flat_deployment_size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'approximate_sparse_deployment_size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'variable_disk_size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                },
                SizeParams,
                false,
                nil)
        end
    end

    attr_accessor :approximate_download_size,
                  :approximate_flat_deployment_size,
                  :approximate_sparse_deployment_size,
                  :variable_disk_size,
                  :type

    # 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

- (Object) type

Returns the value of attribute type 



2333
2334
2335
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2333

def type
  @type
end

- (Boolean) variable_disk_size

Whether the OVF uses variable disk sizes. 


 For empty disks, rather than specifying a fixed virtual disk capacity, the capacity may be given using a reference to a ovf:Property element in a ovf:ProductSection element in OVF package.

This field is not used in the input parameters when deploying an OVF package. This field is optional in the result when retrieving information about an OVF package. If nil or false, the OVF does not use variable disk sizes.

Returns:

  • (Boolean) 


2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2311

class SizeParams < 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.vcenter.ovf.size_params',
                {
                    'approximate_download_size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'approximate_flat_deployment_size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'approximate_sparse_deployment_size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'variable_disk_size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                },
                SizeParams,
                false,
                nil)
        end
    end

    attr_accessor :approximate_download_size,
                  :approximate_flat_deployment_size,
                  :approximate_sparse_deployment_size,
                  :variable_disk_size,
                  :type

    # 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 



2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2317

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.vcenter.ovf.size_params',
        {
            'approximate_download_size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
            'approximate_flat_deployment_size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
            'approximate_sparse_deployment_size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
            'variable_disk_size' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
            'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
        },
        SizeParams,
        false,
        nil)
end