com.vmware.esx.settings.depots

Class OnlineStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.esx.settings.depots.OnlineStub

All Implemented Interfaces:

Online, OnlineTypes, Service

public class OnlineStub
extends com.vmware.vapi.internal.bindings.Stub
implements Online

Remote stub implementation of the Online API service.

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

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

apiProvider, converter, ifaceId, securityContext

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

_VAPI_SERVICE_ID, RESOURCE_TYPE

Constructor Summary

Constructors

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

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.

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

OnlineStub

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

OnlineStub

public OnlineStub(ApiProvider apiProvider,
                  StubConfigurationBase config)

Method Detail

list

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

Description copied from interface: Online

Returns a list of currently configured online software depots.

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

Specified by:

list in interface Online

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.

list

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

Description copied from interface: Online

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.

Specified by:

list in interface Online

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.

list

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

Description copied from interface: Online

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.

Specified by:

list in interface Online

Parameters:

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

list

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

Description copied from interface: Online

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.

Specified by:

list in interface Online

Parameters:

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

invocationConfig - Configuration for the method invocation.

get

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

Description copied from interface: Online

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.

Specified by:

get in interface Online

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.

get

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

Description copied from interface: Online

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.

Specified by:

get in interface Online

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.

get

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

Description copied from interface: Online

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.

Specified by:

get in interface Online

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

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

Description copied from interface: Online

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.

Specified by:

get in interface Online

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

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

Description copied from interface: Online

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.

Specified by:

create in interface Online

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.

create

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

Description copied from interface: Online

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.

Specified by:

create in interface Online

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.

create

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

Description copied from interface: Online

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.

Specified by:

create in interface Online

Parameters:

spec - Depot information.

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

create

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

Description copied from interface: Online

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.

Specified by:

create in interface Online

Parameters:

spec - Depot information.

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

invocationConfig - Configuration for the method invocation.

delete

public void delete(java.lang.String depot)

Description copied from interface: Online

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.

Specified by:

delete in interface Online

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.

delete

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

Description copied from interface: Online

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.

Specified by:

delete in interface Online

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.

delete

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

Description copied from interface: Online

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.

Specified by:

delete in interface Online

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

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

Description copied from interface: Online

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.

Specified by:

delete in interface Online

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

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

Description copied from interface: Online

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.

Specified by:

update in interface Online

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.

update

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

Description copied from interface: Online

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.

Specified by:

update in interface Online

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.

update

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

Description copied from interface: Online

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.

Specified by:

update in interface Online

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

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

Description copied from interface: Online

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.

Specified by:

update in interface Online

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.