com.vmware.vcenter.vm.hardware.adapter

Class SataStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.vm.hardware.adapter.SataStub

All Implemented Interfaces:

Service, Sata, SataTypes

public class SataStub
extends com.vmware.vapi.internal.bindings.Stub
implements Sata

Remote stub implementation of the Sata 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.adapter.SataTypes

SataTypes.CreateSpec, SataTypes.Info, SataTypes.Summary, SataTypes.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.adapter.SataTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	create(java.lang.String vm, SataTypes.CreateSpec spec) Adds a virtual SATA adapter to the virtual machine.
void	create(java.lang.String vm, SataTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Adds a virtual SATA adapter to the virtual machine.
void	create(java.lang.String vm, SataTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Adds a virtual SATA adapter to the virtual machine.
java.lang.String	create(java.lang.String vm, SataTypes.CreateSpec spec, InvocationConfig invocationConfig) Adds a virtual SATA adapter to the virtual machine.
void	delete(java.lang.String vm, java.lang.String adapter) Removes a virtual SATA adapter from the virtual machine.
void	delete(java.lang.String vm, java.lang.String adapter, AsyncCallback<java.lang.Void> asyncCallback) Removes a virtual SATA adapter from the virtual machine.
void	delete(java.lang.String vm, java.lang.String adapter, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Removes a virtual SATA adapter from the virtual machine.
void	delete(java.lang.String vm, java.lang.String adapter, InvocationConfig invocationConfig) Removes a virtual SATA adapter from the virtual machine.
SataTypes.Info	get(java.lang.String vm, java.lang.String adapter) Returns information about a virtual SATA adapter.
void	get(java.lang.String vm, java.lang.String adapter, AsyncCallback<SataTypes.Info> asyncCallback) Returns information about a virtual SATA adapter.
void	get(java.lang.String vm, java.lang.String adapter, AsyncCallback<SataTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about a virtual SATA adapter.
SataTypes.Info	get(java.lang.String vm, java.lang.String adapter, InvocationConfig invocationConfig) Returns information about a virtual SATA adapter.
java.util.List<SataTypes.Summary>	list(java.lang.String vm) Returns commonly used information about the virtual SATA adapters belonging to the virtual machine.
void	list(java.lang.String vm, AsyncCallback<java.util.List<SataTypes.Summary>> asyncCallback) Returns commonly used information about the virtual SATA adapters belonging to the virtual machine.
void	list(java.lang.String vm, AsyncCallback<java.util.List<SataTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns commonly used information about the virtual SATA adapters belonging to the virtual machine.
java.util.List<SataTypes.Summary>	list(java.lang.String vm, InvocationConfig invocationConfig) Returns commonly used information about the virtual SATA adapters belonging to 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

SataStub

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

SataStub

public SataStub(ApiProvider apiProvider,
                StubConfigurationBase config)

Method Detail

list

public java.util.List<SataTypes.Summary> list(java.lang.String vm)

Description copied from interface: Sata

Returns commonly used information about the virtual SATA adapters 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 Sata

Parameters:

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

Returns:

List of commonly used information about virtual SATA adapters.

list

public java.util.List<SataTypes.Summary> list(java.lang.String vm,
                                              InvocationConfig invocationConfig)

Description copied from interface: Sata

Returns commonly used information about the virtual SATA adapters 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 Sata

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 virtual SATA adapters.

list

public void list(java.lang.String vm,
                 AsyncCallback<java.util.List<SataTypes.Summary>> asyncCallback)

Description copied from interface: Sata

Returns commonly used information about the virtual SATA adapters belonging to the virtual machine.

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

Invocation Result:
List of commonly used information about virtual SATA adapters.

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 Sata

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(java.lang.String vm,
                 AsyncCallback<java.util.List<SataTypes.Summary>> asyncCallback,
                 InvocationConfig invocationConfig)

Description copied from interface: Sata

Returns commonly used information about the virtual SATA adapters 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.

Invocation Result:
List of commonly used information about virtual SATA adapters.

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 Sata

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 SataTypes.Info get(java.lang.String vm,
                          java.lang.String adapter)

Description copied from interface: Sata

Returns information about a virtual SATA adapter.

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

Specified by:

get in interface Sata

Parameters:

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

adapter - Virtual SATA adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

Returns:

Information about the specified virtual SATA adapter.

get

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

Description copied from interface: Sata

Returns information about a virtual SATA adapter.

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 Sata

Parameters:

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

adapter - Virtual SATA adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the specified virtual SATA adapter.

get

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

Description copied from interface: Sata

Returns information about a virtual SATA adapter.

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

Invocation Result:
Information about the specified virtual SATA adapter.

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

Parameters:

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

adapter - Virtual SATA adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

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

get

public void get(java.lang.String vm,
                java.lang.String adapter,
                AsyncCallback<SataTypes.Info> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Sata

Returns information about a virtual SATA adapter.

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

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

Parameters:

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

adapter - Virtual SATA adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

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

invocationConfig - Configuration for the method invocation.

create

public java.lang.String create(java.lang.String vm,
                               SataTypes.CreateSpec spec)

Description copied from interface: Sata

Adds a virtual SATA adapter to the virtual machine.

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

Specified by:

create in interface Sata

Parameters:

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

spec - Specification for the new virtual SATA adapter.

Returns:

Virtual SATA adapter identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

create

public java.lang.String create(java.lang.String vm,
                               SataTypes.CreateSpec spec,
                               InvocationConfig invocationConfig)

Description copied from interface: Sata

Adds a virtual SATA adapter 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:

create in interface Sata

Parameters:

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

spec - Specification for the new virtual SATA adapter.

invocationConfig - Configuration for the method invocation.

Returns:

Virtual SATA adapter identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

create

public void create(java.lang.String vm,
                   SataTypes.CreateSpec spec,
                   AsyncCallback<java.lang.String> asyncCallback)

Description copied from interface: Sata

Adds a virtual SATA adapter to the virtual machine.

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

Invocation Result:
Virtual SATA adapter identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

Operation Errors:
Error - if the system reports an error while responding to the request.
Error - if the system reported that the SATA adapter was created but was unable to confirm the creation because the identifier of the new adapter could not be determined.
NotAllowedInCurrentState - if the virtual machine is suspended
NotFound - if the virtual machine is not found.
UnableToAllocateResource - if there are no more available SATA buses on the virtual machine.
ResourceInUse - if the specified SATA bus or PCI address is in use.
InvalidArgument - if the specified SATA bus or PCI 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 Sata

Parameters:

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

spec - Specification for the new virtual SATA adapter.

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

create

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

Description copied from interface: Sata

Adds a virtual SATA adapter 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.

Invocation Result:
Virtual SATA adapter identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

Operation Errors:
Error - if the system reports an error while responding to the request.
Error - if the system reported that the SATA adapter was created but was unable to confirm the creation because the identifier of the new adapter could not be determined.
NotAllowedInCurrentState - if the virtual machine is suspended
NotFound - if the virtual machine is not found.
UnableToAllocateResource - if there are no more available SATA buses on the virtual machine.
ResourceInUse - if the specified SATA bus or PCI address is in use.
InvalidArgument - if the specified SATA bus or PCI 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 Sata

Parameters:

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

spec - Specification for the new virtual SATA adapter.

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

invocationConfig - Configuration for the method invocation.

delete

public void delete(java.lang.String vm,
                   java.lang.String adapter)

Description copied from interface: Sata

Removes a virtual SATA adapter from the virtual machine.

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

Specified by:

delete in interface Sata

Parameters:

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

adapter - Virtual SATA adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

delete

public void delete(java.lang.String vm,
                   java.lang.String adapter,
                   InvocationConfig invocationConfig)

Description copied from interface: Sata

Removes a virtual SATA adapter from 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:

delete in interface Sata

Parameters:

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

adapter - Virtual SATA adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

invocationConfig - Configuration for the method invocation.

delete

public void delete(java.lang.String vm,
                   java.lang.String adapter,
                   AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Sata

Removes a virtual SATA adapter from 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.
NotAllowedInCurrentState - if the virtual machine is suspended
NotFound - if the virtual machine or virtual SATA adapter is not found.
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 Sata

Parameters:

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

adapter - Virtual SATA adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

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

delete

public void delete(java.lang.String vm,
                   java.lang.String adapter,
                   AsyncCallback<java.lang.Void> asyncCallback,
                   InvocationConfig invocationConfig)

Description copied from interface: Sata

Removes a virtual SATA adapter from 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.
NotAllowedInCurrentState - if the virtual machine is suspended
NotFound - if the virtual machine or virtual SATA adapter is not found.
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 Sata

Parameters:

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

adapter - Virtual SATA adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

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

invocationConfig - Configuration for the method invocation.