com.vmware.esx.settings.depot_content

Class BaseImagesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.esx.settings.depot_content.BaseImagesStub

All Implemented Interfaces:

BaseImages, BaseImagesTypes, Service

public class BaseImagesStub
extends com.vmware.vapi.internal.bindings.Stub
implements BaseImages

Remote stub implementation of the BaseImages API service.

WARNING: Internal class, subject to change in future versions.

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 class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, securityContext

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

_VAPI_SERVICE_ID, RESOURCE_TYPE

Constructor Summary

Constructors

Constructor and Description
BaseImagesStub(ApiProvider apiProvider, StubConfigurationBase config)
BaseImagesStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

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.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BaseImagesStub

public BaseImagesStub(ApiProvider apiProvider,
                      com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                      StubConfigurationBase config)

BaseImagesStub

public BaseImagesStub(ApiProvider apiProvider,
                      StubConfigurationBase config)

Method Detail

list

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

Description copied from interface: BaseImages

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.

Specified by:

list in interface BaseImages

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.

list

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

Description copied from interface: BaseImages

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.

Specified by:

list in interface BaseImages

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.

list

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

Description copied from interface: BaseImages

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.

Specified by:

list in interface BaseImages

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

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

Description copied from interface: BaseImages

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.

Specified by:

list in interface BaseImages

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.