com.vmware.esx.settings.depots

Class UmdsStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.esx.settings.depots.UmdsStub

All Implemented Interfaces:

Umds, UmdsTypes, Service

public class UmdsStub
extends com.vmware.vapi.internal.bindings.Stub
implements Umds

Remote stub implementation of the Umds 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.UmdsTypes

UmdsTypes.Info, UmdsTypes.SetSpec, UmdsTypes.UpdateSpec

Field Summary

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

apiProvider, converter, ifaceId, retryPolicy, securityContext

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

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	delete() Removes the configured UMDS software depot.
void	delete(AsyncCallback<java.lang.Void> asyncCallback) Removes the configured UMDS software depot.
void	delete(AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Removes the configured UMDS software depot.
void	delete(InvocationConfig invocationConfig) Removes the configured UMDS software depot.
UmdsTypes.Info	get() Gets the information about a currently configured UMDS software depot.
void	get(AsyncCallback<UmdsTypes.Info> asyncCallback) Gets the information about a currently configured UMDS software depot.
void	get(AsyncCallback<UmdsTypes.Info> asyncCallback, InvocationConfig invocationConfig) Gets the information about a currently configured UMDS software depot.
UmdsTypes.Info	get(InvocationConfig invocationConfig) Gets the information about a currently configured UMDS software depot.
void	set(UmdsTypes.SetSpec spec) Sets or overwrites information about an UMDS software depot.
void	set(UmdsTypes.SetSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Sets or overwrites information about an UMDS software depot.
void	set(UmdsTypes.SetSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Sets or overwrites information about an UMDS software depot.
void	set(UmdsTypes.SetSpec spec, InvocationConfig invocationConfig) Sets or overwrites information about an UMDS software depot.
void	update(UmdsTypes.UpdateSpec spec) Updates the configuration of a currently configured UMDS software depot.
void	update(UmdsTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Updates the configuration of a currently configured UMDS software depot.
void	update(UmdsTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Updates the configuration of a currently configured UMDS software depot.
void	update(UmdsTypes.UpdateSpec spec, InvocationConfig invocationConfig) Updates the configuration of a currently configured UMDS software depot.

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

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

UmdsStub

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

UmdsStub

public UmdsStub(ApiProvider apiProvider,
                StubConfigurationBase config)

Method Detail

get

public UmdsTypes.Info get()

Description copied from interface: Umds

Gets the information about a currently configured UMDS software depot.

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

Specified by:

get in interface Umds

Returns:

Information of the currently configured UMDS software depot.

get

public UmdsTypes.Info get(InvocationConfig invocationConfig)

Description copied from interface: Umds

Gets the information about a currently configured UMDS 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 Umds

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

Information of the currently configured UMDS software depot.

get

public void get(AsyncCallback<UmdsTypes.Info> asyncCallback)

Description copied from interface: Umds

Gets the information about a currently configured UMDS software depot.

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

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

Operation Errors:
Unauthenticated - if the caller is not authenticated.
NotFound - If there is no UMDS software depot set.
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 Umds

Parameters:

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

get

public void get(AsyncCallback<UmdsTypes.Info> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Umds

Gets the information about a currently configured UMDS 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 UMDS software depot.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
NotFound - If there is no UMDS software depot set.
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 Umds

Parameters:

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

invocationConfig - Configuration for the method invocation.

set

public void set(UmdsTypes.SetSpec spec)

Description copied from interface: Umds

Sets or overwrites information about an UMDS software depot.

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

Specified by:

set in interface Umds

set

public void set(UmdsTypes.SetSpec spec,
                InvocationConfig invocationConfig)

Description copied from interface: Umds

Sets or overwrites information about an UMDS 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:

set in interface Umds

invocationConfig - Configuration for the method invocation.

set

public void set(UmdsTypes.SetSpec spec,
                AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Umds

Sets or overwrites information about an UMDS 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 an invalid location is provided.
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:

set in interface Umds

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

set

public void set(UmdsTypes.SetSpec spec,
                AsyncCallback<java.lang.Void> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Umds

Sets or overwrites information about an UMDS 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 an invalid location is provided.
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:

set in interface Umds

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

invocationConfig - Configuration for the method invocation.

delete

public void delete()

Description copied from interface: Umds

Removes the configured UMDS software depot. 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 Umds

delete

public void delete(InvocationConfig invocationConfig)

Description copied from interface: Umds

Removes the configured UMDS software depot. 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 Umds

Parameters:

invocationConfig - Configuration for the method invocation.

delete

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

Description copied from interface: Umds

Removes the configured UMDS software depot. 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.
NotFound - If there is no UMDS software depot set.
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 Umds

Parameters:

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

delete

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

Description copied from interface: Umds

Removes the configured UMDS software depot. 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.
NotFound - If there is no UMDS software depot set.
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 Umds

Parameters:

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

invocationConfig - Configuration for the method invocation.

update

public void update(UmdsTypes.UpdateSpec spec)

Description copied from interface: Umds

Updates the configuration of a currently configured UMDS software depot.

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

Specified by:

update in interface Umds

Parameters:

spec - Update specification.

update

public void update(UmdsTypes.UpdateSpec spec,
                   InvocationConfig invocationConfig)

Description copied from interface: Umds

Updates the configuration of a currently configured UMDS 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 Umds

Parameters:

spec - Update specification.

invocationConfig - Configuration for the method invocation.

update

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

Description copied from interface: Umds

Updates the configuration of a currently configured UMDS 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.
NotFound - If there is no UMDS depot configured.
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 Umds

Parameters:

spec - Update specification.

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

update

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

Description copied from interface: Umds

Updates the configuration of a currently configured UMDS 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.
NotFound - If there is no UMDS depot configured.
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 Umds

Parameters:

spec - Update specification.

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

invocationConfig - Configuration for the method invocation.