com.vmware.vcenter.deployment

Class InstallStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.deployment.InstallStub

All Implemented Interfaces:

Service, Install, InstallTypes

public class InstallStub
extends com.vmware.vapi.internal.bindings.Stub
implements Install

Remote stub implementation of the Install API service.

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

Nested Class Summary

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

InstallTypes.InstallSpec, InstallTypes.VcsaEmbeddedSpec

Field Summary

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

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.vcenter.deployment.InstallTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

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

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

InstallStub

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

InstallStub

public InstallStub(ApiProvider apiProvider,
                   StubConfigurationBase config)

Method Detail

get

public InstallTypes.InstallSpec get()

Description copied from interface: Install

Get the parameters used to configure the ongoing 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:

get in interface Install

Returns:

InstallSpec parameters being used to configure appliance install.

get

public InstallTypes.InstallSpec get(InvocationConfig invocationConfig)

Description copied from interface: Install

Get the parameters used to configure the ongoing 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:

get in interface Install

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

InstallSpec parameters being used to configure appliance install.

get

public void get(AsyncCallback<InstallTypes.InstallSpec> asyncCallback)

Description copied from interface: Install

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

Invocation Result:
InstallSpec parameters being used to configure appliance install.

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

Specified by:

get in interface Install

Parameters:

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

get

public void get(AsyncCallback<InstallTypes.InstallSpec> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Install

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

Invocation Result:
InstallSpec parameters being used to configure appliance install.

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

Specified by:

get in interface Install

Parameters:

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

invocationConfig - Configuration for the method invocation.

check

public CheckInfo check(InstallTypes.InstallSpec spec)

Description copied from interface: Install

Run sanity checks using the InstallSpec 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 Install

Parameters:

spec - InstallSpec parameters to run sanity check with.

Returns:

CheckInfo containing the check results.

check

public CheckInfo check(InstallTypes.InstallSpec spec,
                       InvocationConfig invocationConfig)

Description copied from interface: Install

Run sanity checks using the InstallSpec 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 Install

Parameters:

spec - InstallSpec parameters to run sanity check with.

invocationConfig - Configuration for the method invocation.

Returns:

CheckInfo containing the check results.

check

public void check(InstallTypes.InstallSpec spec,
                  AsyncCallback<CheckInfo> asyncCallback)

Description copied from interface: Install

Run sanity checks using the InstallSpec 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.

Invocation Result:
CheckInfo containing the check results.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
Unauthenticated - if external PSC credentials are not valid when configuring PSC to replicate with an external existing PSC.
Unauthenticated - if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.
InvalidArgument - if passed arguments are invalid.
NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

Specified by:

check in interface Install

Parameters:

spec - InstallSpec parameters to run sanity check with.

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

check

public void check(InstallTypes.InstallSpec spec,
                  AsyncCallback<CheckInfo> asyncCallback,
                  InvocationConfig invocationConfig)

Description copied from interface: Install

Run sanity checks using the InstallSpec 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.

Invocation Result:
CheckInfo containing the check results.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
Unauthenticated - if external PSC credentials are not valid when configuring PSC to replicate with an external existing PSC.
Unauthenticated - if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.
InvalidArgument - if passed arguments are invalid.
NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

Specified by:

check in interface Install

Parameters:

spec - InstallSpec parameters to run sanity check with.

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

invocationConfig - Configuration for the method invocation.

start

public void start(InstallTypes.InstallSpec spec)

Description copied from interface: Install

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 Install

Parameters:

spec - InstallSpec parameters to configure the appliance install.

start

public void start(InstallTypes.InstallSpec spec,
                  InvocationConfig invocationConfig)

Description copied from interface: Install

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 Install

Parameters:

spec - InstallSpec parameters to configure the appliance install.

invocationConfig - Configuration for the method invocation.

start

public void start(InstallTypes.InstallSpec spec,
                  AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Install

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 the partner PSC credentials are not valid when configuring PSC to replicate with partner PSC.
Unauthenticated - if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.
InvalidArgument - if passed arguments are invalid.
NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

Specified by:

start in interface Install

Parameters:

spec - InstallSpec parameters to configure the appliance install.

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

start

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

Description copied from interface: Install

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 the partner PSC credentials are not valid when configuring PSC to replicate with partner PSC.
Unauthenticated - if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.
InvalidArgument - if passed arguments are invalid.
NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

Specified by:

start in interface Install

Parameters:

spec - InstallSpec parameters to configure the appliance install.

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

Cancel the appliance installation 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 Install

cancel

public void cancel(InvocationConfig invocationConfig)

Description copied from interface: Install

Cancel the appliance installation 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 Install

Parameters:

invocationConfig - Configuration for the method invocation.

cancel

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

Description copied from interface: Install

Cancel the appliance installation 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 Install

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

Cancel the appliance installation 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 Install

Parameters:

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

invocationConfig - Configuration for the method invocation.