com.vmware.vcenter.consumption_domains

Interface Zones

All Superinterfaces:

Service, ZonesTypes

All Known Implementing Classes:

ZonesStub

public interface Zones
extends Service, ZonesTypes

The Zones interface provides methods to manage consumption-domain zones. 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.ZonesTypes

ZonesTypes.CreateSpec, ZonesTypes.FilterSpec, ZonesTypes.Info, ZonesTypes.ListItem, ZonesTypes.ListResult

Field Summary

Fields inherited from interface com.vmware.vcenter.consumption_domains.ZonesTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
java.lang.String	create(ZonesTypes.CreateSpec spec) Creates a zone based on the provided specifications.
void	create(ZonesTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Creates a zone based on the provided specifications.
void	create(ZonesTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Creates a zone based on the provided specifications.
java.lang.String	create(ZonesTypes.CreateSpec spec, InvocationConfig invocationConfig) Creates a zone based on the provided specifications.
void	delete(java.lang.String zone) Deletes the zone with the specified identifier.
void	delete(java.lang.String zone, AsyncCallback<java.lang.Void> asyncCallback) Deletes the zone with the specified identifier.
void	delete(java.lang.String zone, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deletes the zone with the specified identifier.
void	delete(java.lang.String zone, InvocationConfig invocationConfig) Deletes the zone with the specified identifier.
ZonesTypes.Info	get(java.lang.String zone) Returns the information about a specific zone.
void	get(java.lang.String zone, AsyncCallback<ZonesTypes.Info> asyncCallback) Returns the information about a specific zone.
void	get(java.lang.String zone, AsyncCallback<ZonesTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns the information about a specific zone.
ZonesTypes.Info	get(java.lang.String zone, InvocationConfig invocationConfig) Returns the information about a specific zone.
ZonesTypes.ListResult	list(ZonesTypes.FilterSpec spec) Returns information about the zones available on this vCenter server, where the zones need to match ZonesTypes.FilterSpec.
void	list(ZonesTypes.FilterSpec spec, AsyncCallback<ZonesTypes.ListResult> asyncCallback) Returns information about the zones available on this vCenter server, where the zones need to match ZonesTypes.FilterSpec.
void	list(ZonesTypes.FilterSpec spec, AsyncCallback<ZonesTypes.ListResult> asyncCallback, InvocationConfig invocationConfig) Returns information about the zones available on this vCenter server, where the zones need to match ZonesTypes.FilterSpec.
ZonesTypes.ListResult	list(ZonesTypes.FilterSpec spec, InvocationConfig invocationConfig) Returns information about the zones available on this vCenter server, where the zones need to match ZonesTypes.FilterSpec.

Method Detail

list

ZonesTypes.ListResult list(ZonesTypes.FilterSpec spec)

Returns information about the zones available on this vCenter server, where the zones need to match ZonesTypes.FilterSpec. 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:

spec - Return only the zones matching the specified filters. If null, the behavior is equivalent to a ZonesTypes.FilterSpec with all properties null, which means all zones are returned.

Returns:

The list of zones available on this vCenter that match the criteria specified in ZonesTypes.FilterSpec.

Throws:

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.

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:

• Method execution requires System.Read.

list

ZonesTypes.ListResult list(ZonesTypes.FilterSpec spec,
                           InvocationConfig invocationConfig)

Returns information about the zones available on this vCenter server, where the zones need to match ZonesTypes.FilterSpec. 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:

spec - Return only the zones matching the specified filters. If null, the behavior is equivalent to a ZonesTypes.FilterSpec with all properties null, which means all zones are returned.

invocationConfig - Configuration for the method invocation.

Returns:

The list of zones available on this vCenter that match the criteria specified in ZonesTypes.FilterSpec.

Throws:

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.

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:

• Method execution requires System.Read.

list

void list(ZonesTypes.FilterSpec spec,
          AsyncCallback<ZonesTypes.ListResult> asyncCallback)

Returns information about the zones available on this vCenter server, where the zones need to match ZonesTypes.FilterSpec. 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 list of zones available on this vCenter that match the criteria specified in ZonesTypes.FilterSpec.

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

• Method execution requires System.Read.

Parameters:

spec - Return only the zones matching the specified filters. If null, the behavior is equivalent to a ZonesTypes.FilterSpec with all properties null, which means all zones are returned.

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

list

void list(ZonesTypes.FilterSpec spec,
          AsyncCallback<ZonesTypes.ListResult> asyncCallback,
          InvocationConfig invocationConfig)

Returns information about the zones available on this vCenter server, where the zones need to match ZonesTypes.FilterSpec. 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 list of zones available on this vCenter that match the criteria specified in ZonesTypes.FilterSpec.

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

• Method execution requires System.Read.

Parameters:

spec - Return only the zones matching the specified filters. If null, the behavior is equivalent to a ZonesTypes.FilterSpec with all properties null, which means all zones are returned.

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

invocationConfig - Configuration for the method invocation.

get

ZonesTypes.Info get(java.lang.String zone)

Returns the information about a specific 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 for which information should be retrieved. The parameter must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

Returns:

Detailed information about the specified zone.

Throws:

NotFound - if a zone with this identifier does not exist.

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:

• Method execution requires System.Read.

get

ZonesTypes.Info get(java.lang.String zone,
                    InvocationConfig invocationConfig)

Returns the information about a specific 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 for which information should be retrieved. The parameter must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

invocationConfig - Configuration for the method invocation.

Returns:

Detailed information about the specified zone.

Throws:

NotFound - if a zone with this identifier does not exist.

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:

• Method execution requires System.Read.

get

void get(java.lang.String zone,
         AsyncCallback<ZonesTypes.Info> asyncCallback)

Returns the information about a specific 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:
Detailed information about the specified zone.

Operation Errors:
NotFound - if a zone with this identifier does not exist.
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:

• Method execution requires System.Read.

Parameters:

zone - Identifier of the zone for which information should be retrieved. 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<ZonesTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Returns the information about a specific 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:
Detailed information about the specified zone.

Operation Errors:
NotFound - if a zone with this identifier does not exist.
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:

• Method execution requires System.Read.

Parameters:

zone - Identifier of the zone for which information should be retrieved. 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.

create

java.lang.String create(ZonesTypes.CreateSpec spec)

Creates a zone based on the provided specifications. 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:

spec - Specifications for the zone to be created.

Returns:

The identifier of the created zone. The return value will be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

Throws:

AlreadyExists - if a zone with the same identifier already exists in this vCenter server.

InvalidArgument - if any of the input information in the createSpec is invalid.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have Zones.Manage privilege.

Error - when unexpected error is encountered.

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

• Method execution requires Zone.Manage.

create

java.lang.String create(ZonesTypes.CreateSpec spec,
                        InvocationConfig invocationConfig)

Creates a zone based on the provided specifications. 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:

spec - Specifications for the zone to be created.

invocationConfig - Configuration for the method invocation.

Returns:

The identifier of the created zone. The return value will be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

Throws:

AlreadyExists - if a zone with the same identifier already exists in this vCenter server.

InvalidArgument - if any of the input information in the createSpec is invalid.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have Zones.Manage privilege.

Error - when unexpected error is encountered.

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

• Method execution requires Zone.Manage.

create

void create(ZonesTypes.CreateSpec spec,
            AsyncCallback<java.lang.String> asyncCallback)

Creates a zone based on the provided specifications. 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 identifier of the created zone. The return value will be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

Operation Errors:
AlreadyExists - if a zone with the same identifier already exists in this vCenter server.
InvalidArgument - if any of the input information in the createSpec is invalid.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have Zones.Manage privilege.
Error - when unexpected error is encountered.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires Zone.Manage.

Parameters:

spec - Specifications for the zone to be created.

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

create

void create(ZonesTypes.CreateSpec spec,
            AsyncCallback<java.lang.String> asyncCallback,
            InvocationConfig invocationConfig)

Creates a zone based on the provided specifications. 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 identifier of the created zone. The return value will be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

Operation Errors:
AlreadyExists - if a zone with the same identifier already exists in this vCenter server.
InvalidArgument - if any of the input information in the createSpec is invalid.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have Zones.Manage privilege.
Error - when unexpected error is encountered.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires Zone.Manage.

Parameters:

spec - Specifications for the zone to be created.

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String zone)

Deletes the zone with the specified identifier. In order to delete a zone, there must not be any workload running in that zone because deleting the zone without removing all the dependencies on that zone can cause undefined behavior for the entities depending on this zone to be present. 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 deleted. The parameter must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

Throws:

NotFound - if no zone with the specified identifier is found in this vCenter server.

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

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 zone requires Zones.Manage privilege.

Error - when unexpected error is encountered.

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

• Method execution requires Zone.Manage.

delete

void delete(java.lang.String zone,
            InvocationConfig invocationConfig)

Deletes the zone with the specified identifier. In order to delete a zone, there must not be any workload running in that zone because deleting the zone without removing all the dependencies on that zone can cause undefined behavior for the entities depending on this zone to be present. 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 deleted. The parameter must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if no zone with the specified identifier is found in this vCenter server.

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

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 zone requires Zones.Manage privilege.

Error - when unexpected error is encountered.

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

• Method execution requires Zone.Manage.

delete

void delete(java.lang.String zone,
            AsyncCallback<java.lang.Void> asyncCallback)

Deletes the zone with the specified identifier. In order to delete a zone, there must not be any workload running in that zone because deleting the zone without removing all the dependencies on that zone can cause undefined behavior for the entities depending on this zone to be present. 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.

Operation Errors:
NotFound - if no zone with the specified identifier is found in this vCenter server.
NotAllowedInCurrentState - if there is a workload running in the specified zone and depends on this zone to be present.
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 zone requires Zones.Manage privilege.
Error - when unexpected error is encountered.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires Zone.Manage.

Parameters:

zone - Identifier of the zone to be deleted. 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.

delete

void delete(java.lang.String zone,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Deletes the zone with the specified identifier. In order to delete a zone, there must not be any workload running in that zone because deleting the zone without removing all the dependencies on that zone can cause undefined behavior for the entities depending on this zone to be present. 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.

Operation Errors:
NotFound - if no zone with the specified identifier is found in this vCenter server.
NotAllowedInCurrentState - if there is a workload running in the specified zone and depends on this zone to be present.
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 zone requires Zones.Manage privilege.
Error - when unexpected error is encountered.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires Zone.Manage.

Parameters:

zone - Identifier of the zone to be deleted. 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.