com.vmware.appliance

Class UpdateStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.appliance.UpdateStub

All Implemented Interfaces:

Update, UpdateTypes, Service

public class UpdateStub
extends com.vmware.vapi.internal.bindings.Stub
implements Update

Remote stub implementation of the Update API service.

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.UpdateTypes

UpdateTypes.Info, UpdateTypes.State

Field Summary

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

apiProvider, converter, ifaceId, securityContext

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Request the cancellation the update operation that is currently in progress.
void	cancel(AsyncCallback<java.lang.Void> asyncCallback) Request the cancellation the update operation that is currently in progress.
void	cancel(AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Request the cancellation the update operation that is currently in progress.
void	cancel(InvocationConfig invocationConfig) Request the cancellation the update operation that is currently in progress.
UpdateTypes.Info	get() Gets the current status of the appliance update.
void	get(AsyncCallback<UpdateTypes.Info> asyncCallback) Gets the current status of the appliance update.
void	get(AsyncCallback<UpdateTypes.Info> asyncCallback, InvocationConfig invocationConfig) Gets the current status of the appliance update.
UpdateTypes.Info	get(InvocationConfig invocationConfig) Gets the current status of the appliance update.

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

UpdateStub

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

UpdateStub

public UpdateStub(ApiProvider apiProvider,
          StubConfigurationBase config)

Method Detail

get

public UpdateTypes.Info get()

Description copied from interface: Update

Gets the current status of the appliance update. This method was added in vSphere API 6.7.

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

Specified by:

get in interface Update

Returns:

Info structure containing the status information about the appliance.

get

public UpdateTypes.Info get(InvocationConfig invocationConfig)

Description copied from interface: Update

Gets the current status of the appliance update. This method was added in vSphere API 6.7.

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 Update

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

Info structure containing the status information about the appliance.

get

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

Description copied from interface: Update

Gets the current status of the appliance update. This method was added in vSphere API 6.7.

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

Operation Result:
Info structure containing the status information about the appliance.

Operation Errors:
Error - Generic error
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation

Specified by:

get in interface Update

Parameters:

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

get

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

Description copied from interface: Update

Gets the current status of the appliance update. This method was added in vSphere API 6.7.

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

Operation Result:
Info structure containing the status information about the appliance.

Operation Errors:
Error - Generic error
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation

Specified by:

get in interface Update

Parameters:

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

invocationConfig - Configuration for the method invocation.

cancel

public void cancel()

Description copied from interface: Update

Request the cancellation the update operation that is currently in progress. This method was added in vSphere API 6.7.

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

Specified by:

cancel in interface Update

cancel

public void cancel(InvocationConfig invocationConfig)

Description copied from interface: Update

Request the cancellation the update operation that is currently in progress. This method was added in vSphere API 6.7.

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:

cancel in interface Update

Parameters:

invocationConfig - Configuration for the method invocation.

cancel

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

Description copied from interface: Update

Request the cancellation the update operation that is currently in progress. This method was added in vSphere API 6.7.

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

Operation Errors:
Error - Generic error
NotAllowedInCurrentState - Current task is not cancellable
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation

Specified by:

cancel in interface Update

Parameters:

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

cancel

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

Description copied from interface: Update

Request the cancellation the update operation that is currently in progress. This method was added in vSphere API 6.7.

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:
Error - Generic error
NotAllowedInCurrentState - Current task is not cancellable
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation

Specified by:

cancel in interface Update

Parameters:

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

invocationConfig - Configuration for the method invocation.