com.vmware.vcenter.vm.hardware.adapter

Class NvmeStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.vm.hardware.adapter.NvmeStub

All Implemented Interfaces:

Service, Nvme, NvmeTypes

public class NvmeStub
extends com.vmware.vapi.internal.bindings.Stub
implements Nvme

Remote stub implementation of the Nvme 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.NvmeTypes

NvmeTypes.CreateSpec, NvmeTypes.Info, NvmeTypes.Summary

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.NvmeTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Constructor Summary

Constructors

Constructor and Description
NvmeStub(ApiProvider apiProvider, StubConfigurationBase config)
NvmeStub(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, NvmeTypes.CreateSpec spec) Adds a virtual NVMe adapter to the virtual machine.
void	create(java.lang.String vm, NvmeTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Adds a virtual NVMe adapter to the virtual machine.
void	create(java.lang.String vm, NvmeTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Adds a virtual NVMe adapter to the virtual machine.
java.lang.String	create(java.lang.String vm, NvmeTypes.CreateSpec spec, InvocationConfig invocationConfig) Adds a virtual NVMe adapter to the virtual machine.
void	delete(java.lang.String vm, java.lang.String adapter) Removes a virtual NVMe adapter from the virtual machine.
void	delete(java.lang.String vm, java.lang.String adapter, AsyncCallback<java.lang.Void> asyncCallback) Removes a virtual NVMe 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 NVMe adapter from the virtual machine.
void	delete(java.lang.String vm, java.lang.String adapter, InvocationConfig invocationConfig) Removes a virtual NVMe adapter from the virtual machine.
NvmeTypes.Info	get(java.lang.String vm, java.lang.String adapter) Returns information about a virtual NVMe adapter.
void	get(java.lang.String vm, java.lang.String adapter, AsyncCallback<NvmeTypes.Info> asyncCallback) Returns information about a virtual NVMe adapter.
void	get(java.lang.String vm, java.lang.String adapter, AsyncCallback<NvmeTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about a virtual NVMe adapter.
NvmeTypes.Info	get(java.lang.String vm, java.lang.String adapter, InvocationConfig invocationConfig) Returns information about a virtual NVMe adapter.
java.util.List<NvmeTypes.Summary>	list(java.lang.String vm) Returns commonly used information about the virtual NVMe adapters belonging to the virtual machine.
void	list(java.lang.String vm, AsyncCallback<java.util.List<NvmeTypes.Summary>> asyncCallback) Returns commonly used information about the virtual NVMe adapters belonging to the virtual machine.
void	list(java.lang.String vm, AsyncCallback<java.util.List<NvmeTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns commonly used information about the virtual NVMe adapters belonging to the virtual machine.
java.util.List<NvmeTypes.Summary>	list(java.lang.String vm, InvocationConfig invocationConfig) Returns commonly used information about the virtual NVMe 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

NvmeStub

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

NvmeStub

public NvmeStub(ApiProvider apiProvider,
                StubConfigurationBase config)

Method Detail

list

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

Description copied from interface: Nvme

Returns commonly used information about the virtual NVMe adapters belonging to the virtual machine. This method was added in vSphere API 7.0.0.1.

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

Specified by:

list in interface Nvme

Parameters:

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

Returns:

List of commonly used information about virtual NVMe adapters.

list

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

Description copied from interface: Nvme

Returns commonly used information about the virtual NVMe adapters belonging to the virtual machine. This method was added in vSphere API 7.0.0.1.

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 Nvme

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 NVMe adapters.

list

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

Description copied from interface: Nvme

Returns commonly used information about the virtual NVMe adapters belonging to the virtual machine. This method was added in vSphere API 7.0.0.1.

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

Invocation Result:
List of commonly used information about virtual NVMe 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 Nvme

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<NvmeTypes.Summary>> asyncCallback,
                 InvocationConfig invocationConfig)

Description copied from interface: Nvme

Returns commonly used information about the virtual NVMe adapters belonging to the virtual machine. This method was added in vSphere API 7.0.0.1.

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 NVMe 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 Nvme

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

Description copied from interface: Nvme

Returns information about a virtual NVMe adapter. This method was added in vSphere API 7.0.0.1.

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

Specified by:

get in interface Nvme

Parameters:

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

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

Returns:

Information about the specified virtual NVMe adapter.

get

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

Description copied from interface: Nvme

Returns information about a virtual NVMe adapter. This method was added in vSphere API 7.0.0.1.

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 Nvme

Parameters:

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

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

invocationConfig - Configuration for the method invocation.

Returns:

Information about the specified virtual NVMe adapter.

get

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

Description copied from interface: Nvme

Returns information about a virtual NVMe adapter. This method was added in vSphere API 7.0.0.1.

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

Invocation Result:
Information about the specified virtual NVMe adapter.

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

Parameters:

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

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

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<NvmeTypes.Info> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Nvme

Returns information about a virtual NVMe adapter. This method was added in vSphere API 7.0.0.1.

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 NVMe adapter.

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

Parameters:

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

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

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,
                               NvmeTypes.CreateSpec spec)

Description copied from interface: Nvme

Adds a virtual NVMe adapter to the virtual machine. This method was added in vSphere API 7.0.0.1.

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

Specified by:

create in interface Nvme

Parameters:

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

spec - Specification for the new virtual NVMe adapter.

Returns:

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

create

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

Description copied from interface: Nvme

Adds a virtual NVMe adapter to the virtual machine. This method was added in vSphere API 7.0.0.1.

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 Nvme

Parameters:

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

spec - Specification for the new virtual NVMe adapter.

invocationConfig - Configuration for the method invocation.

Returns:

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

create

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

Description copied from interface: Nvme

Adds a virtual NVMe adapter to the virtual machine. This method was added in vSphere API 7.0.0.1.

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

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

Operation Errors:
Error - if the system reports an error while responding to the request.
Error - if the system reported that the NVMe 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 NVMe buses on the virtual machine.
ResourceInUse - if the specified NVMe bus or PCI address is in use.
InvalidArgument - if the specified NVMe 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 Nvme

Parameters:

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

spec - Specification for the new virtual NVMe adapter.

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

create

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

Description copied from interface: Nvme

Adds a virtual NVMe adapter to the virtual machine. This method was added in vSphere API 7.0.0.1.

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

Operation Errors:
Error - if the system reports an error while responding to the request.
Error - if the system reported that the NVMe 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 NVMe buses on the virtual machine.
ResourceInUse - if the specified NVMe bus or PCI address is in use.
InvalidArgument - if the specified NVMe 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 Nvme

Parameters:

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

spec - Specification for the new virtual NVMe 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: Nvme

Removes a virtual NVMe adapter from the virtual machine. This method was added in vSphere API 7.0.0.1.

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

Specified by:

delete in interface Nvme

Parameters:

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

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

delete

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

Description copied from interface: Nvme

Removes a virtual NVMe adapter from the virtual machine. This method was added in vSphere API 7.0.0.1.

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 Nvme

Parameters:

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

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

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: Nvme

Removes a virtual NVMe adapter from the virtual machine. This method was added in vSphere API 7.0.0.1.

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 NVMe 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 Nvme

Parameters:

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

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

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: Nvme

Removes a virtual NVMe adapter from the virtual machine. This method was added in vSphere API 7.0.0.1.

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 NVMe 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 Nvme

Parameters:

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

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

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

invocationConfig - Configuration for the method invocation.