com.vmware.vcenter

Interface Cluster

All Superinterfaces:

ClusterTypes, Service

All Known Implementing Classes:

ClusterStub

public interface Cluster
extends Service, ClusterTypes

The Cluster interface provides methods to manage clusters in the vCenter Server.

Nested Class Summary

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

ClusterTypes.FilterSpec, ClusterTypes.Info, ClusterTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vcenter.ClusterTypes

RESOURCE_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
ClusterTypes.Info	get(String cluster) Retrieves information about the cluster corresponding to cluster.
void	get(String cluster, AsyncCallback<ClusterTypes.Info> asyncCallback) Retrieves information about the cluster corresponding to cluster.
void	get(String cluster, AsyncCallback<ClusterTypes.Info> asyncCallback, InvocationConfig invocationConfig) Retrieves information about the cluster corresponding to cluster.
ClusterTypes.Info	get(String cluster, InvocationConfig invocationConfig) Retrieves information about the cluster corresponding to cluster.
List<ClusterTypes.Summary>	list(ClusterTypes.FilterSpec filter) Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the ClusterTypes.FilterSpec.
void	list(ClusterTypes.FilterSpec filter, AsyncCallback<List<ClusterTypes.Summary>> asyncCallback) Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the ClusterTypes.FilterSpec.
void	list(ClusterTypes.FilterSpec filter, AsyncCallback<List<ClusterTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the ClusterTypes.FilterSpec.
List<ClusterTypes.Summary>	list(ClusterTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the ClusterTypes.FilterSpec.

Method Detail

list

List<ClusterTypes.Summary> list(ClusterTypes.FilterSpec filter)

Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the ClusterTypes.FilterSpec.

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

Parameters:

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

Returns:

Commonly used information about the clusters matching the ClusterTypes.FilterSpec.

Throws:

UnableToAllocateResource - if more than 1000 clusters match the ClusterTypes.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<ClusterTypes.Summary> list(ClusterTypes.FilterSpec filter,
                              InvocationConfig invocationConfig)

Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the ClusterTypes.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 clusters for which information should be returned. If null, the behavior is equivalent to a ClusterTypes.FilterSpec with all properties null which means all clusters match the filter.

invocationConfig - Configuration for the method invocation.

Returns:

Commonly used information about the clusters matching the ClusterTypes.FilterSpec.

Throws:

UnableToAllocateResource - if more than 1000 clusters match the ClusterTypes.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(ClusterTypes.FilterSpec filter,
        AsyncCallback<List<ClusterTypes.Summary>> asyncCallback)

Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the ClusterTypes.FilterSpec.

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

Operation Result:
Commonly used information about the clusters matching the ClusterTypes.FilterSpec.

Operation Errors:
UnableToAllocateResource - if more than 1000 clusters match the ClusterTypes.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 clusters for which information should be returned. If null, the behavior is equivalent to a ClusterTypes.FilterSpec with all properties null which means all clusters match the filter.

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

list

void list(ClusterTypes.FilterSpec filter,
        AsyncCallback<List<ClusterTypes.Summary>> asyncCallback,
        InvocationConfig invocationConfig)

Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the ClusterTypes.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 clusters matching the ClusterTypes.FilterSpec.

Operation Errors:
UnableToAllocateResource - if more than 1000 clusters match the ClusterTypes.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 clusters for which information should be returned. If null, the behavior is equivalent to a ClusterTypes.FilterSpec with all properties null which means all clusters match the filter.

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

invocationConfig - Configuration for the method invocation.

get

ClusterTypes.Info get(String cluster)

Retrieves information about the cluster corresponding to cluster.

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

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

The ClusterTypes.Info instances that corresponds to the cluster.

Throws:

NotFound - if there is no cluster associated with cluster in the system.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the session id is missing from the request or the corresponding session object cannot be found.

Unauthorized - if the user doesn't not have the required privileges.

get

ClusterTypes.Info get(String cluster,
                    InvocationConfig invocationConfig)

Retrieves information about the cluster corresponding to cluster.

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:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

The ClusterTypes.Info instances that corresponds to the cluster.

Throws:

NotFound - if there is no cluster associated with cluster in the system.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the session id is missing from the request or the corresponding session object cannot be found.

Unauthorized - if the user doesn't not have the required privileges.

get

void get(String cluster,
       AsyncCallback<ClusterTypes.Info> asyncCallback)

Retrieves information about the cluster corresponding to cluster.

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

Operation Result:
The ClusterTypes.Info instances that corresponds to the cluster.

Operation Errors:
NotFound - if there is no cluster associated with cluster in the system.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the session id is missing from the request or the corresponding session object cannot be found.
Unauthorized - if the user doesn't not have the required privileges.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

get

void get(String cluster,
       AsyncCallback<ClusterTypes.Info> asyncCallback,
       InvocationConfig invocationConfig)

Retrieves information about the cluster corresponding to cluster.

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:
The ClusterTypes.Info instances that corresponds to the cluster.

Operation Errors:
NotFound - if there is no cluster associated with cluster in the system.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the session id is missing from the request or the corresponding session object cannot be found.
Unauthorized - if the user doesn't not have the required privileges.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

invocationConfig - Configuration for the method invocation.