com.vmware.appliance

Interface Update

All Superinterfaces:

Service, UpdateTypes

All Known Implementing Classes:

UpdateStub

public interface Update
extends Service, UpdateTypes

The Update interface provides methods to get the status of the appliance update. This interface was added in vSphere API 6.7.

Nested Class Summary

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

UpdateTypes.Info, UpdateTypes.State

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.

Method Detail

get

UpdateTypes.Info get()

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.

Returns:

Info structure containing the status information about the appliance.

Throws:

Error - Generic error

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

get

UpdateTypes.Info get(InvocationConfig invocationConfig)

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.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

Info structure containing the status information about the appliance.

Throws:

Error - Generic error

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

get

void get(AsyncCallback<UpdateTypes.Info> asyncCallback)

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

Parameters:

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

get

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

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

cancel

void cancel()

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.

Throws:

Error - Generic error

NotAllowedInCurrentState - Current task is not cancellable

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

cancel

void cancel(InvocationConfig invocationConfig)

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.

Parameters:

invocationConfig - Configuration for the method invocation.

Throws:

Error - Generic error

NotAllowedInCurrentState - Current task is not cancellable

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

cancel

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

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

Parameters:

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

cancel

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

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

Parameters:

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

invocationConfig - Configuration for the method invocation.