com.vmware.vcenter.vm.hardware.boot

Class DeviceStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.vm.hardware.boot.DeviceStub

All Implemented Interfaces:

Service, Device, DeviceTypes

public class DeviceStub
extends com.vmware.vapi.internal.bindings.Stub
implements Device

Remote stub implementation of the Device API service.

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

Nested Class Summary

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

DeviceTypes.Entry, DeviceTypes.EntryCreateSpec, DeviceTypes.Type

Field Summary

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

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.vcenter.vm.hardware.boot.DeviceTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.util.List<DeviceTypes.Entry>	get(java.lang.String vm) Returns an ordered list of boot devices for the virtual machine.
void	get(java.lang.String vm, AsyncCallback<java.util.List<DeviceTypes.Entry>> asyncCallback) Returns an ordered list of boot devices for the virtual machine.
void	get(java.lang.String vm, AsyncCallback<java.util.List<DeviceTypes.Entry>> asyncCallback, InvocationConfig invocationConfig) Returns an ordered list of boot devices for the virtual machine.
java.util.List<DeviceTypes.Entry>	get(java.lang.String vm, InvocationConfig invocationConfig) Returns an ordered list of boot devices for the virtual machine.
void	set(java.lang.String vm, java.util.List<DeviceTypes.Entry> devices) Sets the virtual devices that will be used to boot the virtual machine.
void	set(java.lang.String vm, java.util.List<DeviceTypes.Entry> devices, AsyncCallback<java.lang.Void> asyncCallback) Sets the virtual devices that will be used to boot the virtual machine.
void	set(java.lang.String vm, java.util.List<DeviceTypes.Entry> devices, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Sets the virtual devices that will be used to boot the virtual machine.
void	set(java.lang.String vm, java.util.List<DeviceTypes.Entry> devices, InvocationConfig invocationConfig) Sets the virtual devices that will be used to boot the virtual machine.

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

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceStub

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

DeviceStub

public DeviceStub(ApiProvider apiProvider,
                  StubConfigurationBase config)

Method Detail

get

public java.util.List<DeviceTypes.Entry> get(java.lang.String vm)

Description copied from interface: Device

Returns an ordered list of boot devices for the virtual machine. If the List is empty, the virtual machine uses a default boot sequence.

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

Specified by:

get in interface Device

Parameters:

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

Returns:

Ordered list of configured boot devices.

get

public java.util.List<DeviceTypes.Entry> get(java.lang.String vm,
                                             InvocationConfig invocationConfig)

Description copied from interface: Device

Returns an ordered list of boot devices for the virtual machine. If the List is empty, the virtual machine uses a default boot sequence.

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 Device

Parameters:

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

invocationConfig - Configuration for the method invocation.

Returns:

Ordered list of configured boot devices.

get

public void get(java.lang.String vm,
                AsyncCallback<java.util.List<DeviceTypes.Entry>> asyncCallback)

Description copied from interface: Device

Returns an ordered list of boot devices for the virtual machine. If the List is empty, the virtual machine uses a default boot sequence.

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

Invocation Result:
Ordered list of configured boot devices.

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 Device

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<java.util.List<DeviceTypes.Entry>> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Device

Returns an ordered list of boot devices for the virtual machine. If the List is empty, the virtual machine uses a default boot sequence.

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:
Ordered list of configured boot devices.

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 Device

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.

set

public void set(java.lang.String vm,
                java.util.List<DeviceTypes.Entry> devices)

Description copied from interface: Device

Sets the virtual devices that will be used to boot the virtual machine. The virtual machine will check the devices in order, attempting to boot from each, until the virtual machine boots successfully. If the List is empty, the virtual machine will use a default boot sequence. There should be no more than one instance of DeviceTypes.Entry for a given device type except DeviceTypes.Type.ETHERNET in the List.

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

Specified by:

set in interface Device

Parameters:

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

devices - Ordered list of boot devices.

set

public void set(java.lang.String vm,
                java.util.List<DeviceTypes.Entry> devices,
                InvocationConfig invocationConfig)

Description copied from interface: Device

Sets the virtual devices that will be used to boot the virtual machine. The virtual machine will check the devices in order, attempting to boot from each, until the virtual machine boots successfully. If the List is empty, the virtual machine will use a default boot sequence. There should be no more than one instance of DeviceTypes.Entry for a given device type except DeviceTypes.Type.ETHERNET in the List.

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:

set in interface Device

Parameters:

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

devices - Ordered list of boot devices.

invocationConfig - Configuration for the method invocation.

set

public void set(java.lang.String vm,
                java.util.List<DeviceTypes.Entry> devices,
                AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Device

Sets the virtual devices that will be used to boot the virtual machine. The virtual machine will check the devices in order, attempting to boot from each, until the virtual machine boots successfully. If the List is empty, the virtual machine will use a default boot sequence. There should be no more than one instance of DeviceTypes.Entry for a given device type except DeviceTypes.Type.ETHERNET in the List.

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, or if any of the specified virtual devices is not found.
InvalidArgument - if a any of the CDROM, DISK, ETHERNET, FLOPPY values appears in more than one Entry with the exception of DeviceTypes.Type.ETHERNET, which may appear multiple times if the virtual machine has been configured with multiple Ethernet adapters.
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:

set in interface Device

Parameters:

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

devices - Ordered list of boot devices.

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

set

public void set(java.lang.String vm,
                java.util.List<DeviceTypes.Entry> devices,
                AsyncCallback<java.lang.Void> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Device

Sets the virtual devices that will be used to boot the virtual machine. The virtual machine will check the devices in order, attempting to boot from each, until the virtual machine boots successfully. If the List is empty, the virtual machine will use a default boot sequence. There should be no more than one instance of DeviceTypes.Entry for a given device type except DeviceTypes.Type.ETHERNET in the List.

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, or if any of the specified virtual devices is not found.
InvalidArgument - if a any of the CDROM, DISK, ETHERNET, FLOPPY values appears in more than one Entry with the exception of DeviceTypes.Type.ETHERNET, which may appear multiple times if the virtual machine has been configured with multiple Ethernet adapters.
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:

set in interface Device

Parameters:

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

devices - Ordered list of boot devices.

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

invocationConfig - Configuration for the method invocation.