com.vmware.vcenter.consumption_domains.zones.cluster

Interface Associations

All Superinterfaces:

AssociationsTypes, Service

All Known Implementing Classes:

AssociationsStub

public interface Associations
extends Service, AssociationsTypes

The Associations interface provides methods to manage associations of a single consumption-domain zone to multiple vSphere clusters. 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.zones.cluster.AssociationsTypes

AssociationsTypes.Status

Field Summary

Fields inherited from interface com.vmware.vcenter.consumption_domains.zones.cluster.AssociationsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
AssociationsTypes.Status	add(java.lang.String zone, java.util.Set<java.lang.String> clusters) Maps a consumption-domain zone to the specified vSphere clusters.
void	add(java.lang.String zone, java.util.Set<java.lang.String> clusters, AsyncCallback<AssociationsTypes.Status> asyncCallback) Maps a consumption-domain zone to the specified vSphere clusters.
void	add(java.lang.String zone, java.util.Set<java.lang.String> clusters, AsyncCallback<AssociationsTypes.Status> asyncCallback, InvocationConfig invocationConfig) Maps a consumption-domain zone to the specified vSphere clusters.
AssociationsTypes.Status	add(java.lang.String zone, java.util.Set<java.lang.String> clusters, InvocationConfig invocationConfig) Maps a consumption-domain zone to the specified vSphere clusters.
java.util.Set<java.lang.String>	get(java.lang.String zone) Returns identifiers of the clusters that are mapped to the specified consumption-domain zone.
void	get(java.lang.String zone, AsyncCallback<java.util.Set<java.lang.String>> asyncCallback) Returns identifiers of the clusters that are mapped to the specified consumption-domain zone.
void	get(java.lang.String zone, AsyncCallback<java.util.Set<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Returns identifiers of the clusters that are mapped to the specified consumption-domain zone.
java.util.Set<java.lang.String>	get(java.lang.String zone, InvocationConfig invocationConfig) Returns identifiers of the clusters that are mapped to the specified consumption-domain zone.
AssociationsTypes.Status	remove(java.lang.String zone, java.util.Set<java.lang.String> clusters) Removes the mapping between the specified consumption-domain zone and vSphere clusters.
void	remove(java.lang.String zone, java.util.Set<java.lang.String> clusters, AsyncCallback<AssociationsTypes.Status> asyncCallback) Removes the mapping between the specified consumption-domain zone and vSphere clusters.
void	remove(java.lang.String zone, java.util.Set<java.lang.String> clusters, AsyncCallback<AssociationsTypes.Status> asyncCallback, InvocationConfig invocationConfig) Removes the mapping between the specified consumption-domain zone and vSphere clusters.
AssociationsTypes.Status	remove(java.lang.String zone, java.util.Set<java.lang.String> clusters, InvocationConfig invocationConfig) Removes the mapping between the specified consumption-domain zone and vSphere clusters.

Method Detail

add

AssociationsTypes.Status add(java.lang.String zone,
                             java.util.Set<java.lang.String> clusters)

Maps a consumption-domain zone to the specified vSphere clusters. If a cluster or a subset of specified clusters are already members of the specified zone, the result is success for those clusters. This method supports partial success, i.e., it is possible that a subset of the specified clusters get successfully associated with the specified zone but the association fails for a subset of clusters. The returned result will contain the details about only those clusters for which the association failed. 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:

zone - Identifier of the zone to be mapped to the specified vSphere clusters. The parameter must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

clusters - Set of identifiers of vSphere clusters to which the the specified zone should be mapped. The parameter must contain identifiers for the resource type: ClusterComputeResource.

Returns:

Status see com.vmware.vcenter.consumption_domains.zones.cluster.Associations#Status. If the method failed, returns the reason of failures. There will be an error message indicating the identifier of the cluster for which the association failed and the reason of failure. The cluster identifiers that are not present in com.vmware.vcenter.consumption_domains.zones.cluster.Associations#Status will have been successfully associated.

Throws:

InvalidArgument - if more than one cluster or an empty set of clusters is specified.

NotFound - if the specified zone is not known to this vCenter server.

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 zone requires Zones.Manage privilege. - Each resource of ClusterComputeResource referenced by the parameter clusters requires Zone.ObjectAttachable privilege.

Unauthenticated - if the user can not be authenticated.

Error - when unexpected error is encountered.

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

• The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zone requires Zone.Manage.

add

AssociationsTypes.Status add(java.lang.String zone,
                             java.util.Set<java.lang.String> clusters,
                             InvocationConfig invocationConfig)

Maps a consumption-domain zone to the specified vSphere clusters. If a cluster or a subset of specified clusters are already members of the specified zone, the result is success for those clusters. This method supports partial success, i.e., it is possible that a subset of the specified clusters get successfully associated with the specified zone but the association fails for a subset of clusters. The returned result will contain the details about only those clusters for which the association failed. 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:

zone - Identifier of the zone to be mapped to the specified vSphere clusters. The parameter must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

clusters - Set of identifiers of vSphere clusters to which the the specified zone should be mapped. The parameter must contain identifiers for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

Status see com.vmware.vcenter.consumption_domains.zones.cluster.Associations#Status. If the method failed, returns the reason of failures. There will be an error message indicating the identifier of the cluster for which the association failed and the reason of failure. The cluster identifiers that are not present in com.vmware.vcenter.consumption_domains.zones.cluster.Associations#Status will have been successfully associated.

Throws:

InvalidArgument - if more than one cluster or an empty set of clusters is specified.

NotFound - if the specified zone is not known to this vCenter server.

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 zone requires Zones.Manage privilege. - Each resource of ClusterComputeResource referenced by the parameter clusters requires Zone.ObjectAttachable privilege.

Unauthenticated - if the user can not be authenticated.

Error - when unexpected error is encountered.

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

• The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zone requires Zone.Manage.

add

void add(java.lang.String zone,
         java.util.Set<java.lang.String> clusters,
         AsyncCallback<AssociationsTypes.Status> asyncCallback)

Maps a consumption-domain zone to the specified vSphere clusters. If a cluster or a subset of specified clusters are already members of the specified zone, the result is success for those clusters. This method supports partial success, i.e., it is possible that a subset of the specified clusters get successfully associated with the specified zone but the association fails for a subset of clusters. The returned result will contain the details about only those clusters for which the association failed. 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:
Status see com.vmware.vcenter.consumption_domains.zones.cluster.Associations#Status. If the method failed, returns the reason of failures. There will be an error message indicating the identifier of the cluster for which the association failed and the reason of failure. The cluster identifiers that are not present in com.vmware.vcenter.consumption_domains.zones.cluster.Associations#Status will have been successfully associated.

Operation Errors:
InvalidArgument - if more than one cluster or an empty set of clusters is specified.
NotFound - if the specified zone is not known to this vCenter server.
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 zone requires Zones.Manage privilege. - Each resource of ClusterComputeResource referenced by the parameter clusters requires Zone.ObjectAttachable privilege.
Unauthenticated - if the user can not be authenticated.
Error - when unexpected error is encountered.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zone requires Zone.Manage.

Parameters:

zone - Identifier of the zone to be mapped to the specified vSphere clusters. The parameter must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

clusters - Set of identifiers of vSphere clusters to which the the specified zone should be mapped. The parameter must contain identifiers for the resource type: ClusterComputeResource.

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

add

void add(java.lang.String zone,
         java.util.Set<java.lang.String> clusters,
         AsyncCallback<AssociationsTypes.Status> asyncCallback,
         InvocationConfig invocationConfig)

Maps a consumption-domain zone to the specified vSphere clusters. If a cluster or a subset of specified clusters are already members of the specified zone, the result is success for those clusters. This method supports partial success, i.e., it is possible that a subset of the specified clusters get successfully associated with the specified zone but the association fails for a subset of clusters. The returned result will contain the details about only those clusters for which the association failed. 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:
Status see com.vmware.vcenter.consumption_domains.zones.cluster.Associations#Status. If the method failed, returns the reason of failures. There will be an error message indicating the identifier of the cluster for which the association failed and the reason of failure. The cluster identifiers that are not present in com.vmware.vcenter.consumption_domains.zones.cluster.Associations#Status will have been successfully associated.

Operation Errors:
InvalidArgument - if more than one cluster or an empty set of clusters is specified.
NotFound - if the specified zone is not known to this vCenter server.
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 zone requires Zones.Manage privilege. - Each resource of ClusterComputeResource referenced by the parameter clusters requires Zone.ObjectAttachable privilege.
Unauthenticated - if the user can not be authenticated.
Error - when unexpected error is encountered.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zone requires Zone.Manage.

Parameters:

zone - Identifier of the zone to be mapped to the specified vSphere clusters. The parameter must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

clusters - Set of identifiers of vSphere clusters to which the the specified zone should be mapped. The parameter must contain identifiers for the resource type: ClusterComputeResource.

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

invocationConfig - Configuration for the method invocation.

remove

AssociationsTypes.Status remove(java.lang.String zone,
                                java.util.Set<java.lang.String> clusters)

Removes the mapping between the specified consumption-domain zone and vSphere clusters. If a cluster or a subset of specified clusters are not members of the specified zone, then the result is a success for those clusters. In order to remove the mapping between a zone and a cluster, there must not be any workload running in that zone because removing the mapping between a zone and a cluster could result in undefined behavior for the entities depending on this mapping to be present. This method supports partial success, i.e., it is possible that the mapping gets successfully removed for a subset of the clusters but fails for another subset of the clusters. The returned result will contain the details about only those clusters for which the method failed. 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:

zone - Identifier of the zone for which the mapping needs to be removed. The parameter must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

clusters - Set of identifiers of vSphere clusters which need to be removed from the mapping. The parameter must contain identifiers for the resource type: ClusterComputeResource.

Returns:

Status see com.vmware.vcenter.consumption_domains.zones.cluster.Associations#Status. If the method failed, returns the reason of failures. There will be an error message indicating the identifier of the cluster for which the association removal failed and the reason of failure.

Throws:

NotFound - if the specified zone is not known to this vCenter server.

NotAllowedInCurrentState - if there is a workload running in the specified zone and depends on this zone's cluster associations to be present.

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 zone requires Zones.Manage privilege. - Each resource of ClusterComputeResource referenced by the parameter clusters requires Zone.ObjectAttachable privilege.

Unauthenticated - if the user can not be authenticated.

Error - when unexpected error is encountered.

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

• The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zone requires Zone.Manage.

remove

AssociationsTypes.Status remove(java.lang.String zone,
                                java.util.Set<java.lang.String> clusters,
                                InvocationConfig invocationConfig)

Removes the mapping between the specified consumption-domain zone and vSphere clusters. If a cluster or a subset of specified clusters are not members of the specified zone, then the result is a success for those clusters. In order to remove the mapping between a zone and a cluster, there must not be any workload running in that zone because removing the mapping between a zone and a cluster could result in undefined behavior for the entities depending on this mapping to be present. This method supports partial success, i.e., it is possible that the mapping gets successfully removed for a subset of the clusters but fails for another subset of the clusters. The returned result will contain the details about only those clusters for which the method failed. 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:

zone - Identifier of the zone for which the mapping needs to be removed. The parameter must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

clusters - Set of identifiers of vSphere clusters which need to be removed from the mapping. The parameter must contain identifiers for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

Status see com.vmware.vcenter.consumption_domains.zones.cluster.Associations#Status. If the method failed, returns the reason of failures. There will be an error message indicating the identifier of the cluster for which the association removal failed and the reason of failure.

Throws:

NotFound - if the specified zone is not known to this vCenter server.

NotAllowedInCurrentState - if there is a workload running in the specified zone and depends on this zone's cluster associations to be present.

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 zone requires Zones.Manage privilege. - Each resource of ClusterComputeResource referenced by the parameter clusters requires Zone.ObjectAttachable privilege.

Unauthenticated - if the user can not be authenticated.

Error - when unexpected error is encountered.

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

• The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zone requires Zone.Manage.

remove

void remove(java.lang.String zone,
            java.util.Set<java.lang.String> clusters,
            AsyncCallback<AssociationsTypes.Status> asyncCallback)

Removes the mapping between the specified consumption-domain zone and vSphere clusters. If a cluster or a subset of specified clusters are not members of the specified zone, then the result is a success for those clusters. In order to remove the mapping between a zone and a cluster, there must not be any workload running in that zone because removing the mapping between a zone and a cluster could result in undefined behavior for the entities depending on this mapping to be present. This method supports partial success, i.e., it is possible that the mapping gets successfully removed for a subset of the clusters but fails for another subset of the clusters. The returned result will contain the details about only those clusters for which the method failed. 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:
Status see com.vmware.vcenter.consumption_domains.zones.cluster.Associations#Status. If the method failed, returns the reason of failures. There will be an error message indicating the identifier of the cluster for which the association removal failed and the reason of failure.

Operation Errors:
NotFound - if the specified zone is not known to this vCenter server.
NotAllowedInCurrentState - if there is a workload running in the specified zone and depends on this zone's cluster associations to be present.
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 zone requires Zones.Manage privilege. - Each resource of ClusterComputeResource referenced by the parameter clusters requires Zone.ObjectAttachable privilege.
Unauthenticated - if the user can not be authenticated.
Error - when unexpected error is encountered.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zone requires Zone.Manage.

Parameters:

zone - Identifier of the zone for which the mapping needs to be removed. The parameter must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

clusters - Set of identifiers of vSphere clusters which need to be removed from the mapping. The parameter must contain identifiers for the resource type: ClusterComputeResource.

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

remove

void remove(java.lang.String zone,
            java.util.Set<java.lang.String> clusters,
            AsyncCallback<AssociationsTypes.Status> asyncCallback,
            InvocationConfig invocationConfig)

Removes the mapping between the specified consumption-domain zone and vSphere clusters. If a cluster or a subset of specified clusters are not members of the specified zone, then the result is a success for those clusters. In order to remove the mapping between a zone and a cluster, there must not be any workload running in that zone because removing the mapping between a zone and a cluster could result in undefined behavior for the entities depending on this mapping to be present. This method supports partial success, i.e., it is possible that the mapping gets successfully removed for a subset of the clusters but fails for another subset of the clusters. The returned result will contain the details about only those clusters for which the method failed. 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:
Status see com.vmware.vcenter.consumption_domains.zones.cluster.Associations#Status. If the method failed, returns the reason of failures. There will be an error message indicating the identifier of the cluster for which the association removal failed and the reason of failure.

Operation Errors:
NotFound - if the specified zone is not known to this vCenter server.
NotAllowedInCurrentState - if there is a workload running in the specified zone and depends on this zone's cluster associations to be present.
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 zone requires Zones.Manage privilege. - Each resource of ClusterComputeResource referenced by the parameter clusters requires Zone.ObjectAttachable privilege.
Unauthenticated - if the user can not be authenticated.
Error - when unexpected error is encountered.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zone requires Zone.Manage.

Parameters:

zone - Identifier of the zone for which the mapping needs to be removed. The parameter must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

clusters - Set of identifiers of vSphere clusters which need to be removed from the mapping. The parameter must contain identifiers for the resource type: ClusterComputeResource.

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

invocationConfig - Configuration for the method invocation.

get

java.util.Set<java.lang.String> get(java.lang.String zone)

Returns identifiers of the clusters that are mapped to the specified consumption-domain zone. 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:

zone - Identifier of the zone to be queried for its associated vSphere clusters. The parameter must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

Returns:

The set of vSphere clusters mapped to the specified zone. The return value will contain identifiers for the resource type: ClusterComputeResource.

Throws:

NotFound - if the specified zone is not known to this vCenter server.

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 zone requires System.Read privilege.

Unauthenticated - if the user can not be authenticated.

Error - when unexpected error is encountered.

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

• The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zone requires System.Read.

get

java.util.Set<java.lang.String> get(java.lang.String zone,
                                    InvocationConfig invocationConfig)

Returns identifiers of the clusters that are mapped to the specified consumption-domain zone. 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:

zone - Identifier of the zone to be queried for its associated vSphere clusters. The parameter must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

invocationConfig - Configuration for the method invocation.

Returns:

The set of vSphere clusters mapped to the specified zone. The return value will contain identifiers for the resource type: ClusterComputeResource.

Throws:

NotFound - if the specified zone is not known to this vCenter server.

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 zone requires System.Read privilege.

Unauthenticated - if the user can not be authenticated.

Error - when unexpected error is encountered.

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

• The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zone requires System.Read.

get

void get(java.lang.String zone,
         AsyncCallback<java.util.Set<java.lang.String>> asyncCallback)

Returns identifiers of the clusters that are mapped to the specified consumption-domain zone. 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:
The set of vSphere clusters mapped to the specified zone. The return value will contain identifiers for the resource type: ClusterComputeResource.

Operation Errors:
NotFound - if the specified zone is not known to this vCenter server.
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 zone requires System.Read privilege.
Unauthenticated - if the user can not be authenticated.
Error - when unexpected error is encountered.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zone requires System.Read.

Parameters:

zone - Identifier of the zone to be queried for its associated vSphere clusters. The parameter must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

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

get

void get(java.lang.String zone,
         AsyncCallback<java.util.Set<java.lang.String>> asyncCallback,
         InvocationConfig invocationConfig)

Returns identifiers of the clusters that are mapped to the specified consumption-domain zone. 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:
The set of vSphere clusters mapped to the specified zone. The return value will contain identifiers for the resource type: ClusterComputeResource.

Operation Errors:
NotFound - if the specified zone is not known to this vCenter server.
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 zone requires System.Read privilege.
Unauthenticated - if the user can not be authenticated.
Error - when unexpected error is encountered.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zone requires System.Read.

Parameters:

zone - Identifier of the zone to be queried for its associated vSphere clusters. The parameter must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

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

invocationConfig - Configuration for the method invocation.