ComponentUpgradeStatus (Java SDK for NSX Manager API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx.model.ComponentUpgradeStatus

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class ComponentUpgradeStatus
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ComponentUpgradeStatus.Builder
Builder class for ComponentUpgradeStatus.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ComponentUpgradeStatus.Builder` Builder class for `ComponentUpgradeStatus`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`STATUS_FAILED`
`static java.lang.String`	`STATUS_IN_PROGRESS`
`static java.lang.String`	`STATUS_NOT_STARTED`
`static java.lang.String`	`STATUS_PAUSED`
`static java.lang.String`	`STATUS_PAUSING`
`static java.lang.String`	`STATUS_SUCCESS`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`ComponentUpgradeStatus()` Default constructor.
`protected`	`ComponentUpgradeStatus(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends com.vmware.vapi.bindings.Structure> T`	`_convertTo(java.lang.Class<T> clazz)`
`java.lang.String`	`_getCanonicalName()`
`static java.lang.String`	`_getCanonicalTypeName()` Returns the canonical type name.
`static com.vmware.vapi.bindings.type.StructType`	`_getClassType()` WARNING: Internal method, subject to change in future versions.
`com.vmware.vapi.data.StructValue`	`_getDataValue()`
`com.vmware.vapi.data.DataValue`	`_getDynamicField(java.lang.String fieldName)`
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()`
`com.vmware.vapi.bindings.type.StructType`	`_getType()`
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)`
`static ComponentUpgradeStatus`	`_newInstance(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
`static ComponentUpgradeStatus`	`_newInstance2(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)`
`protected void`	`_updateDataValue(com.vmware.vapi.data.StructValue structValue)`
`void`	`_validate()`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Boolean`	`getCanRollback()` This field indicates whether we can perform upgrade rollback.
`java.lang.Boolean`	`getCanSkip()` Can the upgrade of the remaining units in this component be skipped This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getComponentType()` Component type for the upgrade status This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`NodeSummaryList`	`getCurrentVersionNodeSummary()`
`java.lang.String`	`getDetails()` Details about the upgrade status This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.Long`	`getNodeCountAtTargetVersion()` Number of nodes of the type and at the component version format: int32 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.Double`	`getPercentComplete()` Indicator of upgrade progress in percentage This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`UpgradeChecksExecutionStatus`	`getPreUpgradeStatus()`
`java.lang.String`	`getStatus()` Possible values are: `STATUS_SUCCESS` `STATUS_FAILED` `STATUS_IN_PROGRESS` `STATUS_NOT_STARTED` `STATUS_PAUSING` `STATUS_PAUSED` Upgrade status of component This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getTargetComponentVersion()` Target component version This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`int`	`hashCode()`
`void`	`setCanRollback(java.lang.Boolean canRollback)` This field indicates whether we can perform upgrade rollback.
`void`	`setCanSkip(java.lang.Boolean canSkip)` Can the upgrade of the remaining units in this component be skipped This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setComponentType(java.lang.String componentType)` Component type for the upgrade status This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setCurrentVersionNodeSummary(NodeSummaryList currentVersionNodeSummary)`
`void`	`setDetails(java.lang.String details)` Details about the upgrade status This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setNodeCountAtTargetVersion(java.lang.Long nodeCountAtTargetVersion)` Number of nodes of the type and at the component version format: int32 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setPercentComplete(java.lang.Double percentComplete)` Indicator of upgrade progress in percentage This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setPreUpgradeStatus(UpgradeChecksExecutionStatus preUpgradeStatus)`
`void`	`setStatus(java.lang.String status)` Possible values are: `STATUS_SUCCESS` `STATUS_FAILED` `STATUS_IN_PROGRESS` `STATUS_NOT_STARTED` `STATUS_PAUSING` `STATUS_PAUSED` Upgrade status of component This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setTargetComponentVersion(java.lang.String targetComponentVersion)` Target component version This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - STATUS_SUCCESS
```
public static final java.lang.String STATUS_SUCCESS
```
    See Also:
    
    Constant Field Values
  - STATUS_FAILED
```
public static final java.lang.String STATUS_FAILED
```
    See Also:
    
    Constant Field Values
  - STATUS_IN_PROGRESS
```
public static final java.lang.String STATUS_IN_PROGRESS
```
    See Also:
    
    Constant Field Values
  - STATUS_NOT_STARTED
```
public static final java.lang.String STATUS_NOT_STARTED
```
    See Also:
    
    Constant Field Values
  - STATUS_PAUSING
```
public static final java.lang.String STATUS_PAUSING
```
    See Also:
    
    Constant Field Values
  - STATUS_PAUSED
```
public static final java.lang.String STATUS_PAUSED
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - ComponentUpgradeStatus
```
public ComponentUpgradeStatus()
```
    Default constructor.
  - ComponentUpgradeStatus
```
protected ComponentUpgradeStatus(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getCanRollback
```
public java.lang.Boolean getCanRollback()
```
    This field indicates whether we can perform upgrade rollback. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setCanRollback
```
public void setCanRollback(java.lang.Boolean canRollback)
```
    This field indicates whether we can perform upgrade rollback. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    canRollback - New value for the property.
  - getCanSkip
```
public java.lang.Boolean getCanSkip()
```
    Can the upgrade of the remaining units in this component be skipped This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setCanSkip
```
public void setCanSkip(java.lang.Boolean canSkip)
```
    Can the upgrade of the remaining units in this component be skipped This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    canSkip - New value for the property.
  - getComponentType
```
public java.lang.String getComponentType()
```
    Component type for the upgrade status This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setComponentType
```
public void setComponentType(java.lang.String componentType)
```
    Component type for the upgrade status This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    componentType - New value for the property.
  - getCurrentVersionNodeSummary
```
public NodeSummaryList getCurrentVersionNodeSummary()
```
    Returns:
    
    The current value of the property.
  - setCurrentVersionNodeSummary
```
public void setCurrentVersionNodeSummary(NodeSummaryList currentVersionNodeSummary)
```
    Parameters:
    
    currentVersionNodeSummary - New value for the property.
  - getDetails
```
public java.lang.String getDetails()
```
    Details about the upgrade status This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setDetails
```
public void setDetails(java.lang.String details)
```
    Details about the upgrade status This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    details - New value for the property.
  - getNodeCountAtTargetVersion
```
public java.lang.Long getNodeCountAtTargetVersion()
```
    Number of nodes of the type and at the component version format: int32 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setNodeCountAtTargetVersion
```
public void setNodeCountAtTargetVersion(java.lang.Long nodeCountAtTargetVersion)
```
    Number of nodes of the type and at the component version format: int32 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    nodeCountAtTargetVersion - New value for the property.
  - getPercentComplete
```
public java.lang.Double getPercentComplete()
```
    Indicator of upgrade progress in percentage This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setPercentComplete
```
public void setPercentComplete(java.lang.Double percentComplete)
```
    Indicator of upgrade progress in percentage This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    percentComplete - New value for the property.
  - getPreUpgradeStatus
```
public UpgradeChecksExecutionStatus getPreUpgradeStatus()
```
    Returns:
    
    The current value of the property.
  - setPreUpgradeStatus
```
public void setPreUpgradeStatus(UpgradeChecksExecutionStatus preUpgradeStatus)
```
    Parameters:
    
    preUpgradeStatus - New value for the property.
  - getStatus
```
public java.lang.String getStatus()
```
    Possible values are:
    Upgrade status of component This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    Returns:
    
    The current value of the property.
  - setStatus
```
public void setStatus(java.lang.String status)
```
    Possible values are:
    Upgrade status of component This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    Parameters:
    
    status - New value for the property.
  - getTargetComponentVersion
```
public java.lang.String getTargetComponentVersion()
```
    Target component version This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setTargetComponentVersion
```
public void setTargetComponentVersion(java.lang.String targetComponentVersion)
```
    Target component version This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    targetComponentVersion - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Specified by:
    
    _getType in interface com.vmware.vapi.bindings.StaticStructure
  - _getDataValue
```
public com.vmware.vapi.data.StructValue _getDataValue()
```
    Specified by:
    
    _getDataValue in interface com.vmware.vapi.bindings.Structure
  - _updateDataValue
```
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Specified by:
    
    _validate in interface com.vmware.vapi.bindings.StaticStructure
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
```
    Specified by:
    
    _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
  - _convertTo
```
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
```
    Specified by:
    
    _convertTo in interface com.vmware.vapi.bindings.Structure
  - _setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
```
    Specified by:
    
    _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicField
```
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
```
    Specified by:
    
    _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
    Specified by:
    
    _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
  - _getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
    WARNING: Internal method, subject to change in future versions.
    
    Returns:
    
    StructType instance representing the static bindings type for this Structure.
  - _getCanonicalName
```
public java.lang.String _getCanonicalName()
```
    Specified by:
    
    _getCanonicalName in interface com.vmware.vapi.bindings.Structure
  - _getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
    Returns the canonical type name. See _getCanonicalName().
    
    Returns:
    
    canonical type name
  - _newInstance
```
public static ComponentUpgradeStatus _newInstance(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Returns new instance of this binding class and injects the provided data value.
    WARNING: The returned object is not fully initialized.
    
    Parameters:
    
    structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.
    
    Returns:
    
    the static bindings StructType
  - _newInstance2
```
public static ComponentUpgradeStatus _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class ComponentUpgradeStatus

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATUS_SUCCESS

STATUS_FAILED

STATUS_IN_PROGRESS

STATUS_NOT_STARTED

STATUS_PAUSING

STATUS_PAUSED

__dynamicStructureFields

Constructor Detail

ComponentUpgradeStatus

ComponentUpgradeStatus

Method Detail

getCanRollback

setCanRollback

getCanSkip

setCanSkip

getComponentType

setComponentType

getCurrentVersionNodeSummary

setCurrentVersionNodeSummary

getDetails

setDetails

getNodeCountAtTargetVersion

setNodeCountAtTargetVersion

getPercentComplete

setPercentComplete

getPreUpgradeStatus

setPreUpgradeStatus

getStatus

setStatus

getTargetComponentVersion

setTargetComponentVersion

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2