com.vmware.vcenter.consumption_domains.zone_associations

Interface Cluster

All Superinterfaces:

ClusterTypes, Service

All Known Implementing Classes:

ClusterStub

public interface Cluster
extends Service, ClusterTypes

The CLUSTER interface provides methods to query zone-cluster associations. This interface was added in vSphere API 8.0.0.1.

Nested Class Summary

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

ClusterTypes.FilterSpec, ClusterTypes.ListItem, ClusterTypes.ListResult

Field Summary

Fields inherited from interface com.vmware.vcenter.consumption_domains.zone_associations.ClusterTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ClusterTypes.ListResult	list(ClusterTypes.FilterSpec filter) Returns zone-cluster associations that match the specified filter.
void	list(ClusterTypes.FilterSpec filter, AsyncCallback<ClusterTypes.ListResult> asyncCallback) Returns zone-cluster associations that match the specified filter.
void	list(ClusterTypes.FilterSpec filter, AsyncCallback<ClusterTypes.ListResult> asyncCallback, InvocationConfig invocationConfig) Returns zone-cluster associations that match the specified filter.
ClusterTypes.ListResult	list(ClusterTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns zone-cluster associations that match the specified filter.

Method Detail

list

ClusterTypes.ListResult list(ClusterTypes.FilterSpec filter)

Returns zone-cluster associations that match the specified filter. This method was added in vSphere API 8.0.0.1.

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

Parameters:

filter - The specification of matching zone-cluster associations. If null, the behavior is equivalent to a ClusterTypes.FilterSpec with all properties null, which means all the zone-cluster associations will be returned.

Returns:

Zone-cluster associations matching the ClusterTypes.FilterSpec.

Throws:

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have all of the privileges described as follows: - The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zones in FilterSpec requires System.Read privilege.

Error - when unexpected error is encountered.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

list

ClusterTypes.ListResult list(ClusterTypes.FilterSpec filter,
                             InvocationConfig invocationConfig)

Returns zone-cluster associations that match the specified filter. This method was added in vSphere API 8.0.0.1.

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 - The specification of matching zone-cluster associations. If null, the behavior is equivalent to a ClusterTypes.FilterSpec with all properties null, which means all the zone-cluster associations will be returned.

invocationConfig - Configuration for the method invocation.

Returns:

Zone-cluster associations matching the ClusterTypes.FilterSpec.

Throws:

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have all of the privileges described as follows: - The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zones in FilterSpec requires System.Read privilege.

Error - when unexpected error is encountered.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

list

void list(ClusterTypes.FilterSpec filter,
          AsyncCallback<ClusterTypes.ListResult> asyncCallback)

Returns zone-cluster associations that match the specified filter. This method was added in vSphere API 8.0.0.1.

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

Invocation Result:
Zone-cluster associations matching the ClusterTypes.FilterSpec.

Operation Errors:
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have all of the privileges described as follows: - The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zones in FilterSpec requires System.Read privilege.
Error - when unexpected error is encountered.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Parameters:

filter - The specification of matching zone-cluster associations. If null, the behavior is equivalent to a ClusterTypes.FilterSpec with all properties null, which means all the zone-cluster associations will be returned.

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

list

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

Returns zone-cluster associations that match the specified filter. This method was added in vSphere API 8.0.0.1.

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:
Zone-cluster associations matching the ClusterTypes.FilterSpec.

Operation Errors:
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have all of the privileges described as follows: - The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zones in FilterSpec requires System.Read privilege.
Error - when unexpected error is encountered.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Parameters:

filter - The specification of matching zone-cluster associations. If null, the behavior is equivalent to a ClusterTypes.FilterSpec with all properties null, which means all the zone-cluster associations will be returned.

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

invocationConfig - Configuration for the method invocation.