com.vmware.appliance.update

Interface Staged

All Superinterfaces:

Service, StagedTypes

All Known Implementing Classes:

StagedStub

public interface Staged
extends Service, StagedTypes

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.update.StagedTypes

StagedTypes.Info

Field Summary

Fields inherited from interface com.vmware.appliance.update.StagedTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes the staged update.
void	delete(AsyncCallback<java.lang.Void> asyncCallback) Deletes the staged update.
void	delete(AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deletes the staged update.
void	delete(InvocationConfig invocationConfig) Deletes the staged update.
StagedTypes.Info	get() Gets the current status of the staged update.
void	get(AsyncCallback<StagedTypes.Info> asyncCallback) Gets the current status of the staged update.
void	get(AsyncCallback<StagedTypes.Info> asyncCallback, InvocationConfig invocationConfig) Gets the current status of the staged update.
StagedTypes.Info	get(InvocationConfig invocationConfig) Gets the current status of the staged update.

Method Detail

get

StagedTypes.Info get()

Gets the current status of the staged 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 with information about staged update

Throws:

Error - Generic error

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

NotAllowedInCurrentState - if nothing is staged

get

StagedTypes.Info get(InvocationConfig invocationConfig)

Gets the current status of the staged 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 with information about staged update

Throws:

Error - Generic error

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

NotAllowedInCurrentState - if nothing is staged

get

void get(AsyncCallback<StagedTypes.Info> asyncCallback)

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

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

Invocation Result:
Info structure with information about staged update

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

Parameters:

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

get

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

Gets the current status of the staged 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.

Invocation Result:
Info structure with information about staged update

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

delete

void delete()

Deletes the staged 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.

Throws:

Error - Generic error

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

delete

void delete(InvocationConfig invocationConfig)

Deletes the staged 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.

Throws:

Error - Generic error

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

delete

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

Deletes the staged 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 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.

delete

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

Deletes the staged 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 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.