com.vmware.vcenter.vm

Class HardwareStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.vm.HardwareStub

All Implemented Interfaces:

Service, Hardware, HardwareTypes

public class HardwareStub
extends com.vmware.vapi.internal.bindings.Stub
implements Hardware

Remote stub implementation of the Hardware API service.

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

Nested Class Summary

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

HardwareTypes.Info, HardwareTypes.UpdateSpec, HardwareTypes.UpgradePolicy, HardwareTypes.UpgradeStatus, HardwareTypes.Version

Field Summary

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

apiProvider, converter, ifaceId, securityContext

Fields inherited from interface com.vmware.vcenter.vm.HardwareTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
HardwareStub(ApiProvider apiProvider, StubConfigurationBase config)
HardwareStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

Method Summary

Modifier and Type	Method and Description
HardwareTypes.Info	get(java.lang.String vm) Returns the virtual hardware settings of a virtual machine.
void	get(java.lang.String vm, AsyncCallback<HardwareTypes.Info> asyncCallback) Returns the virtual hardware settings of a virtual machine.
void	get(java.lang.String vm, AsyncCallback<HardwareTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns the virtual hardware settings of a virtual machine.
HardwareTypes.Info	get(java.lang.String vm, InvocationConfig invocationConfig) Returns the virtual hardware settings of a virtual machine.
void	update(java.lang.String vm, HardwareTypes.UpdateSpec spec) Updates the virtual hardware settings of a virtual machine.
void	update(java.lang.String vm, HardwareTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Updates the virtual hardware settings of a virtual machine.
void	update(java.lang.String vm, HardwareTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Updates the virtual hardware settings of a virtual machine.
void	update(java.lang.String vm, HardwareTypes.UpdateSpec spec, InvocationConfig invocationConfig) Updates the virtual hardware settings of a virtual machine.
void	upgrade(java.lang.String vm, HardwareTypes.Version version) Upgrades the virtual machine to a newer virtual hardware version.
void	upgrade(java.lang.String vm, HardwareTypes.Version version, AsyncCallback<java.lang.Void> asyncCallback) Upgrades the virtual machine to a newer virtual hardware version.
void	upgrade(java.lang.String vm, HardwareTypes.Version version, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Upgrades the virtual machine to a newer virtual hardware version.
void	upgrade(java.lang.String vm, HardwareTypes.Version version, InvocationConfig invocationConfig) Upgrades the virtual machine to a newer virtual hardware version.

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

invokeMethod, invokeMethodAsync, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HardwareStub

public HardwareStub(ApiProvider apiProvider,
                    com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                    StubConfigurationBase config)

HardwareStub

public HardwareStub(ApiProvider apiProvider,
                    StubConfigurationBase config)

Method Detail

get

public HardwareTypes.Info get(java.lang.String vm)

Description copied from interface: Hardware

Returns the virtual hardware 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 Hardware

Parameters:

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

Returns:

Virtual hardware settings of the virtual machine.

get

public HardwareTypes.Info get(java.lang.String vm,
                              InvocationConfig invocationConfig)

Description copied from interface: Hardware

Returns the virtual hardware 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 Hardware

Parameters:

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

invocationConfig - Configuration for the method invocation.

Returns:

Virtual hardware settings of the virtual machine.

get

public void get(java.lang.String vm,
                AsyncCallback<HardwareTypes.Info> asyncCallback)

Description copied from interface: Hardware

Returns the virtual hardware settings of a virtual machine.

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

Invocation Result:
Virtual hardware 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 Hardware

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(java.lang.String vm,
                AsyncCallback<HardwareTypes.Info> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Hardware

Returns the virtual hardware 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.

Invocation Result:
Virtual hardware 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 Hardware

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(java.lang.String vm,
                   HardwareTypes.UpdateSpec spec)

Description copied from interface: Hardware

Updates the virtual hardware 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 Hardware

Parameters:

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

spec - Specification for updating the virtual hardware settings of the virtual machine.

update

public void update(java.lang.String vm,
                   HardwareTypes.UpdateSpec spec,
                   InvocationConfig invocationConfig)

Description copied from interface: Hardware

Updates the virtual hardware 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 Hardware

Parameters:

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

spec - Specification for updating the virtual hardware settings of the virtual machine.

invocationConfig - Configuration for the method invocation.

update

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

Description copied from interface: Hardware

Updates the virtual hardware 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.
AlreadyInDesiredState - if the virtual machine is already configured for the desired hardware version.
InvalidArgument - if the requested virtual hardware version is not newer than the current version.
Unsupported - if the requested virtual hardware version is not supported by the server.
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 Hardware

Parameters:

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

spec - Specification for updating the virtual hardware settings of the virtual machine.

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

update

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

Description copied from interface: Hardware

Updates the virtual hardware 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.
AlreadyInDesiredState - if the virtual machine is already configured for the desired hardware version.
InvalidArgument - if the requested virtual hardware version is not newer than the current version.
Unsupported - if the requested virtual hardware version is not supported by the server.
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 Hardware

Parameters:

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

spec - Specification for updating the virtual hardware settings of the virtual machine.

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

invocationConfig - Configuration for the method invocation.

upgrade

public void upgrade(java.lang.String vm,
                    HardwareTypes.Version version)

Description copied from interface: Hardware

Upgrades the virtual machine to a newer virtual hardware version.

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

Specified by:

upgrade in interface Hardware

Parameters:

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

version - New virtual machine version. If null, defaults to the most recent virtual hardware version supported by the server.

upgrade

public void upgrade(java.lang.String vm,
                    HardwareTypes.Version version,
                    InvocationConfig invocationConfig)

Description copied from interface: Hardware

Upgrades the virtual machine to a newer virtual hardware version.

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:

upgrade in interface Hardware

Parameters:

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

version - New virtual machine version. If null, defaults to the most recent virtual hardware version supported by the server.

invocationConfig - Configuration for the method invocation.

upgrade

public void upgrade(java.lang.String vm,
                    HardwareTypes.Version version,
                    AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Hardware

Upgrades the virtual machine to a newer virtual hardware version.

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.
NotAllowedInCurrentState - if the virtual machine is not powered off.
AlreadyInDesiredState - if the virtual machine is already configured for the desired hardware version.
InvalidArgument - if version is older than the current virtual hardware version.
Unsupported - if version is not supported by the server.
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:

upgrade in interface Hardware

Parameters:

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

version - New virtual machine version. If null, defaults to the most recent virtual hardware version supported by the server.

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

upgrade

public void upgrade(java.lang.String vm,
                    HardwareTypes.Version version,
                    AsyncCallback<java.lang.Void> asyncCallback,
                    InvocationConfig invocationConfig)

Description copied from interface: Hardware

Upgrades the virtual machine to a newer virtual hardware version.

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.
NotAllowedInCurrentState - if the virtual machine is not powered off.
AlreadyInDesiredState - if the virtual machine is already configured for the desired hardware version.
InvalidArgument - if version is older than the current virtual hardware version.
Unsupported - if version is not supported by the server.
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:

upgrade in interface Hardware

Parameters:

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

version - New virtual machine version. If null, defaults to the most recent virtual hardware version supported by the server.

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

invocationConfig - Configuration for the method invocation.