com.vmware.vcenter

Interface Datastore

All Superinterfaces:

DatastoreTypes, Service

All Known Implementing Classes:

DatastoreStub

public interface Datastore
extends Service, DatastoreTypes

The Datastore interface provides methods for manipulating a datastore.

Nested Class Summary

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

DatastoreTypes.FilterSpec, DatastoreTypes.Info, DatastoreTypes.Summary, DatastoreTypes.Type

Field Summary

Fields inherited from interface com.vmware.vcenter.DatastoreTypes

RESOURCE_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
DatastoreTypes.Info	get(String datastore) Retrieves information about the datastore indicated by datastore.
void	get(String datastore, AsyncCallback<DatastoreTypes.Info> asyncCallback) Retrieves information about the datastore indicated by datastore.
void	get(String datastore, AsyncCallback<DatastoreTypes.Info> asyncCallback, InvocationConfig invocationConfig) Retrieves information about the datastore indicated by datastore.
DatastoreTypes.Info	get(String datastore, InvocationConfig invocationConfig) Retrieves information about the datastore indicated by datastore.
List<DatastoreTypes.Summary>	list(DatastoreTypes.FilterSpec filter) Returns information about at most 1000 visible (subject to permission checks) datastores in vCenter matching the DatastoreTypes.FilterSpec.
void	list(DatastoreTypes.FilterSpec filter, AsyncCallback<List<DatastoreTypes.Summary>> asyncCallback) Returns information about at most 1000 visible (subject to permission checks) datastores in vCenter matching the DatastoreTypes.FilterSpec.
void	list(DatastoreTypes.FilterSpec filter, AsyncCallback<List<DatastoreTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns information about at most 1000 visible (subject to permission checks) datastores in vCenter matching the DatastoreTypes.FilterSpec.
List<DatastoreTypes.Summary>	list(DatastoreTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns information about at most 1000 visible (subject to permission checks) datastores in vCenter matching the DatastoreTypes.FilterSpec.

Method Detail

get

DatastoreTypes.Info get(String datastore)

Retrieves information about the datastore indicated by datastore.

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

Parameters:

datastore - Identifier of the datastore for which information should be retrieved. The parameter must be an identifier for the resource type: Datastore.

Returns:

information about the datastore.

Throws:

NotFound - if the datastore indicated by datastore does not exist.

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

DatastoreTypes.Info get(String datastore,
                      InvocationConfig invocationConfig)

Retrieves information about the datastore indicated by datastore.

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:

datastore - Identifier of the datastore for which information should be retrieved. The parameter must be an identifier for the resource type: Datastore.

invocationConfig - Configuration for the method invocation.

Returns:

information about the datastore.

Throws:

NotFound - if the datastore indicated by datastore does not exist.

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(String datastore,
       AsyncCallback<DatastoreTypes.Info> asyncCallback)

Retrieves information about the datastore indicated by datastore.

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

Operation Result:
information about the datastore.

Operation Errors:
NotFound - if the datastore indicated by datastore does not exist.
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:

datastore - Identifier of the datastore for which information should be retrieved. The parameter must be an identifier for the resource type: Datastore.

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

get

void get(String datastore,
       AsyncCallback<DatastoreTypes.Info> asyncCallback,
       InvocationConfig invocationConfig)

Retrieves information about the datastore indicated by datastore.

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:
information about the datastore.

Operation Errors:
NotFound - if the datastore indicated by datastore does not exist.
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:

datastore - Identifier of the datastore for which information should be retrieved. The parameter must be an identifier for the resource type: Datastore.

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

invocationConfig - Configuration for the method invocation.

list

List<DatastoreTypes.Summary> list(DatastoreTypes.FilterSpec filter)

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

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

Parameters:

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

Returns:

Commonly used information about the datastores matching the DatastoreTypes.FilterSpec.

Throws:

InvalidArgument - if the DatastoreTypes.FilterSpec.getTypes() property contains a value that is not supported by the server.

InvalidArgument - if the DatastoreTypes.FilterSpec.getTypes() property contains a value that is not supported by the server.

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

List<DatastoreTypes.Summary> list(DatastoreTypes.FilterSpec filter,
                                InvocationConfig invocationConfig)

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

invocationConfig - Configuration for the method invocation.

Returns:

Commonly used information about the datastores matching the DatastoreTypes.FilterSpec.

Throws:

InvalidArgument - if the DatastoreTypes.FilterSpec.getTypes() property contains a value that is not supported by the server.

InvalidArgument - if the DatastoreTypes.FilterSpec.getTypes() property contains a value that is not supported by the server.

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

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

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

Operation Result:
Commonly used information about the datastores matching the DatastoreTypes.FilterSpec.

Operation Errors:
InvalidArgument - if the DatastoreTypes.FilterSpec.getTypes() property contains a value that is not supported by the server.
InvalidArgument - if the DatastoreTypes.FilterSpec.getTypes() property contains a value that is not supported by the server.
UnableToAllocateResource - if more than 1000 datastores match the DatastoreTypes.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 datastores for which information should be returned. If null, the behavior is equivalent to a DatastoreTypes.FilterSpec with all properties null which means all datastores match the filter.

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

list

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

Returns information about at most 1000 visible (subject to permission checks) datastores in vCenter matching the DatastoreTypes.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 datastores matching the DatastoreTypes.FilterSpec.

Operation Errors:
InvalidArgument - if the DatastoreTypes.FilterSpec.getTypes() property contains a value that is not supported by the server.
InvalidArgument - if the DatastoreTypes.FilterSpec.getTypes() property contains a value that is not supported by the server.
UnableToAllocateResource - if more than 1000 datastores match the DatastoreTypes.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 datastores for which information should be returned. If null, the behavior is equivalent to a DatastoreTypes.FilterSpec with all properties null which means all datastores match the filter.

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

invocationConfig - Configuration for the method invocation.