Class: Com::Vmware::Vcenter::Vm::Hardware::Memory::UpdateSpec

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

Overview

The ``Com::Vmware::Vcenter::Vm::Hardware::Memory::UpdateSpec`` class describes the updates to be made to the memory-related settings of a virtual machine.

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

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



4262
4263
4264
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4262

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

Instance Attribute Details

- (Boolean?) hot_add_enabled

Flag indicating whether adding memory while the virtual machine is running should be enabled. 


 Some guest operating systems may consume more resources or perform less efficiently when they run on hardware that supports adding memory while the machine is running.  

 This  field  may only be modified if the virtual machine is not powered on.

If nil , the value is unchanged.

Returns:

  • (Boolean, nil) 


4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4237

class UpdateSpec < 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.vm.hardware.memory.update_spec',
                {
                    'size_MiB' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'hot_add_enabled' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                },
                UpdateSpec,
                false,
                nil)
        end
    end

    attr_accessor :size_mib,
                  :hot_add_enabled

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

New memory size in mebibytes. 


 The supported range of memory sizes is constrained by the configured guest operating system and virtual hardware version of the virtual machine.  

 If the virtual machine is running, this value may only be changed if   :attr:`Com::Vmware::Vcenter::Vm::Hardware::Memory::Info.hot_add_enabled`   is true, and the new memory size must satisfy the constraints specified by   :attr:`Com::Vmware::Vcenter::Vm::Hardware::Memory::Info.hot_add_increment_size_mib`   and   :attr:`Com::Vmware::Vcenter::Vm::Hardware::Memory::Info.hot_add_limit_mib`  .

If nil , the value is unchanged.

Returns:

  • (Fixnum, nil) 


4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4237

class UpdateSpec < 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.vm.hardware.memory.update_spec',
                {
                    'size_MiB' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'hot_add_enabled' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                },
                UpdateSpec,
                false,
                nil)
        end
    end

    attr_accessor :size_mib,
                  :hot_add_enabled

    # 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 



4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4243

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.vcenter.vm.hardware.memory.update_spec',
        {
            'size_MiB' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
            'hot_add_enabled' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
        },
        UpdateSpec,
        false,
        nil)
end