com.vmware.vcenter

Class ClusterStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.ClusterStub

All Implemented Interfaces:

Service, Cluster, ClusterTypes

public class ClusterStub
extends com.vmware.vapi.internal.bindings.Stub
implements Cluster

Remote stub implementation of the Cluster API service.

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

Nested Class Summary

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

ClusterTypes.FilterSpec, ClusterTypes.Info, ClusterTypes.Summary

Field Summary

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

apiProvider, converter, ifaceId, securityContext

Fields inherited from interface com.vmware.vcenter.ClusterTypes

RESOURCE_TYPE

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
ClusterTypes.Info	get(java.lang.String cluster) Retrieves information about the cluster corresponding to cluster.
void	get(java.lang.String cluster, AsyncCallback<ClusterTypes.Info> asyncCallback) Retrieves information about the cluster corresponding to cluster.
void	get(java.lang.String cluster, AsyncCallback<ClusterTypes.Info> asyncCallback, InvocationConfig invocationConfig) Retrieves information about the cluster corresponding to cluster.
ClusterTypes.Info	get(java.lang.String cluster, InvocationConfig invocationConfig) Retrieves information about the cluster corresponding to cluster.
java.util.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<java.util.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<java.util.List<ClusterTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the ClusterTypes.FilterSpec.
java.util.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.

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

ClusterStub

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

ClusterStub

public ClusterStub(ApiProvider apiProvider,
           StubConfigurationBase config)

Method Detail

list

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

Description copied from interface: Cluster

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.

Specified by:

list in interface Cluster

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.

list

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

Description copied from interface: Cluster

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.

Specified by:

list in interface Cluster

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.

list

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

Description copied from interface: Cluster

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.

Specified by:

list in interface Cluster

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

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

Description copied from interface: Cluster

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.

Specified by:

list in interface Cluster

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

public ClusterTypes.Info get(java.lang.String cluster)

Description copied from interface: Cluster

Retrieves information about the cluster corresponding to cluster.

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

Specified by:

get in interface Cluster

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.

get

public ClusterTypes.Info get(java.lang.String cluster,
                    InvocationConfig invocationConfig)

Description copied from interface: Cluster

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.

Specified by:

get in interface Cluster

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.

get

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

Description copied from interface: Cluster

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.

Specified by:

get in interface Cluster

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

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

Description copied from interface: Cluster

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.

Specified by:

get in interface Cluster

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.