com.vmware.vcenter.vm.hardware

Class DiskStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.vm.hardware.DiskStub

All Implemented Interfaces:

Service, Disk, DiskTypes

public class DiskStub
extends com.vmware.vapi.internal.bindings.Stub
implements Disk

Remote stub implementation of the Disk 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.DiskTypes

DiskTypes.BackingInfo, DiskTypes.BackingSpec, DiskTypes.BackingType, DiskTypes.CreateSpec, DiskTypes.HostBusAdapterType, DiskTypes.Info, DiskTypes.Summary, DiskTypes.UpdateSpec, DiskTypes.VmdkCreateSpec

Field Summary

Fields inherited from interface com.vmware.vcenter.vm.hardware.DiskTypes

RESOURCE_TYPE

Constructor Summary

Constructors

Constructor and Description
DiskStub(ApiProvider apiProvider, StubConfigurationBase config)

Method Summary

Methods

Modifier and Type	Method and Description
String	create(String vm, DiskTypes.CreateSpec spec) Adds a virtual disk to the virtual machine.
void	create(String vm, DiskTypes.CreateSpec spec, AsyncCallback<String> asyncCallback) Adds a virtual disk to the virtual machine.
void	create(String vm, DiskTypes.CreateSpec spec, AsyncCallback<String> asyncCallback, InvocationConfig invocationConfig) Adds a virtual disk to the virtual machine.
String	create(String vm, DiskTypes.CreateSpec spec, InvocationConfig invocationConfig) Adds a virtual disk to the virtual machine.
void	delete(String vm, String disk) Removes a virtual disk from the virtual machine.
void	delete(String vm, String disk, AsyncCallback<Void> asyncCallback) Removes a virtual disk from the virtual machine.
void	delete(String vm, String disk, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Removes a virtual disk from the virtual machine.
void	delete(String vm, String disk, InvocationConfig invocationConfig) Removes a virtual disk from the virtual machine.
DiskTypes.Info	get(String vm, String disk) Returns information about a virtual disk.
void	get(String vm, String disk, AsyncCallback<DiskTypes.Info> asyncCallback) Returns information about a virtual disk.
void	get(String vm, String disk, AsyncCallback<DiskTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about a virtual disk.
DiskTypes.Info	get(String vm, String disk, InvocationConfig invocationConfig) Returns information about a virtual disk.
List<DiskTypes.Summary>	list(String vm) Returns commonly used information about the virtual disks belonging to the virtual machine.
void	list(String vm, AsyncCallback<List<DiskTypes.Summary>> asyncCallback) Returns commonly used information about the virtual disks belonging to the virtual machine.
void	list(String vm, AsyncCallback<List<DiskTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns commonly used information about the virtual disks belonging to the virtual machine.
List<DiskTypes.Summary>	list(String vm, InvocationConfig invocationConfig) Returns commonly used information about the virtual disks belonging to the virtual machine.
void	update(String vm, String disk, DiskTypes.UpdateSpec spec) Updates the configuration of a virtual disk.
void	update(String vm, String disk, DiskTypes.UpdateSpec spec, AsyncCallback<Void> asyncCallback) Updates the configuration of a virtual disk.
void	update(String vm, String disk, DiskTypes.UpdateSpec spec, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Updates the configuration of a virtual disk.
void	update(String vm, String disk, DiskTypes.UpdateSpec spec, InvocationConfig invocationConfig) Updates the configuration of a virtual disk.

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

DiskStub

public DiskStub(ApiProvider apiProvider,
        StubConfigurationBase config)

Method Detail

list

public List<DiskTypes.Summary> list(String vm)

Description copied from interface: Disk

Returns commonly used information about the virtual disks belonging to the virtual machine.

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

Specified by:

list in interface Disk

Parameters:

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

Returns:

List of commonly used information about the virtual disks.

list

public List<DiskTypes.Summary> list(String vm,
                           InvocationConfig invocationConfig)

Description copied from interface: Disk

Returns commonly used information about the virtual disks belonging to the 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:

list in interface Disk

Parameters:

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

invocationConfig - Configuration for the method invocation.

Returns:

List of commonly used information about the virtual disks.

list

public void list(String vm,
        AsyncCallback<List<DiskTypes.Summary>> asyncCallback)

Description copied from interface: Disk

Returns commonly used information about the virtual disks belonging to the virtual machine.

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

Operation Result:
List of commonly used information about the virtual disks.

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:

list in interface Disk

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.

list

public void list(String vm,
        AsyncCallback<List<DiskTypes.Summary>> asyncCallback,
        InvocationConfig invocationConfig)

Description copied from interface: Disk

Returns commonly used information about the virtual disks belonging to the 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:
List of commonly used information about the virtual disks.

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:

list in interface Disk

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.

get

public DiskTypes.Info get(String vm,
                 String disk)

Description copied from interface: Disk

Returns information about a virtual disk.

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

Specified by:

get in interface Disk

Parameters:

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

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

Returns:

Information about the specified virtual disk.

get

public DiskTypes.Info get(String vm,
                 String disk,
                 InvocationConfig invocationConfig)

Description copied from interface: Disk

Returns information about a virtual disk.

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 Disk

Parameters:

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

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the specified virtual disk.

get

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

Description copied from interface: Disk

Returns information about a virtual disk.

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

Operation Result:
Information about the specified virtual disk.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine or virtual disk 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 Disk

Parameters:

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

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

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

get

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

Description copied from interface: Disk

Returns information about a virtual disk.

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:
Information about the specified virtual disk.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine or virtual disk 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 Disk

Parameters:

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

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

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

invocationConfig - Configuration for the method invocation.

create

public String create(String vm,
            DiskTypes.CreateSpec spec)

Description copied from interface: Disk

Adds a virtual disk to the virtual machine. While adding the virtual disk, a new VMDK file may be created or an existing VMDK file may be used to back the virtual disk.

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

Specified by:

create in interface Disk

Parameters:

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

spec - Specification for the new virtual disk.

Returns:

Virtual disk identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

create

public String create(String vm,
            DiskTypes.CreateSpec spec,
            InvocationConfig invocationConfig)

Description copied from interface: Disk

Adds a virtual disk to the virtual machine. While adding the virtual disk, a new VMDK file may be created or an existing VMDK file may be used to back the virtual disk.

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:

create in interface Disk

Parameters:

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

spec - Specification for the new virtual disk.

invocationConfig - Configuration for the method invocation.

Returns:

Virtual disk identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

create

public void create(String vm,
          DiskTypes.CreateSpec spec,
          AsyncCallback<String> asyncCallback)

Description copied from interface: Disk

Adds a virtual disk to the virtual machine. While adding the virtual disk, a new VMDK file may be created or an existing VMDK file may be used to back the virtual disk.

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

Operation Result:
Virtual disk identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

Operation Errors:
Error - if system reported that the disk device was created but was unable to confirm the creation because the identifier of the new device could not be determined.
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 suspended or if the virtual machine is powered on and virtual disk type is IDE.
UnableToAllocateResource - if the specified storage address is unavailable; for example, if the SCSI adapter requested does not exist.
ResourceInUse - if the specified storage address is in use.
InvalidArgument - if the specified storage address is out of bounds.
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.
Unsupported - if the guest operating system of the virtual machine is not supported and spec includes null properties that default to guest-specific values.

Specified by:

create in interface Disk

Parameters:

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

spec - Specification for the new virtual disk.

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

create

public void create(String vm,
          DiskTypes.CreateSpec spec,
          AsyncCallback<String> asyncCallback,
          InvocationConfig invocationConfig)

Description copied from interface: Disk

Adds a virtual disk to the virtual machine. While adding the virtual disk, a new VMDK file may be created or an existing VMDK file may be used to back the virtual disk.

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:
Virtual disk identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

Operation Errors:
Error - if system reported that the disk device was created but was unable to confirm the creation because the identifier of the new device could not be determined.
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 suspended or if the virtual machine is powered on and virtual disk type is IDE.
UnableToAllocateResource - if the specified storage address is unavailable; for example, if the SCSI adapter requested does not exist.
ResourceInUse - if the specified storage address is in use.
InvalidArgument - if the specified storage address is out of bounds.
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.
Unsupported - if the guest operating system of the virtual machine is not supported and spec includes null properties that default to guest-specific values.

Specified by:

create in interface Disk

Parameters:

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

spec - Specification for the new virtual disk.

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

invocationConfig - Configuration for the method invocation.

update

public void update(String vm,
          String disk,
          DiskTypes.UpdateSpec spec)

Description copied from interface: Disk

Updates the configuration of a virtual disk. An update method can be used to detach the existing VMDK file and attach another VMDK file to the virtual machine.

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

Specified by:

update in interface Disk

Parameters:

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

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

spec - Specification for updating the virtual disk.

update

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

Description copied from interface: Disk

Updates the configuration of a virtual disk. An update method can be used to detach the existing VMDK file and attach another VMDK file to the 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 Disk

Parameters:

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

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

spec - Specification for updating the virtual disk.

invocationConfig - Configuration for the method invocation.

update

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

Description copied from interface: Disk

Updates the configuration of a virtual disk. An update method can be used to detach the existing VMDK file and attach another VMDK file to the 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 or virtual disk is not found.
NotAllowedInCurrentState - if one or more of the properties specified in the spec parameter cannot be modified due to the current power state of the virtual machine or the connection state of the virtual disk.
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 Disk

Parameters:

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

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

spec - Specification for updating the virtual disk.

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

update

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

Description copied from interface: Disk

Updates the configuration of a virtual disk. An update method can be used to detach the existing VMDK file and attach another VMDK file to the 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 or virtual disk is not found.
NotAllowedInCurrentState - if one or more of the properties specified in the spec parameter cannot be modified due to the current power state of the virtual machine or the connection state of the virtual disk.
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 Disk

Parameters:

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

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

spec - Specification for updating the virtual disk.

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

invocationConfig - Configuration for the method invocation.

delete

public void delete(String vm,
          String disk)

Description copied from interface: Disk

Removes a virtual disk from the virtual machine. This method does not destroy the VMDK file that backs the virtual disk. It only detaches the VMDK file from the virtual machine. Once detached, the VMDK file will not be destroyed when the virtual machine to which it was associated is deleted.

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

Specified by:

delete in interface Disk

Parameters:

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

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

delete

public void delete(String vm,
          String disk,
          InvocationConfig invocationConfig)

Description copied from interface: Disk

Removes a virtual disk from the virtual machine. This method does not destroy the VMDK file that backs the virtual disk. It only detaches the VMDK file from the virtual machine. Once detached, the VMDK file will not be destroyed when the virtual machine to which it was associated is deleted.

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:

delete in interface Disk

Parameters:

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

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

invocationConfig - Configuration for the method invocation.

delete

public void delete(String vm,
          String disk,
          AsyncCallback<Void> asyncCallback)

Description copied from interface: Disk

Removes a virtual disk from the virtual machine. This method does not destroy the VMDK file that backs the virtual disk. It only detaches the VMDK file from the virtual machine. Once detached, the VMDK file will not be destroyed when the virtual machine to which it was associated is deleted.

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 or virtual disk is not found.
NotAllowedInCurrentState - if the virtual machine is suspended or if the virtual machine is powered on and virtual disk type is IDE.
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:

delete in interface Disk

Parameters:

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

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

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

delete

public void delete(String vm,
          String disk,
          AsyncCallback<Void> asyncCallback,
          InvocationConfig invocationConfig)

Description copied from interface: Disk

Removes a virtual disk from the virtual machine. This method does not destroy the VMDK file that backs the virtual disk. It only detaches the VMDK file from the virtual machine. Once detached, the VMDK file will not be destroyed when the virtual machine to which it was associated is deleted.

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 or virtual disk is not found.
NotAllowedInCurrentState - if the virtual machine is suspended or if the virtual machine is powered on and virtual disk type is IDE.
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:

delete in interface Disk

Parameters:

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

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

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

invocationConfig - Configuration for the method invocation.