com.vmware.vcenter

Interface ResourcePool

All Superinterfaces:

ResourcePoolTypes, Service

All Known Implementing Classes:

ResourcePoolStub

public interface ResourcePool
extends Service, ResourcePoolTypes

The ResourcePool interface provides methods for manipulating a vCenter Server resource pool.

This interface does not include virtual appliances in the inventory of resource pools even though part of the behavior of a virtual appliance is to act like a resource pool.

Nested Class Summary

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

ResourcePoolTypes.FilterSpec, ResourcePoolTypes.Info, ResourcePoolTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vcenter.ResourcePoolTypes

RESOURCE_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
ResourcePoolTypes.Info	get(String resourcePool) Retrieves information about the resource pool indicated by resourcePool.
void	get(String resourcePool, AsyncCallback<ResourcePoolTypes.Info> asyncCallback) Retrieves information about the resource pool indicated by resourcePool.
void	get(String resourcePool, AsyncCallback<ResourcePoolTypes.Info> asyncCallback, InvocationConfig invocationConfig) Retrieves information about the resource pool indicated by resourcePool.
ResourcePoolTypes.Info	get(String resourcePool, InvocationConfig invocationConfig) Retrieves information about the resource pool indicated by resourcePool.
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<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<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.
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.

Method Detail

get

ResourcePoolTypes.Info get(String 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.

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.

Throws:

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.

get

ResourcePoolTypes.Info get(String resourcePool,
                         InvocationConfig invocationConfig)

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.

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.

Throws:

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.

get

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

Retrieves information about the resource pool indicated by resourcePool.

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

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

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

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

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.

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

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

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.

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

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.

Throws:

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.

list

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.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

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.

Throws:

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.

list

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

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.

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

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

void list(ResourcePoolTypes.FilterSpec filter,
        AsyncCallback<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.

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

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.