com.vmware.esx.settings

Interface Depots

All Superinterfaces:

DepotsTypes, Service

All Known Implementing Classes:

DepotsStub

public interface Depots
extends Service, DepotsTypes

The Depots interface provides methods to manage Software Depots used during ESX lifecycle management.

Nested Class Summary

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

DepotsTypes._VAPI_OPERATIONS

Field Summary

Fields inherited from interface com.vmware.esx.settings.DepotsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	sync_Task() Syncs the metadata from the currently configured online or umds depots.
void	sync_Task(AsyncCallback<java.lang.String> asyncCallback) Syncs the metadata from the currently configured online or umds depots.
void	sync_Task(AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Syncs the metadata from the currently configured online or umds depots.
java.lang.String	sync_Task(InvocationConfig invocationConfig) Syncs the metadata from the currently configured online or umds depots.

Method Detail

sync_Task

java.lang.String sync_Task()

Syncs the metadata from the currently configured online or umds depots. If any umds depot is set, then metadata is downloaded from that depot else metadata is downloaded from the online depots. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Returns:

identifier for the task created by this API invocation

Throws:

Unauthenticated - if the caller is not authenticated.

ServiceUnavailable - if the service is not available.

TimedOut - if the service is timed out.

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

sync_Task

java.lang.String sync_Task(InvocationConfig invocationConfig)

Syncs the metadata from the currently configured online or umds depots. If any umds depot is set, then metadata is downloaded from that depot else metadata is downloaded from the online depots. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Unauthenticated - if the caller is not authenticated.

ServiceUnavailable - if the service is not available.

TimedOut - if the service is timed out.

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

sync_Task

void sync_Task(AsyncCallback<java.lang.String> asyncCallback)

Syncs the metadata from the currently configured online or umds depots. If any umds depot is set, then metadata is downloaded from that depot else metadata is downloaded from the online depots. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Unauthenticated - if the caller is not authenticated.
ServiceUnavailable - if the service is not available.
TimedOut - if the service is timed out.
Error - if there is some unknown internal error. The accompanying error message will give more details about the failure.

Parameters:

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

sync_Task

void sync_Task(AsyncCallback<java.lang.String> asyncCallback,
               InvocationConfig invocationConfig)

Syncs the metadata from the currently configured online or umds depots. If any umds depot is set, then metadata is downloaded from that depot else metadata is downloaded from the online depots. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Unauthenticated - if the caller is not authenticated.
ServiceUnavailable - if the service is not available.
TimedOut - if the service is timed out.
Error - if there is some unknown internal error. The accompanying error message will give more details about the failure.

Parameters:

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

invocationConfig - Configuration for the method invocation.