com.vmware.esx.settings.depots

Interface Online

All Superinterfaces:

OnlineTypes, Service

All Known Implementing Classes:

OnlineStub

public interface Online
extends Service, OnlineTypes

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

Nested Class Summary

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

OnlineTypes.CreateSpec, OnlineTypes.Info, OnlineTypes.Summary, OnlineTypes.UpdateSpec

Field Summary

Fields inherited from interface com.vmware.esx.settings.depots.OnlineTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
java.lang.String	create(OnlineTypes.CreateSpec spec) Adds a new online software depot to the list of currently configured online software depots.
void	create(OnlineTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Adds a new online software depot to the list of currently configured online software depots.
void	create(OnlineTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Adds a new online software depot to the list of currently configured online software depots.
java.lang.String	create(OnlineTypes.CreateSpec spec, InvocationConfig invocationConfig) Adds a new online software depot to the list of currently configured online software depots.
void	delete(java.lang.String depot) Removes a depot from the list of currently configured online software depots.
void	delete(java.lang.String depot, AsyncCallback<java.lang.Void> asyncCallback) Removes a depot from the list of currently configured online software depots.
void	delete(java.lang.String depot, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Removes a depot from the list of currently configured online software depots.
void	delete(java.lang.String depot, InvocationConfig invocationConfig) Removes a depot from the list of currently configured online software depots.
OnlineTypes.Info	get(java.lang.String depot) Gets the information about a currently configured online software depot.
void	get(java.lang.String depot, AsyncCallback<OnlineTypes.Info> asyncCallback) Gets the information about a currently configured online software depot.
void	get(java.lang.String depot, AsyncCallback<OnlineTypes.Info> asyncCallback, InvocationConfig invocationConfig) Gets the information about a currently configured online software depot.
OnlineTypes.Info	get(java.lang.String depot, InvocationConfig invocationConfig) Gets the information about a currently configured online software depot.
java.util.Map<java.lang.String,OnlineTypes.Summary>	list() Returns a list of currently configured online software depots.
void	list(AsyncCallback<java.util.Map<java.lang.String,OnlineTypes.Summary>> asyncCallback) Returns a list of currently configured online software depots.
void	list(AsyncCallback<java.util.Map<java.lang.String,OnlineTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns a list of currently configured online software depots.
java.util.Map<java.lang.String,OnlineTypes.Summary>	list(InvocationConfig invocationConfig) Returns a list of currently configured online software depots.
void	update(java.lang.String depot, OnlineTypes.UpdateSpec spec) Updates the configuration of a currently configured online software depot.
void	update(java.lang.String depot, OnlineTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Updates the configuration of a currently configured online software depot.
void	update(java.lang.String depot, OnlineTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Updates the configuration of a currently configured online software depot.
void	update(java.lang.String depot, OnlineTypes.UpdateSpec spec, InvocationConfig invocationConfig) Updates the configuration of a currently configured online software depot.

Method Detail

list

java.util.Map<java.lang.String,OnlineTypes.Summary> list()

Returns a list of currently configured online software depots.

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

Returns:

Map of currently configured online software depots keyed by their identifiers. The key in the return value Map will be an identifier for the resource type: com.vmware.esx.settings.depots.online.

Throws:

Unauthenticated - if the caller is not authenticated.

ServiceUnavailable - If the service is not available.

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

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

• Method execution requires VcIntegrity.lifecycleSettings.Read.

list

java.util.Map<java.lang.String,OnlineTypes.Summary> list(InvocationConfig invocationConfig)

Returns a list of currently configured online software depots.

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:

invocationConfig - Configuration for the method invocation.

Returns:

Map of currently configured online software depots keyed by their identifiers. The key in the return value Map will be an identifier for the resource type: com.vmware.esx.settings.depots.online.

Throws:

Unauthenticated - if the caller is not authenticated.

ServiceUnavailable - If the service is not available.

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

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

• Method execution requires VcIntegrity.lifecycleSettings.Read.

list

void list(AsyncCallback<java.util.Map<java.lang.String,OnlineTypes.Summary>> asyncCallback)

Returns a list of currently configured online software depots.

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

Invocation Result:
Map of currently configured online software depots keyed by their identifiers. The key in the return value Map will be an identifier for the resource type: com.vmware.esx.settings.depots.online.

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

• Method execution requires VcIntegrity.lifecycleSettings.Read.

Parameters:

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

list

void list(AsyncCallback<java.util.Map<java.lang.String,OnlineTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Returns a list of currently configured online software depots.

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:
Map of currently configured online software depots keyed by their identifiers. The key in the return value Map will be an identifier for the resource type: com.vmware.esx.settings.depots.online.

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

• Method execution requires VcIntegrity.lifecycleSettings.Read.

Parameters:

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

invocationConfig - Configuration for the method invocation.

get

OnlineTypes.Info get(java.lang.String depot)

Gets the information about a currently configured online software depot.

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

Parameters:

depot - Identifier for the depot. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online.

Returns:

Information of the currently configured online software depot.

Throws:

Unauthenticated - if the caller is not authenticated.

NotFound - If there is no depot with given identifier depot in the system.

ServiceUnavailable - If the service is not available.

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

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

• Method execution requires VcIntegrity.lifecycleSettings.Read.

get

OnlineTypes.Info get(java.lang.String depot,
                     InvocationConfig invocationConfig)

Gets the information about a currently configured online software 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:

depot - Identifier for the depot. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online.

invocationConfig - Configuration for the method invocation.

Returns:

Information of the currently configured online software depot.

Throws:

Unauthenticated - if the caller is not authenticated.

NotFound - If there is no depot with given identifier depot in the system.

ServiceUnavailable - If the service is not available.

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

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

• Method execution requires VcIntegrity.lifecycleSettings.Read.

get

void get(java.lang.String depot,
         AsyncCallback<OnlineTypes.Info> asyncCallback)

Gets the information about a currently configured online software depot.

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

Invocation Result:
Information of the currently configured online software depot.

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

• Method execution requires VcIntegrity.lifecycleSettings.Read.

Parameters:

depot - Identifier for the depot. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online.

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

get

void get(java.lang.String depot,
         AsyncCallback<OnlineTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Gets the information about a currently configured online software 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:
Information of the currently configured online software depot.

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

• Method execution requires VcIntegrity.lifecycleSettings.Read.

Parameters:

depot - Identifier for the depot. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online.

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

invocationConfig - Configuration for the method invocation.

create

java.lang.String create(OnlineTypes.CreateSpec spec)

Adds a new online software depot to the list of currently configured online software depots.

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

Parameters:

spec - Depot information.

Returns:

Identifier of the currently configured online software depot. The return value will be an identifier for the resource type: com.vmware.esx.settings.depots.online.

Throws:

Unauthenticated - if the caller is not authenticated.

InvalidArgument - If an invalid location is provided.

AlreadyExists - if depot with given location already exists.

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

ServiceUnavailable - If the service is not available.

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

• Method execution requires VcIntegrity.lifecycleSettings.Write.

create

java.lang.String create(OnlineTypes.CreateSpec spec,
                        InvocationConfig invocationConfig)

Adds a new online software depot to the list of currently configured online software depots.

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:

spec - Depot information.

invocationConfig - Configuration for the method invocation.

Returns:

Identifier of the currently configured online software depot. The return value will be an identifier for the resource type: com.vmware.esx.settings.depots.online.

Throws:

Unauthenticated - if the caller is not authenticated.

InvalidArgument - If an invalid location is provided.

AlreadyExists - if depot with given location already exists.

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

ServiceUnavailable - If the service is not available.

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

• Method execution requires VcIntegrity.lifecycleSettings.Write.

create

void create(OnlineTypes.CreateSpec spec,
            AsyncCallback<java.lang.String> asyncCallback)

Adds a new online software depot to the list of currently configured online software depots.

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

Invocation Result:
Identifier of the currently configured online software depot. The return value will be an identifier for the resource type: com.vmware.esx.settings.depots.online.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
InvalidArgument - If an invalid location is provided.
AlreadyExists - if depot with given location already exists.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
ServiceUnavailable - If the service is not available.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

Parameters:

spec - Depot information.

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

create

void create(OnlineTypes.CreateSpec spec,
            AsyncCallback<java.lang.String> asyncCallback,
            InvocationConfig invocationConfig)

Adds a new online software depot to the list of currently configured online software depots.

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:
Identifier of the currently configured online software depot. The return value will be an identifier for the resource type: com.vmware.esx.settings.depots.online.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
InvalidArgument - If an invalid location is provided.
AlreadyExists - if depot with given location already exists.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
ServiceUnavailable - If the service is not available.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

Parameters:

spec - Depot information.

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String depot)

Removes a depot from the list of currently configured online software depots. It will not remove the downloaded metadata and payloads from that depot.

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

Parameters:

depot - Identifier of the depot to be removed. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online.

Throws:

Unauthenticated - if the caller is not authenticated.

InvalidArgument - If given depot is system defined.

NotFound - If there is no depot associated with depot in the system.

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

ServiceUnavailable - If the service is not available.

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

• Method execution requires VcIntegrity.lifecycleSettings.Write.

delete

void delete(java.lang.String depot,
            InvocationConfig invocationConfig)

Removes a depot from the list of currently configured online software depots. It will not remove the downloaded metadata and payloads from that 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:

depot - Identifier of the depot to be removed. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online.

invocationConfig - Configuration for the method invocation.

Throws:

Unauthenticated - if the caller is not authenticated.

InvalidArgument - If given depot is system defined.

NotFound - If there is no depot associated with depot in the system.

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

ServiceUnavailable - If the service is not available.

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

• Method execution requires VcIntegrity.lifecycleSettings.Write.

delete

void delete(java.lang.String depot,
            AsyncCallback<java.lang.Void> asyncCallback)

Removes a depot from the list of currently configured online software depots. It will not remove the downloaded metadata and payloads from that depot.

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

Operation Errors:
Unauthenticated - if the caller is not authenticated.
InvalidArgument - If given depot is system defined.
NotFound - If there is no depot associated with depot in the system.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
ServiceUnavailable - If the service is not available.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

Parameters:

depot - Identifier of the depot to be removed. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online.

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

delete

void delete(java.lang.String depot,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Removes a depot from the list of currently configured online software depots. It will not remove the downloaded metadata and payloads from that depot.

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

Operation Errors:
Unauthenticated - if the caller is not authenticated.
InvalidArgument - If given depot is system defined.
NotFound - If there is no depot associated with depot in the system.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
ServiceUnavailable - If the service is not available.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

Parameters:

depot - Identifier of the depot to be removed. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online.

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

invocationConfig - Configuration for the method invocation.

update

void update(java.lang.String depot,
            OnlineTypes.UpdateSpec spec)

Updates the configuration of a currently configured online software depot.

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

Parameters:

depot - Identifier of the depot to be updated. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online.

spec - Update specification.

Throws:

Unauthenticated - if the caller is not authenticated.

InvalidArgument - If given depot is system defined.

NotFound - If there is no depot associated with parameter depot in the system.

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

ServiceUnavailable - If the service is not available.

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

• Method execution requires VcIntegrity.lifecycleSettings.Write.

update

void update(java.lang.String depot,
            OnlineTypes.UpdateSpec spec,
            InvocationConfig invocationConfig)

Updates the configuration of a currently configured online software 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:

depot - Identifier of the depot to be updated. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online.

spec - Update specification.

invocationConfig - Configuration for the method invocation.

Throws:

Unauthenticated - if the caller is not authenticated.

InvalidArgument - If given depot is system defined.

NotFound - If there is no depot associated with parameter depot in the system.

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

ServiceUnavailable - If the service is not available.

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

• Method execution requires VcIntegrity.lifecycleSettings.Write.

update

void update(java.lang.String depot,
            OnlineTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback)

Updates the configuration of a currently configured online software depot.

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

Operation Errors:
Unauthenticated - if the caller is not authenticated.
InvalidArgument - If given depot is system defined.
NotFound - If there is no depot associated with parameter depot in the system.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
ServiceUnavailable - If the service is not available.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

Parameters:

depot - Identifier of the depot to be updated. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online.

spec - Update specification.

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

update

void update(java.lang.String depot,
            OnlineTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Updates the configuration of a currently configured online software depot.

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

Operation Errors:
Unauthenticated - if the caller is not authenticated.
InvalidArgument - If given depot is system defined.
NotFound - If there is no depot associated with parameter depot in the system.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
ServiceUnavailable - If the service is not available.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

Parameters:

depot - Identifier of the depot to be updated. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online.

spec - Update specification.

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

invocationConfig - Configuration for the method invocation.