com.vmware.vcenter.vm.hardware

Class MemoryStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.vm.hardware.MemoryStub

All Implemented Interfaces:

Service, Memory, MemoryTypes

public class MemoryStub
extends com.vmware.vapi.internal.bindings.Stub
implements Memory

Remote stub implementation of the Memory API service.

WARNING: Internal API, subject to change in future versions.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.vm.hardware.MemoryTypes

MemoryTypes.Info, MemoryTypes.UpdateSpec

Constructor Summary

Constructors

Constructor and Description
MemoryStub(ApiProvider apiProvider, StubConfigurationBase config)

Method Summary

Methods

Modifier and Type	Method and Description
MemoryTypes.Info	get(String vm) Returns the memory-related settings of a virtual machine.
void	get(String vm, AsyncCallback<MemoryTypes.Info> asyncCallback) Returns the memory-related settings of a virtual machine.
void	get(String vm, AsyncCallback<MemoryTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns the memory-related settings of a virtual machine.
MemoryTypes.Info	get(String vm, InvocationConfig invocationConfig) Returns the memory-related settings of a virtual machine.
void	update(String vm, MemoryTypes.UpdateSpec spec) Updates the memory-related settings of a virtual machine.
void	update(String vm, MemoryTypes.UpdateSpec spec, AsyncCallback<Void> asyncCallback) Updates the memory-related settings of a virtual machine.
void	update(String vm, MemoryTypes.UpdateSpec spec, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Updates the memory-related settings of a virtual machine.
void	update(String vm, MemoryTypes.UpdateSpec spec, InvocationConfig invocationConfig) Updates the memory-related settings of a virtual machine.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MemoryStub

public MemoryStub(ApiProvider apiProvider,
          StubConfigurationBase config)

Method Detail

get

public MemoryTypes.Info get(String vm)

Description copied from interface: Memory

Returns the memory-related settings of a virtual machine.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

get in interface Memory

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

Returns:

Memory-related settings of the virtual machine.

get

public MemoryTypes.Info get(String vm,
                   InvocationConfig invocationConfig)

Description copied from interface: Memory

Returns the memory-related settings of a virtual machine.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

get in interface Memory

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

invocationConfig - Configuration for the method invocation.

Returns:

Memory-related settings of the virtual machine.

get

public void get(String vm,
       AsyncCallback<MemoryTypes.Info> asyncCallback)

Description copied from interface: Memory

Returns the memory-related settings of a virtual machine.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Result:
Memory-related settings of the virtual machine.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Specified by:

get in interface Memory

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

public void get(String vm,
       AsyncCallback<MemoryTypes.Info> asyncCallback,
       InvocationConfig invocationConfig)

Description copied from interface: Memory

Returns the memory-related settings of a virtual machine.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
Memory-related settings of the virtual machine.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Specified by:

get in interface Memory

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

update

public void update(String vm,
          MemoryTypes.UpdateSpec spec)

Description copied from interface: Memory

Updates the memory-related settings of a virtual machine.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

update in interface Memory

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

spec - Specification for updating the memory-related settings of the virtual machine.

update

public void update(String vm,
          MemoryTypes.UpdateSpec spec,
          InvocationConfig invocationConfig)

Description copied from interface: Memory

Updates the memory-related settings of a virtual machine.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

update in interface Memory

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

spec - Specification for updating the memory-related settings of the virtual machine.

invocationConfig - Configuration for the method invocation.

update

public void update(String vm,
          MemoryTypes.UpdateSpec spec,
          AsyncCallback<Void> asyncCallback)

Description copied from interface: Memory

Updates the memory-related settings of a virtual machine.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
InvalidArgument - if one of the provided settings is not permitted; for example, specifying a negative value for getSizeMiB().
NotAllowedInCurrentState - if getHotAddEnabled() is specified and the virtual machine is not powered off.
NotAllowedInCurrentState - if getSizeMiB() is specified, getHotAddEnabled() is false, and the virtual machine is not powered off.
ResourceBusy - if the virtual machine is busy performing another operation.
ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Specified by:

update in interface Memory

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

spec - Specification for updating the memory-related settings of the virtual machine.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

update

public void update(String vm,
          MemoryTypes.UpdateSpec spec,
          AsyncCallback<Void> asyncCallback,
          InvocationConfig invocationConfig)

Description copied from interface: Memory

Updates the memory-related settings of a virtual machine.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
InvalidArgument - if one of the provided settings is not permitted; for example, specifying a negative value for getSizeMiB().
NotAllowedInCurrentState - if getHotAddEnabled() is specified and the virtual machine is not powered off.
NotAllowedInCurrentState - if getSizeMiB() is specified, getHotAddEnabled() is false, and the virtual machine is not powered off.
ResourceBusy - if the virtual machine is busy performing another operation.
ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Specified by:

update in interface Memory

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

spec - Specification for updating the memory-related settings of the virtual machine.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.