com.vmware.vcenter.deployment

Class UpgradeStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.deployment.UpgradeStub

All Implemented Interfaces:

Service, Upgrade, UpgradeTypes

public class UpgradeStub
extends com.vmware.vapi.internal.bindings.Stub
implements Upgrade

Remote stub implementation of the Upgrade API service.

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.deployment.UpgradeTypes

UpgradeTypes.PscSpec, UpgradeTypes.SourceApplianceSpec, UpgradeTypes.UpgradeSpec, UpgradeTypes.VcsaEmbeddedSpec

Field Summary

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

apiProvider, converter, ifaceId, securityContext

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cancel the appliance upgrade that is in progress.
void	cancel(AsyncCallback<java.lang.Void> asyncCallback) Cancel the appliance upgrade that is in progress.
void	cancel(AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Cancel the appliance upgrade that is in progress.
void	cancel(InvocationConfig invocationConfig) Cancel the appliance upgrade that is in progress.
CheckInfo	check(UpgradeTypes.UpgradeSpec spec) Run sanity checks using the UpgradeSpec parameters passed.
void	check(UpgradeTypes.UpgradeSpec spec, AsyncCallback<CheckInfo> asyncCallback) Run sanity checks using the UpgradeSpec parameters passed.
void	check(UpgradeTypes.UpgradeSpec spec, AsyncCallback<CheckInfo> asyncCallback, InvocationConfig invocationConfig) Run sanity checks using the UpgradeSpec parameters passed.
CheckInfo	check(UpgradeTypes.UpgradeSpec spec, InvocationConfig invocationConfig) Run sanity checks using the UpgradeSpec parameters passed.
UpgradeTypes.UpgradeSpec	get() Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.
void	get(AsyncCallback<UpgradeTypes.UpgradeSpec> asyncCallback) Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.
void	get(AsyncCallback<UpgradeTypes.UpgradeSpec> asyncCallback, InvocationConfig invocationConfig) Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.
UpgradeTypes.UpgradeSpec	get(InvocationConfig invocationConfig) Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.
void	start(UpgradeTypes.UpgradeSpec spec) Start the appliance installation.
void	start(UpgradeTypes.UpgradeSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Start the appliance installation.
void	start(UpgradeTypes.UpgradeSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Start the appliance installation.
void	start(UpgradeTypes.UpgradeSpec spec, InvocationConfig invocationConfig) Start the appliance installation.

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

UpgradeStub

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

UpgradeStub

public UpgradeStub(ApiProvider apiProvider,
           StubConfigurationBase config)

Method Detail

get

public UpgradeTypes.UpgradeSpec get()

Description copied from interface: Upgrade

Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade. 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 Upgrade

Returns:

UpgradeSpec parameters being used to configure appliance upgrade.

get

public UpgradeTypes.UpgradeSpec get(InvocationConfig invocationConfig)

Description copied from interface: Upgrade

Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade. 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 Upgrade

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

UpgradeSpec parameters being used to configure appliance upgrade.

get

public void get(AsyncCallback<UpgradeTypes.UpgradeSpec> asyncCallback)

Description copied from interface: Upgrade

Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade. 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:
UpgradeSpec parameters being used to configure appliance upgrade.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
NotAllowedInCurrentState - if appliance is not in UPGRADE_PROGRESS state.

Specified by:

get in interface Upgrade

Parameters:

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

get

public void get(AsyncCallback<UpgradeTypes.UpgradeSpec> asyncCallback,
       InvocationConfig invocationConfig)

Description copied from interface: Upgrade

Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade. 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:
UpgradeSpec parameters being used to configure appliance upgrade.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
NotAllowedInCurrentState - if appliance is not in UPGRADE_PROGRESS state.

Specified by:

get in interface Upgrade

Parameters:

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

invocationConfig - Configuration for the method invocation.

check

public CheckInfo check(UpgradeTypes.UpgradeSpec spec)

Description copied from interface: Upgrade

Run sanity checks using the UpgradeSpec parameters passed. 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:

check in interface Upgrade

Parameters:

spec - UpgradeSpec parameters to run sanity check on.

Returns:

CheckInfo containing the check results.

check

public CheckInfo check(UpgradeTypes.UpgradeSpec spec,
              InvocationConfig invocationConfig)

Description copied from interface: Upgrade

Run sanity checks using the UpgradeSpec parameters passed. 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:

check in interface Upgrade

Parameters:

spec - UpgradeSpec parameters to run sanity check on.

invocationConfig - Configuration for the method invocation.

Returns:

CheckInfo containing the check results.

check

public void check(UpgradeTypes.UpgradeSpec spec,
         AsyncCallback<CheckInfo> asyncCallback)

Description copied from interface: Upgrade

Run sanity checks using the UpgradeSpec parameters passed. 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:
CheckInfo containing the check results.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
Unauthenticated - if source credentials are not valid.
Unauthenticated - if source container credentials are not valid.
InvalidArgument - if passed arguments are invalid.
NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

Specified by:

check in interface Upgrade

Parameters:

spec - UpgradeSpec parameters to run sanity check on.

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

check

public void check(UpgradeTypes.UpgradeSpec spec,
         AsyncCallback<CheckInfo> asyncCallback,
         InvocationConfig invocationConfig)

Description copied from interface: Upgrade

Run sanity checks using the UpgradeSpec parameters passed. 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:
CheckInfo containing the check results.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
Unauthenticated - if source credentials are not valid.
Unauthenticated - if source container credentials are not valid.
InvalidArgument - if passed arguments are invalid.
NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

Specified by:

check in interface Upgrade

Parameters:

spec - UpgradeSpec parameters to run sanity check on.

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

invocationConfig - Configuration for the method invocation.

start

public void start(UpgradeTypes.UpgradeSpec spec)

Description copied from interface: Upgrade

Start the appliance installation. 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:

start in interface Upgrade

Parameters:

spec - UpgradeSpec parameters to configure the appliance upgrade.

start

public void start(UpgradeTypes.UpgradeSpec spec,
         InvocationConfig invocationConfig)

Description copied from interface: Upgrade

Start the appliance installation. 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:

start in interface Upgrade

Parameters:

spec - UpgradeSpec parameters to configure the appliance upgrade.

invocationConfig - Configuration for the method invocation.

start

public void start(UpgradeTypes.UpgradeSpec spec,
         AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Upgrade

Start the appliance installation. 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:
Unauthenticated - if the caller is not authenticated.
Unauthenticated - if source credentials are not valid.
Unauthenticated - if source container credentials are not valid.
InvalidArgument - if passed arguments are invalid.
NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

Specified by:

start in interface Upgrade

Parameters:

spec - UpgradeSpec parameters to configure the appliance upgrade.

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

start

public void start(UpgradeTypes.UpgradeSpec spec,
         AsyncCallback<java.lang.Void> asyncCallback,
         InvocationConfig invocationConfig)

Description copied from interface: Upgrade

Start the appliance installation. 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:
Unauthenticated - if the caller is not authenticated.
Unauthenticated - if source credentials are not valid.
Unauthenticated - if source container credentials are not valid.
InvalidArgument - if passed arguments are invalid.
NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

Specified by:

start in interface Upgrade

Parameters:

spec - UpgradeSpec parameters to configure the appliance upgrade.

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: Upgrade

Cancel the appliance upgrade that is 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 Upgrade

cancel

public void cancel(InvocationConfig invocationConfig)

Description copied from interface: Upgrade

Cancel the appliance upgrade that is 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 Upgrade

Parameters:

invocationConfig - Configuration for the method invocation.

cancel

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

Description copied from interface: Upgrade

Cancel the appliance upgrade that is 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:
Unauthenticated - if the caller is not authenticated.
NotAllowedInCurrentState - if the appliance is not in CONFIG_IN_PROGRESS state and if the operation is not INSTALL.

Specified by:

cancel in interface Upgrade

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: Upgrade

Cancel the appliance upgrade that is 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:
Unauthenticated - if the caller is not authenticated.
NotAllowedInCurrentState - if the appliance is not in CONFIG_IN_PROGRESS state and if the operation is not INSTALL.

Specified by:

cancel in interface Upgrade

Parameters:

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

invocationConfig - Configuration for the method invocation.