com.vmware.vcenter.storage.policies

Class VMStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.storage.policies.VMStub

All Implemented Interfaces:

Service, VM, VMTypes

public class VMStub
extends com.vmware.vapi.internal.bindings.Stub
implements VM

Remote stub implementation of the VM API service.

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.storage.policies.VMTypes

VMTypes.Info

Field Summary

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

apiProvider, converter, ifaceId, securityContext

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,VMTypes.Info>	list(java.lang.String policy) Returns information about the virtual machines and/or their virtual disks that are associated with the given storage policy.
void	list(java.lang.String policy, AsyncCallback<java.util.Map<java.lang.String,VMTypes.Info>> asyncCallback) Returns information about the virtual machines and/or their virtual disks that are associated with the given storage policy.
void	list(java.lang.String policy, AsyncCallback<java.util.Map<java.lang.String,VMTypes.Info>> asyncCallback, InvocationConfig invocationConfig) Returns information about the virtual machines and/or their virtual disks that are associated with the given storage policy.
java.util.Map<java.lang.String,VMTypes.Info>	list(java.lang.String policy, InvocationConfig invocationConfig) Returns information about the virtual machines and/or their virtual disks that are associated with the given storage policy.

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

VMStub

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

VMStub

public VMStub(ApiProvider apiProvider,
      StubConfigurationBase config)

Method Detail

list

public java.util.Map<java.lang.String,VMTypes.Info> list(java.lang.String policy)

Description copied from interface: VM

Returns information about the virtual machines and/or their virtual disks that are associated with the given storage policy. This method was added in vSphere API 6.7.

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

Specified by:

list in interface VM

Parameters:

policy - storage policy identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.StoragePolicy.

Returns:

Information about the virtual machines and/or their virtual disks that are associated with the given storage policy. The key in the return value Map will be an identifier for the resource type: VirtualMachine.

list

public java.util.Map<java.lang.String,VMTypes.Info> list(java.lang.String policy,
                                                InvocationConfig invocationConfig)

Description copied from interface: VM

Returns information about the virtual machines and/or their virtual disks that are associated with the given storage policy. This method was added in vSphere API 6.7.

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 VM

Parameters:

policy - storage policy identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.StoragePolicy.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the virtual machines and/or their virtual disks that are associated with the given storage policy. The key in the return value Map will be an identifier for the resource type: VirtualMachine.

list

public void list(java.lang.String policy,
        AsyncCallback<java.util.Map<java.lang.String,VMTypes.Info>> asyncCallback)

Description copied from interface: VM

Returns information about the virtual machines and/or their virtual disks that are associated with the given storage policy. This method was added in vSphere API 6.7.

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

Operation Result:
Information about the virtual machines and/or their virtual disks that are associated with the given storage policy. The key in the return value Map will be an identifier for the resource type: VirtualMachine.

Operation Errors:
NotFound - if there is no policy associated with policy in the system.
UnableToAllocateResource - if more than 1000 virtual machines are associated with the specified policy.
Unauthenticated - if the user cannot be authenticated.
ServiceUnavailable - if the system is unable to communicate with a service necessary to complete the request.
Error - if the backend server encounters some an error while processing the request.
Unauthorized - if the user does not have the required priveleges.

Specified by:

list in interface VM

Parameters:

policy - storage policy identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.StoragePolicy.

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

list

public void list(java.lang.String policy,
        AsyncCallback<java.util.Map<java.lang.String,VMTypes.Info>> asyncCallback,
        InvocationConfig invocationConfig)

Description copied from interface: VM

Returns information about the virtual machines and/or their virtual disks that are associated with the given storage policy. This method was added in vSphere API 6.7.

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 virtual machines and/or their virtual disks that are associated with the given storage policy. The key in the return value Map will be an identifier for the resource type: VirtualMachine.

Operation Errors:
NotFound - if there is no policy associated with policy in the system.
UnableToAllocateResource - if more than 1000 virtual machines are associated with the specified policy.
Unauthenticated - if the user cannot be authenticated.
ServiceUnavailable - if the system is unable to communicate with a service necessary to complete the request.
Error - if the backend server encounters some an error while processing the request.
Unauthorized - if the user does not have the required priveleges.

Specified by:

list in interface VM

Parameters:

policy - storage policy identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.StoragePolicy.

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

invocationConfig - Configuration for the method invocation.