com.vmware.esx.settings.depot_content

Interface Components

All Superinterfaces:

ComponentsTypes, Service

All Known Implementing Classes:

ComponentsStub

public interface Components
extends Service, ComponentsTypes

The Components interface provides methods to get Components from the sync'ed and imported depots.

Nested Class Summary

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

ComponentsTypes.CategoryType, ComponentsTypes.ComponentBundleType, ComponentsTypes.ComponentVersionSummary, ComponentsTypes.FilterSpec, ComponentsTypes.Summary, ComponentsTypes.UrgencyType

Field Summary

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

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

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

Method Detail

list

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

Returns a list of currently available components in the depot.

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

Parameters:

filter - The specification of matching components. If null, the behavior is equivalent to a ComponentsTypes.FilterSpec with all properties null, which means ALL components match the filter.

Returns:

List of components in the depot.

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<ComponentsTypes.Summary> list(ComponentsTypes.FilterSpec filter,
                                             InvocationConfig invocationConfig)

Returns a list of currently available components 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 components. If null, the behavior is equivalent to a ComponentsTypes.FilterSpec with all properties null, which means ALL components match the filter.

invocationConfig - Configuration for the method invocation.

Returns:

List of components in the depot.

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(ComponentsTypes.FilterSpec filter,
          AsyncCallback<java.util.List<ComponentsTypes.Summary>> asyncCallback)

Returns a list of currently available components in the depot.

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

Invocation Result:
List of components in the depot.

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

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

list

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

Returns a list of currently available components 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 components in the depot.

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

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

invocationConfig - Configuration for the method invocation.