com.vmware.nsx.upgrade

Class PlanStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.upgrade.PlanStub

All Implemented Interfaces:

Plan, PlanTypes, com.vmware.vapi.bindings.Service

public class PlanStub
extends com.vmware.vapi.internal.bindings.Stub
implements Plan

Remote stub implementation of the Plan API service.

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

Field Summary

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

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.nsx.upgrade.PlanTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	continue_(java.lang.String componentType, java.lang.Boolean skip) Continue the upgrade.
void	continue_(java.lang.String componentType, java.lang.Boolean skip, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Continue the upgrade.
void	continue_(java.lang.String componentType, java.lang.Boolean skip, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Continue the upgrade.
void	continue_(java.lang.String componentType, java.lang.Boolean skip, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Continue the upgrade.
void	pause() Pause the upgrade.
void	pause(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Pause the upgrade.
void	pause(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Pause the upgrade.
void	pause(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Pause the upgrade.
void	reset(java.lang.String componentType) Reset the upgrade plan to default plan.
void	reset(java.lang.String componentType, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Reset the upgrade plan to default plan.
void	reset(java.lang.String componentType, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Reset the upgrade plan to default plan.
void	reset(java.lang.String componentType, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Reset the upgrade plan to default plan.
void	stageupgrade(java.lang.String componentType) This will stage the upgrade bits so that upgrade can be driven from outside NSX upgrade-coordinator.
void	stageupgrade(java.lang.String componentType, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) This will stage the upgrade bits so that upgrade can be driven from outside NSX upgrade-coordinator.
void	stageupgrade(java.lang.String componentType, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This will stage the upgrade bits so that upgrade can be driven from outside NSX upgrade-coordinator.
void	stageupgrade(java.lang.String componentType, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This will stage the upgrade bits so that upgrade can be driven from outside NSX upgrade-coordinator.
void	start(java.lang.String componentType) Start the upgrade.
void	start(java.lang.String componentType, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Start the upgrade.
void	start(java.lang.String componentType, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Start the upgrade.
void	start(java.lang.String componentType, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Start the upgrade.
void	upgrade(java.lang.String componentType) Depending on current upgrade state, start or continue the upgrade.
void	upgrade(java.lang.String componentType, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Depending on current upgrade state, start or continue the upgrade.
void	upgrade(java.lang.String componentType, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Depending on current upgrade state, start or continue the upgrade.
void	upgrade(java.lang.String componentType, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Depending on current upgrade state, start or continue the upgrade.
void	upgradeselectedunits(UpgradeUnitList upgradeUnitList) Upgrades, Resumes the upgrade of a selected set of units.
void	upgradeselectedunits(UpgradeUnitList upgradeUnitList, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Upgrades, Resumes the upgrade of a selected set of units.
void	upgradeselectedunits(UpgradeUnitList upgradeUnitList, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Upgrades, Resumes the upgrade of a selected set of units.
void	upgradeselectedunits(UpgradeUnitList upgradeUnitList, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Upgrades, Resumes the upgrade of a selected set of units.

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

PlanStub

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

PlanStub

public PlanStub(com.vmware.vapi.core.ApiProvider apiProvider,
                com.vmware.vapi.bindings.StubConfigurationBase config)

Method Detail

continue_

public void continue_(java.lang.String componentType,
                      java.lang.Boolean skip)

Description copied from interface: Plan

Continue the upgrade. Resumes the upgrade from the point where it was paused.

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

Specified by:

continue_ in interface Plan

Parameters:

componentType - Component to upgrade. (optional)

skip - Skip to upgrade of next component. (optional, default to false)

continue_

public void continue_(java.lang.String componentType,
                      java.lang.Boolean skip,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Plan

Continue the upgrade. Resumes the upgrade from the point where it was paused.

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:

continue_ in interface Plan

Parameters:

componentType - Component to upgrade. (optional)

skip - Skip to upgrade of next component. (optional, default to false)

invocationConfig - Configuration for the method invocation.

continue_

public void continue_(java.lang.String componentType,
                      java.lang.Boolean skip,
                      com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Plan

Continue the upgrade. Resumes the upgrade from the point where it was paused.

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

Operation Errors:
ConcurrentChange - Conflict
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

continue_ in interface Plan

Parameters:

componentType - Component to upgrade. (optional)

skip - Skip to upgrade of next component. (optional, default to false)

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

continue_

public void continue_(java.lang.String componentType,
                      java.lang.Boolean skip,
                      com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Plan

Continue the upgrade. Resumes the upgrade from the point where it was paused.

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:
ConcurrentChange - Conflict
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

continue_ in interface Plan

Parameters:

componentType - Component to upgrade. (optional)

skip - Skip to upgrade of next component. (optional, default to false)

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

invocationConfig - Configuration for the method invocation.

pause

public void pause()

Description copied from interface: Plan

Pause the upgrade. Upgrade will be paused after upgrade of all the nodes currently in progress is completed either successfully or with failure. User can make changes in the upgrade plan when the upgrade is paused.

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

Specified by:

pause in interface Plan

pause

public void pause(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Plan

Pause the upgrade. Upgrade will be paused after upgrade of all the nodes currently in progress is completed either successfully or with failure. User can make changes in the upgrade plan when the upgrade is paused.

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:

pause in interface Plan

Parameters:

invocationConfig - Configuration for the method invocation.

pause

public void pause(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Plan

Pause the upgrade. Upgrade will be paused after upgrade of all the nodes currently in progress is completed either successfully or with failure. User can make changes in the upgrade plan when the upgrade is paused.

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

Operation Errors:
ConcurrentChange - Conflict
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

pause in interface Plan

Parameters:

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

pause

public void pause(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Plan

Pause the upgrade. Upgrade will be paused after upgrade of all the nodes currently in progress is completed either successfully or with failure. User can make changes in the upgrade plan when the upgrade is paused.

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:
ConcurrentChange - Conflict
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

pause in interface Plan

Parameters:

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

invocationConfig - Configuration for the method invocation.

reset

public void reset(java.lang.String componentType)

Description copied from interface: Plan

Reset the upgrade plan to default plan. User has an option to change the default plan. But if after making changes, user wants to go back to the default plan, this is the way to do so.

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

Specified by:

reset in interface Plan

Parameters:

componentType - Component type (required)

reset

public void reset(java.lang.String componentType,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Plan

Reset the upgrade plan to default plan. User has an option to change the default plan. But if after making changes, user wants to go back to the default plan, this is the way to do so.

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:

reset in interface Plan

Parameters:

componentType - Component type (required)

invocationConfig - Configuration for the method invocation.

reset

public void reset(java.lang.String componentType,
                  com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Plan

Reset the upgrade plan to default plan. User has an option to change the default plan. But if after making changes, user wants to go back to the default plan, this is the way to do so.

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

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

reset in interface Plan

Parameters:

componentType - Component type (required)

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

reset

public void reset(java.lang.String componentType,
                  com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Plan

Reset the upgrade plan to default plan. User has an option to change the default plan. But if after making changes, user wants to go back to the default plan, this is the way to do so.

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:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

reset in interface Plan

Parameters:

componentType - Component type (required)

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

invocationConfig - Configuration for the method invocation.

stageupgrade

public void stageupgrade(java.lang.String componentType)

Description copied from interface: Plan

This will stage the upgrade bits so that upgrade can be driven from outside NSX upgrade-coordinator. If component type is not provided as a request parameter then upgrade staging will be performed on all the components.

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

Specified by:

stageupgrade in interface Plan

Parameters:

componentType - Component type (optional)

stageupgrade

public void stageupgrade(java.lang.String componentType,
                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Plan

This will stage the upgrade bits so that upgrade can be driven from outside NSX upgrade-coordinator. If component type is not provided as a request parameter then upgrade staging will be performed on all the components.

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:

stageupgrade in interface Plan

Parameters:

componentType - Component type (optional)

invocationConfig - Configuration for the method invocation.

stageupgrade

public void stageupgrade(java.lang.String componentType,
                         com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Plan

This will stage the upgrade bits so that upgrade can be driven from outside NSX upgrade-coordinator. If component type is not provided as a request parameter then upgrade staging will be performed on all the components.

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

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

stageupgrade in interface Plan

Parameters:

componentType - Component type (optional)

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

stageupgrade

public void stageupgrade(java.lang.String componentType,
                         com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Plan

This will stage the upgrade bits so that upgrade can be driven from outside NSX upgrade-coordinator. If component type is not provided as a request parameter then upgrade staging will be performed on all the components.

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:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

stageupgrade in interface Plan

Parameters:

componentType - Component type (optional)

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

invocationConfig - Configuration for the method invocation.

start

public void start(java.lang.String componentType)

Description copied from interface: Plan

Start the upgrade. Upgrade will start as per the upgrade plan.

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

Specified by:

start in interface Plan

Parameters:

componentType - Type of the component (optional)

start

public void start(java.lang.String componentType,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Plan

Start the upgrade. Upgrade will start as per the upgrade plan.

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 Plan

Parameters:

componentType - Type of the component (optional)

invocationConfig - Configuration for the method invocation.

start

public void start(java.lang.String componentType,
                  com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Plan

Start the upgrade. Upgrade will start as per the upgrade plan.

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

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

start in interface Plan

Parameters:

componentType - Type of the component (optional)

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

start

public void start(java.lang.String componentType,
                  com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Plan

Start the upgrade. Upgrade will start as per the upgrade plan.

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:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

start in interface Plan

Parameters:

componentType - Type of the component (optional)

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

invocationConfig - Configuration for the method invocation.

upgrade

public void upgrade(java.lang.String componentType)

Description copied from interface: Plan

Depending on current upgrade state, start or continue the upgrade.

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

Specified by:

upgrade in interface Plan

Parameters:

componentType - Type of the component (optional)

upgrade

public void upgrade(java.lang.String componentType,
                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Plan

Depending on current upgrade state, start or continue the upgrade.

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:

upgrade in interface Plan

Parameters:

componentType - Type of the component (optional)

invocationConfig - Configuration for the method invocation.

upgrade

public void upgrade(java.lang.String componentType,
                    com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Plan

Depending on current upgrade state, start or continue the upgrade.

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

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

upgrade in interface Plan

Parameters:

componentType - Type of the component (optional)

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

upgrade

public void upgrade(java.lang.String componentType,
                    com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Plan

Depending on current upgrade state, start or continue the upgrade.

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:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

upgrade in interface Plan

Parameters:

componentType - Type of the component (optional)

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

invocationConfig - Configuration for the method invocation.

upgradeselectedunits

public void upgradeselectedunits(UpgradeUnitList upgradeUnitList)

Description copied from interface: Plan

Upgrades, Resumes the upgrade of a selected set of units.

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

Specified by:

upgradeselectedunits in interface Plan

Parameters:

upgradeUnitList - (required)

upgradeselectedunits

public void upgradeselectedunits(UpgradeUnitList upgradeUnitList,
                                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Plan

Upgrades, Resumes the upgrade of a selected set of units.

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:

upgradeselectedunits in interface Plan

Parameters:

upgradeUnitList - (required)

invocationConfig - Configuration for the method invocation.

upgradeselectedunits

public void upgradeselectedunits(UpgradeUnitList upgradeUnitList,
                                 com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Plan

Upgrades, Resumes the upgrade of a selected set of units.

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

Operation Errors:
ConcurrentChange - Conflict
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

upgradeselectedunits in interface Plan

Parameters:

upgradeUnitList - (required)

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

upgradeselectedunits

public void upgradeselectedunits(UpgradeUnitList upgradeUnitList,
                                 com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Plan

Upgrades, Resumes the upgrade of a selected set of units.

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:
ConcurrentChange - Conflict
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

upgradeselectedunits in interface Plan

Parameters:

upgradeUnitList - (required)

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

invocationConfig - Configuration for the method invocation.