com.vmware.vcenter

Class ResourcePoolStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.ResourcePoolStub

All Implemented Interfaces:

Service, ResourcePool, ResourcePoolTypes

public class ResourcePoolStub
extends com.vmware.vapi.internal.bindings.Stub
implements ResourcePool

Remote stub implementation of the ResourcePool API service.

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.ResourcePoolTypes

ResourcePoolTypes.CreateSpec, ResourcePoolTypes.FilterSpec, ResourcePoolTypes.Info, ResourcePoolTypes.ResourceAllocationCreateSpec, ResourcePoolTypes.ResourceAllocationInfo, ResourcePoolTypes.ResourceAllocationUpdateSpec, ResourcePoolTypes.SharesInfo, ResourcePoolTypes.Summary, ResourcePoolTypes.UpdateSpec

Field Summary

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

apiProvider, converter, ifaceId, securityContext

Fields inherited from interface com.vmware.vcenter.ResourcePoolTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	create(ResourcePoolTypes.CreateSpec spec) Creates a resource pool.
void	create(ResourcePoolTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Creates a resource pool.
void	create(ResourcePoolTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Creates a resource pool.
java.lang.String	create(ResourcePoolTypes.CreateSpec spec, InvocationConfig invocationConfig) Creates a resource pool.
void	delete(java.lang.String resourcePool) Deletes a resource pool.
void	delete(java.lang.String resourcePool, AsyncCallback<java.lang.Void> asyncCallback) Deletes a resource pool.
void	delete(java.lang.String resourcePool, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deletes a resource pool.
void	delete(java.lang.String resourcePool, InvocationConfig invocationConfig) Deletes a resource pool.
ResourcePoolTypes.Info	get(java.lang.String resourcePool) Retrieves information about the resource pool indicated by resourcePool.
void	get(java.lang.String resourcePool, AsyncCallback<ResourcePoolTypes.Info> asyncCallback) Retrieves information about the resource pool indicated by resourcePool.
void	get(java.lang.String resourcePool, AsyncCallback<ResourcePoolTypes.Info> asyncCallback, InvocationConfig invocationConfig) Retrieves information about the resource pool indicated by resourcePool.
ResourcePoolTypes.Info	get(java.lang.String resourcePool, InvocationConfig invocationConfig) Retrieves information about the resource pool indicated by resourcePool.
java.util.List<ResourcePoolTypes.Summary>	list(ResourcePoolTypes.FilterSpec filter) Returns information about at most 1000 visible (subject to permission checks) resource pools in vCenter matching the ResourcePoolTypes.FilterSpec.
void	list(ResourcePoolTypes.FilterSpec filter, AsyncCallback<java.util.List<ResourcePoolTypes.Summary>> asyncCallback) Returns information about at most 1000 visible (subject to permission checks) resource pools in vCenter matching the ResourcePoolTypes.FilterSpec.
void	list(ResourcePoolTypes.FilterSpec filter, AsyncCallback<java.util.List<ResourcePoolTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns information about at most 1000 visible (subject to permission checks) resource pools in vCenter matching the ResourcePoolTypes.FilterSpec.
java.util.List<ResourcePoolTypes.Summary>	list(ResourcePoolTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns information about at most 1000 visible (subject to permission checks) resource pools in vCenter matching the ResourcePoolTypes.FilterSpec.
void	update(java.lang.String resourcePool, ResourcePoolTypes.UpdateSpec spec) Updates the configuration of a resource pool.
void	update(java.lang.String resourcePool, ResourcePoolTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Updates the configuration of a resource pool.
void	update(java.lang.String resourcePool, ResourcePoolTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Updates the configuration of a resource pool.
void	update(java.lang.String resourcePool, ResourcePoolTypes.UpdateSpec spec, InvocationConfig invocationConfig) Updates the configuration of a resource pool.

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

ResourcePoolStub

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

ResourcePoolStub

public ResourcePoolStub(ApiProvider apiProvider,
                        StubConfigurationBase config)

Method Detail

get

public ResourcePoolTypes.Info get(java.lang.String resourcePool)

Description copied from interface: ResourcePool

Retrieves information about the resource pool indicated by resourcePool.

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

Specified by:

get in interface ResourcePool

Parameters:

resourcePool - Identifier of the resource pool for which information should be retrieved. The parameter must be an identifier for the resource type: ResourcePool.

Returns:

Information about the resource pool.

get

public ResourcePoolTypes.Info get(java.lang.String resourcePool,
                                  InvocationConfig invocationConfig)

Description copied from interface: ResourcePool

Retrieves information about the resource pool indicated by resourcePool.

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 ResourcePool

Parameters:

resourcePool - Identifier of the resource pool for which information should be retrieved. The parameter must be an identifier for the resource type: ResourcePool.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the resource pool.

get

public void get(java.lang.String resourcePool,
                AsyncCallback<ResourcePoolTypes.Info> asyncCallback)

Description copied from interface: ResourcePool

Retrieves information about the resource pool indicated by resourcePool.

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

Invocation Result:
Information about the resource pool.

Operation Errors:
NotFound - If the resource pool indicated by resourcePool does not exist.
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.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource ResourcePool referenced by the parameter resourcePool requires System.Read.

Specified by:

get in interface ResourcePool

Parameters:

resourcePool - Identifier of the resource pool for which information should be retrieved. The parameter must be an identifier for the resource type: ResourcePool.

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

get

public void get(java.lang.String resourcePool,
                AsyncCallback<ResourcePoolTypes.Info> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: ResourcePool

Retrieves information about the resource pool indicated by resourcePool.

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 resource pool.

Operation Errors:
NotFound - If the resource pool indicated by resourcePool does not exist.
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.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource ResourcePool referenced by the parameter resourcePool requires System.Read.

Specified by:

get in interface ResourcePool

Parameters:

resourcePool - Identifier of the resource pool for which information should be retrieved. The parameter must be an identifier for the resource type: ResourcePool.

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

invocationConfig - Configuration for the method invocation.

list

public java.util.List<ResourcePoolTypes.Summary> list(ResourcePoolTypes.FilterSpec filter)

Description copied from interface: ResourcePool

Returns information about at most 1000 visible (subject to permission checks) resource pools in vCenter matching the ResourcePoolTypes.FilterSpec.

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

Specified by:

list in interface ResourcePool

Parameters:

filter - Specification of matching resource pools for which information should be returned. If null, the behavior is equivalent to a ResourcePoolTypes.FilterSpec with all properties null which means all resource pools match the filter.

Returns:

Commonly used information about the resource pools matching the ResourcePoolTypes.FilterSpec.

list

public java.util.List<ResourcePoolTypes.Summary> list(ResourcePoolTypes.FilterSpec filter,
                                                      InvocationConfig invocationConfig)

Description copied from interface: ResourcePool

Returns information about at most 1000 visible (subject to permission checks) resource pools in vCenter matching the ResourcePoolTypes.FilterSpec.

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 ResourcePool

Parameters:

filter - Specification of matching resource pools for which information should be returned. If null, the behavior is equivalent to a ResourcePoolTypes.FilterSpec with all properties null which means all resource pools match the filter.

invocationConfig - Configuration for the method invocation.

Returns:

Commonly used information about the resource pools matching the ResourcePoolTypes.FilterSpec.

list

public void list(ResourcePoolTypes.FilterSpec filter,
                 AsyncCallback<java.util.List<ResourcePoolTypes.Summary>> asyncCallback)

Description copied from interface: ResourcePool

Returns information about at most 1000 visible (subject to permission checks) resource pools in vCenter matching the ResourcePoolTypes.FilterSpec.

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

Invocation Result:
Commonly used information about the resource pools matching the ResourcePoolTypes.FilterSpec.

Operation Errors:
UnableToAllocateResource - If more than 1000 resource pools match the ResourcePoolTypes.FilterSpec.
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 ResourcePool

Parameters:

filter - Specification of matching resource pools for which information should be returned. If null, the behavior is equivalent to a ResourcePoolTypes.FilterSpec with all properties null which means all resource pools match the filter.

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

list

public void list(ResourcePoolTypes.FilterSpec filter,
                 AsyncCallback<java.util.List<ResourcePoolTypes.Summary>> asyncCallback,
                 InvocationConfig invocationConfig)

Description copied from interface: ResourcePool

Returns information about at most 1000 visible (subject to permission checks) resource pools in vCenter matching the ResourcePoolTypes.FilterSpec.

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:
Commonly used information about the resource pools matching the ResourcePoolTypes.FilterSpec.

Operation Errors:
UnableToAllocateResource - If more than 1000 resource pools match the ResourcePoolTypes.FilterSpec.
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 ResourcePool

Parameters:

filter - Specification of matching resource pools for which information should be returned. If null, the behavior is equivalent to a ResourcePoolTypes.FilterSpec with all properties null which means all resource pools match the filter.

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

invocationConfig - Configuration for the method invocation.

create

public java.lang.String create(ResourcePoolTypes.CreateSpec spec)

Description copied from interface: ResourcePool

Creates a resource pool. This method was added in vSphere API 7.0.0.

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

Specified by:

create in interface ResourcePool

Parameters:

spec - Specification of the new resource pool to be created, see ResourcePoolTypes.CreateSpec.

Returns:

The identifier of the newly created resource pool. The return value will be an identifier for the resource type: ResourcePool.

create

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

Description copied from interface: ResourcePool

Creates a resource pool. This method was added in vSphere API 7.0.0.

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 ResourcePool

Parameters:

spec - Specification of the new resource pool to be created, see ResourcePoolTypes.CreateSpec.

invocationConfig - Configuration for the method invocation.

Returns:

The identifier of the newly created resource pool. The return value will be an identifier for the resource type: ResourcePool.

create

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

Description copied from interface: ResourcePool

Creates a resource pool. This method was added in vSphere API 7.0.0.

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

Invocation Result:
The identifier of the newly created resource pool. The return value will be an identifier for the resource type: ResourcePool.

Operation Errors:
Error - If the system reports an error while responding to the request.
InvalidArgument - If a parameter passed in the spec is invalid.
NotFound - If the resource specified in parent could not be found
ResourceInaccessible - If the specified resource in parent is not accessible.
ServiceUnavailable - If the system is unable to communicate with a service to complete the request.
UnableToAllocateResource - if any of the resources needed to create the resource pool could not be allocated.
Unauthenticated - If the user can not be authenticated.
Unauthorized - If the user doesn't have the required privileges.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource ResourcePool referenced by the property ResourcePoolTypes.CreateSpec.getParent() requires Resource.CreatePool.

Specified by:

create in interface ResourcePool

Parameters:

spec - Specification of the new resource pool to be created, see ResourcePoolTypes.CreateSpec.

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

create

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

Description copied from interface: ResourcePool

Creates a resource pool. This method was added in vSphere API 7.0.0.

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:
The identifier of the newly created resource pool. The return value will be an identifier for the resource type: ResourcePool.

Operation Errors:
Error - If the system reports an error while responding to the request.
InvalidArgument - If a parameter passed in the spec is invalid.
NotFound - If the resource specified in parent could not be found
ResourceInaccessible - If the specified resource in parent is not accessible.
ServiceUnavailable - If the system is unable to communicate with a service to complete the request.
UnableToAllocateResource - if any of the resources needed to create the resource pool could not be allocated.
Unauthenticated - If the user can not be authenticated.
Unauthorized - If the user doesn't have the required privileges.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource ResourcePool referenced by the property ResourcePoolTypes.CreateSpec.getParent() requires Resource.CreatePool.

Specified by:

create in interface ResourcePool

Parameters:

spec - Specification of the new resource pool to be created, see ResourcePoolTypes.CreateSpec.

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 resourcePool)

Description copied from interface: ResourcePool

Deletes a resource pool. This method was added in vSphere API 7.0.0.

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

Specified by:

delete in interface ResourcePool

Parameters:

resourcePool - Identifier of the resource pool to be deleted. The parameter must be an identifier for the resource type: ResourcePool.

delete

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

Description copied from interface: ResourcePool

Deletes a resource pool. This method was added in vSphere API 7.0.0.

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 ResourcePool

Parameters:

resourcePool - Identifier of the resource pool to be deleted. The parameter must be an identifier for the resource type: ResourcePool.

invocationConfig - Configuration for the method invocation.

delete

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

Description copied from interface: ResourcePool

Deletes a resource pool. This method was added in vSphere API 7.0.0.

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 resource pool is not found.
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 resource pool is a root resource pool.

Specified by:

delete in interface ResourcePool

Parameters:

resourcePool - Identifier of the resource pool to be deleted. The parameter must be an identifier for the resource type: ResourcePool.

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

delete

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

Description copied from interface: ResourcePool

Deletes a resource pool. This method was added in vSphere API 7.0.0.

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 resource pool is not found.
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 resource pool is a root resource pool.

Specified by:

delete in interface ResourcePool

Parameters:

resourcePool - Identifier of the resource pool to be deleted. The parameter must be an identifier for the resource type: ResourcePool.

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

invocationConfig - Configuration for the method invocation.

update

public void update(java.lang.String resourcePool,
                   ResourcePoolTypes.UpdateSpec spec)

Description copied from interface: ResourcePool

Updates the configuration of a resource pool. This method was added in vSphere API 7.0.0.

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

Specified by:

update in interface ResourcePool

Parameters:

resourcePool - Identifier of the resource pool. The parameter must be an identifier for the resource type: ResourcePool.

spec - Specification for updating the configuration of the resource pool.

update

public void update(java.lang.String resourcePool,
                   ResourcePoolTypes.UpdateSpec spec,
                   InvocationConfig invocationConfig)

Description copied from interface: ResourcePool

Updates the configuration of a resource pool. This method was added in vSphere API 7.0.0.

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 ResourcePool

Parameters:

resourcePool - Identifier of the resource pool. The parameter must be an identifier for the resource type: ResourcePool.

spec - Specification for updating the configuration of the resource pool.

invocationConfig - Configuration for the method invocation.

update

public void update(java.lang.String resourcePool,
                   ResourcePoolTypes.UpdateSpec spec,
                   AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: ResourcePool

Updates the configuration of a resource pool. This method was added in vSphere API 7.0.0.

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.
InvalidArgument - If any of the specified parameters is invalid.
NotFound - If the resource pool is not found.
ServiceUnavailable - If the system is unable to communicate with a service to complete the request.
UnableToAllocateResource - If any of the resources needed to reconfigure the resource pool could not be allocated.
Unauthenticated - If the user can not be authenticated.
Unauthorized - If the user doesn't have the required privileges.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource ResourcePool referenced by the parameter resourcePool requires Resource.EditPool.

Specified by:

update in interface ResourcePool

Parameters:

resourcePool - Identifier of the resource pool. The parameter must be an identifier for the resource type: ResourcePool.

spec - Specification for updating the configuration of the resource pool.

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

update

public void update(java.lang.String resourcePool,
                   ResourcePoolTypes.UpdateSpec spec,
                   AsyncCallback<java.lang.Void> asyncCallback,
                   InvocationConfig invocationConfig)

Description copied from interface: ResourcePool

Updates the configuration of a resource pool. This method was added in vSphere API 7.0.0.

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.
InvalidArgument - If any of the specified parameters is invalid.
NotFound - If the resource pool is not found.
ServiceUnavailable - If the system is unable to communicate with a service to complete the request.
UnableToAllocateResource - If any of the resources needed to reconfigure the resource pool could not be allocated.
Unauthenticated - If the user can not be authenticated.
Unauthorized - If the user doesn't have the required privileges.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource ResourcePool referenced by the parameter resourcePool requires Resource.EditPool.

Specified by:

update in interface ResourcePool

Parameters:

resourcePool - Identifier of the resource pool. The parameter must be an identifier for the resource type: ResourcePool.

spec - Specification for updating the configuration of the resource pool.

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

invocationConfig - Configuration for the method invocation.