com.vmware.esx.settings.depot_content

Interface BaseImages

All Superinterfaces:

BaseImagesTypes, Service

All Known Implementing Classes:

BaseImagesStub

public interface BaseImages
extends Service, BaseImagesTypes

The BaseImages interface provides methods to get base-images from the sync'ed and imported depots.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.esx.settings.depot_content.BaseImagesTypes

BaseImagesTypes.CategoryType, BaseImagesTypes.FilterSpec, BaseImagesTypes.Summary

Field Summary

Fields inherited from interface com.vmware.esx.settings.depot_content.BaseImagesTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
java.util.List<BaseImagesTypes.Summary>	list(BaseImagesTypes.FilterSpec filter) Returns a list of currently available base-images in the depot.
void	list(BaseImagesTypes.FilterSpec filter, AsyncCallback<java.util.List<BaseImagesTypes.Summary>> asyncCallback) Returns a list of currently available base-images in the depot.
void	list(BaseImagesTypes.FilterSpec filter, AsyncCallback<java.util.List<BaseImagesTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns a list of currently available base-images in the depot.
java.util.List<BaseImagesTypes.Summary>	list(BaseImagesTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns a list of currently available base-images in the depot.

Method Detail

list

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

Returns a list of currently available base-images in the depot.

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

Parameters:

filter - The specification of matching base-images. If null, the behavior is equivalent to a BaseImagesTypes.FilterSpec with all properties null, which means all base-images match the filter.

Returns:

List of base-images in the depot. These will be sorted by the version of the base-image.

Throws:

Error - If there is unknown internal error. The accompanying error message will give more details about the failure.

ServiceUnavailable - If the service is not available.

Unauthenticated - if the caller is not authenticated.

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

• Method execution requires VcIntegrity.lifecycleSettings.Read.

list

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

Returns a list of currently available base-images in the depot.

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 base-images. If null, the behavior is equivalent to a BaseImagesTypes.FilterSpec with all properties null, which means all base-images match the filter.

invocationConfig - Configuration for the method invocation.

Returns:

List of base-images in the depot. These will be sorted by the version of the base-image.

Throws:

Error - If there is unknown internal error. The accompanying error message will give more details about the failure.

ServiceUnavailable - If the service is not available.

Unauthenticated - if the caller is not authenticated.

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

• Method execution requires VcIntegrity.lifecycleSettings.Read.

list

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

Returns a list of currently available base-images in the depot.

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

Invocation Result:
List of base-images in the depot. These will be sorted by the version of the base-image.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
ServiceUnavailable - If the service is not available.
Unauthenticated - if the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Read.

Parameters:

filter - The specification of matching base-images. If null, the behavior is equivalent to a BaseImagesTypes.FilterSpec with all properties null, which means all base-images match the filter.

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

list

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

Returns a list of currently available base-images in the depot.

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:
List of base-images in the depot. These will be sorted by the version of the base-image.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
ServiceUnavailable - If the service is not available.
Unauthenticated - if the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Read.

Parameters:

filter - The specification of matching base-images. If null, the behavior is equivalent to a BaseImagesTypes.FilterSpec with all properties null, which means all base-images match the filter.

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

invocationConfig - Configuration for the method invocation.