com.vmware.vcenter

Interface Datacenter

All Superinterfaces:

DatacenterTypes, Service

All Known Implementing Classes:

DatacenterStub

public interface Datacenter
extends Service, DatacenterTypes

The Datacenter interface provides methods to manage datacenters in the vCenter Server.

Nested Class Summary

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

DatacenterTypes.CreateSpec, DatacenterTypes.FilterSpec, DatacenterTypes.Info, DatacenterTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vcenter.DatacenterTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
java.lang.String	create(DatacenterTypes.CreateSpec spec) Create a new datacenter in the vCenter inventory
void	create(DatacenterTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Create a new datacenter in the vCenter inventory
void	create(DatacenterTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Create a new datacenter in the vCenter inventory
java.lang.String	create(DatacenterTypes.CreateSpec spec, InvocationConfig invocationConfig) Create a new datacenter in the vCenter inventory
void	delete(java.lang.String datacenter, java.lang.Boolean force) Delete an empty datacenter from the vCenter Server
void	delete(java.lang.String datacenter, java.lang.Boolean force, AsyncCallback<java.lang.Void> asyncCallback) Delete an empty datacenter from the vCenter Server
void	delete(java.lang.String datacenter, java.lang.Boolean force, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Delete an empty datacenter from the vCenter Server
void	delete(java.lang.String datacenter, java.lang.Boolean force, InvocationConfig invocationConfig) Delete an empty datacenter from the vCenter Server
DatacenterTypes.Info	get(java.lang.String datacenter) Retrieves information about the datacenter corresponding to datacenter.
void	get(java.lang.String datacenter, AsyncCallback<DatacenterTypes.Info> asyncCallback) Retrieves information about the datacenter corresponding to datacenter.
void	get(java.lang.String datacenter, AsyncCallback<DatacenterTypes.Info> asyncCallback, InvocationConfig invocationConfig) Retrieves information about the datacenter corresponding to datacenter.
DatacenterTypes.Info	get(java.lang.String datacenter, InvocationConfig invocationConfig) Retrieves information about the datacenter corresponding to datacenter.
java.util.List<DatacenterTypes.Summary>	list(DatacenterTypes.FilterSpec filter) Returns information about at most 1000 visible (subject to permission checks) datacenters in vCenter matching the DatacenterTypes.FilterSpec.
void	list(DatacenterTypes.FilterSpec filter, AsyncCallback<java.util.List<DatacenterTypes.Summary>> asyncCallback) Returns information about at most 1000 visible (subject to permission checks) datacenters in vCenter matching the DatacenterTypes.FilterSpec.
void	list(DatacenterTypes.FilterSpec filter, AsyncCallback<java.util.List<DatacenterTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns information about at most 1000 visible (subject to permission checks) datacenters in vCenter matching the DatacenterTypes.FilterSpec.
java.util.List<DatacenterTypes.Summary>	list(DatacenterTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns information about at most 1000 visible (subject to permission checks) datacenters in vCenter matching the DatacenterTypes.FilterSpec.

Method Detail

create

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

Create a new datacenter in the vCenter inventory

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

Parameters:

spec - Specification for the new datacenter to be created.

Returns:

The identifier of the newly created datacenter The return value will be an identifier for the resource type: Datacenter.

Throws:

Error - if the system reports an error while responding to the request.

AlreadyExists - if a datacenter with the same name is already present.

InvalidArgument - if the datacenter name is empty or invalid as per the underlying implementation.

InvalidArgument - if the folder is not specified and the system cannot choose a suitable one.

NotFound - if the datacenter folder cannot be found.

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.

create

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

Create a new datacenter in the vCenter inventory

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 - Specification for the new datacenter to be created.

invocationConfig - Configuration for the method invocation.

Returns:

The identifier of the newly created datacenter The return value will be an identifier for the resource type: Datacenter.

Throws:

Error - if the system reports an error while responding to the request.

AlreadyExists - if a datacenter with the same name is already present.

InvalidArgument - if the datacenter name is empty or invalid as per the underlying implementation.

InvalidArgument - if the folder is not specified and the system cannot choose a suitable one.

NotFound - if the datacenter folder cannot be found.

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.

create

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

Create a new datacenter in the vCenter inventory

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

Invocation Result:
The identifier of the newly created datacenter The return value will be an identifier for the resource type: Datacenter.

Operation Errors:
Error - if the system reports an error while responding to the request.
AlreadyExists - if a datacenter with the same name is already present.
InvalidArgument - if the datacenter name is empty or invalid as per the underlying implementation.
InvalidArgument - if the folder is not specified and the system cannot choose a suitable one.
NotFound - if the datacenter folder cannot be found.
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:

spec - Specification for the new datacenter to be created.

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

create

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

Create a new datacenter in the vCenter inventory

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 newly created datacenter The return value will be an identifier for the resource type: Datacenter.

Operation Errors:
Error - if the system reports an error while responding to the request.
AlreadyExists - if a datacenter with the same name is already present.
InvalidArgument - if the datacenter name is empty or invalid as per the underlying implementation.
InvalidArgument - if the folder is not specified and the system cannot choose a suitable one.
NotFound - if the datacenter folder cannot be found.
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:

spec - Specification for the new datacenter 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 datacenter,
            java.lang.Boolean force)

Delete an empty datacenter from the vCenter Server

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

Parameters:

datacenter - Identifier of the datacenter to be deleted. The parameter must be an identifier for the resource type: Datacenter.

force - If true, delete the datacenter even if it is not empty. If null a ResourceInUse exception will be reported if the datacenter is not empty. This is the equivalent of passing the value false.

Throws:

Error - if the system reports an error while responding to the request.

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

ResourceInUse - if the datacenter associated with datacenter is not empty.

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.

delete

void delete(java.lang.String datacenter,
            java.lang.Boolean force,
            InvocationConfig invocationConfig)

Delete an empty datacenter from the vCenter Server

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:

datacenter - Identifier of the datacenter to be deleted. The parameter must be an identifier for the resource type: Datacenter.

force - If true, delete the datacenter even if it is not empty. If null a ResourceInUse exception will be reported if the datacenter is not empty. This is the equivalent of passing the value false.

invocationConfig - Configuration for the method invocation.

Throws:

Error - if the system reports an error while responding to the request.

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

ResourceInUse - if the datacenter associated with datacenter is not empty.

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.

delete

void delete(java.lang.String datacenter,
            java.lang.Boolean force,
            AsyncCallback<java.lang.Void> asyncCallback)

Delete an empty datacenter from the vCenter Server

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

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if there is no datacenter associated with datacenter in the system.
ResourceInUse - if the datacenter associated with datacenter is not empty.
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:

datacenter - Identifier of the datacenter to be deleted. The parameter must be an identifier for the resource type: Datacenter.

force - If true, delete the datacenter even if it is not empty. If null a ResourceInUse exception will be reported if the datacenter is not empty. This is the equivalent of passing the value false.

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

delete

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

Delete an empty datacenter from the vCenter Server

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:
Error - if the system reports an error while responding to the request.
NotFound - if there is no datacenter associated with datacenter in the system.
ResourceInUse - if the datacenter associated with datacenter is not empty.
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:

datacenter - Identifier of the datacenter to be deleted. The parameter must be an identifier for the resource type: Datacenter.

force - If true, delete the datacenter even if it is not empty. If null a ResourceInUse exception will be reported if the datacenter is not empty. This is the equivalent of passing the value false.

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

invocationConfig - Configuration for the method invocation.

list

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

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

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

Parameters:

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

Returns:

Commonly used information about the datacenters matching the DatacenterTypes.FilterSpec.

Throws:

UnableToAllocateResource - if more than 1000 datacenters match the DatacenterTypes.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

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

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

invocationConfig - Configuration for the method invocation.

Returns:

Commonly used information about the datacenters matching the DatacenterTypes.FilterSpec.

Throws:

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

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

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

Invocation Result:
Commonly used information about the datacenters matching the DatacenterTypes.FilterSpec.

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

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

list

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

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

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:
Commonly used information about the datacenters matching the DatacenterTypes.FilterSpec.

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

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

invocationConfig - Configuration for the method invocation.

get

DatacenterTypes.Info get(java.lang.String datacenter)

Retrieves information about the datacenter corresponding to datacenter.

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

Parameters:

datacenter - Identifier of the datacenter. The parameter must be an identifier for the resource type: Datacenter.

Returns:

Information about the datacenter associated with datacenter.

Throws:

Error - if the system reports an error while responding to the request.

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

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.

get

DatacenterTypes.Info get(java.lang.String datacenter,
                         InvocationConfig invocationConfig)

Retrieves information about the datacenter corresponding to datacenter.

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:

datacenter - Identifier of the datacenter. The parameter must be an identifier for the resource type: Datacenter.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the datacenter associated with datacenter.

Throws:

Error - if the system reports an error while responding to the request.

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

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.

get

void get(java.lang.String datacenter,
         AsyncCallback<DatacenterTypes.Info> asyncCallback)

Retrieves information about the datacenter corresponding to datacenter.

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

Invocation Result:
Information about the datacenter associated with datacenter.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if there is no datacenter associated with datacenter in the system.
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:

datacenter - Identifier of the datacenter. The parameter must be an identifier for the resource type: Datacenter.

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

get

void get(java.lang.String datacenter,
         AsyncCallback<DatacenterTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Retrieves information about the datacenter corresponding to datacenter.

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:
Information about the datacenter associated with datacenter.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if there is no datacenter associated with datacenter in the system.
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:

datacenter - Identifier of the datacenter. The parameter must be an identifier for the resource type: Datacenter.

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

invocationConfig - Configuration for the method invocation.