FederationUpgradeSummary (Java SDK for NSX Policy API 4.1.1.0.0)

java.lang.Object
- com.vmware.nsx_policy.model.FederationUpgradeSummary

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class FederationUpgradeSummary
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Provides upgrade summary for a specific site.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FederationUpgradeSummary.Builder
Builder class for FederationUpgradeSummary.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`OVERALL_UPGRADE_STATUS_FAILED`
`static java.lang.String`	`OVERALL_UPGRADE_STATUS_IN_PROGRESS`
`static java.lang.String`	`OVERALL_UPGRADE_STATUS_NOT_STARTED`
`static java.lang.String`	`OVERALL_UPGRADE_STATUS_PAUSED`
`static java.lang.String`	`OVERALL_UPGRADE_STATUS_SUCCESS`
`static java.lang.String`	`SITE_TYPE_ACTIVE_GM_SITE`
`static java.lang.String`	`SITE_TYPE_NON_GM_SITE`
`static java.lang.String`	`SITE_TYPE_STANDBY_GM_SITE`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`FederationUpgradeSummary()` Default constructor.
`protected`	`FederationUpgradeSummary(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 FederationUpgradeSummary`	`_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 FederationUpgradeSummary`	`_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.util.List<FederationComponentUpgradeStatus>`	`getComponentStatus()` List of component statuses 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`	`getCurrentVersion()` This is NSX version for the site.
`java.lang.String`	`getGpmName()` Name of the global manager if present.
`java.lang.String`	`getId()` Unique identifier of this resource.
`java.lang.String`	`getLastUpgradeTimestamp()` Indicates the time when the site was upgraded.
`java.lang.String`	`getName()` Name of the site.
`java.lang.String`	`getOverallUpgradeStatus()` Possible values are: `OVERALL_UPGRADE_STATUS_SUCCESS` `OVERALL_UPGRADE_STATUS_FAILED` `OVERALL_UPGRADE_STATUS_IN_PROGRESS` `OVERALL_UPGRADE_STATUS_NOT_STARTED` `OVERALL_UPGRADE_STATUS_PAUSED` Status of upgrade 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`	`getSiteId()` This is the Site Manager generated UUID for every NSX deployment.
`java.lang.String`	`getSiteIp()` IP address of the site.
`java.lang.String`	`getSiteType()` Possible values are: `SITE_TYPE_ACTIVE_GM_SITE` `SITE_TYPE_STANDBY_GM_SITE` `SITE_TYPE_NON_GM_SITE` Type of this site.
`java.lang.String`	`getTargetVersion()` This is NSX target version for the site, if it is undergoing upgrade.
`int`	`hashCode()`
`void`	`setComponentStatus(java.util.List<FederationComponentUpgradeStatus> componentStatus)` List of component statuses 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`	`setCurrentVersion(java.lang.String currentVersion)` This is NSX version for the site.
`void`	`setGpmName(java.lang.String gpmName)` Name of the global manager if present.
`void`	`setId(java.lang.String id)` Unique identifier of this resource.
`void`	`setLastUpgradeTimestamp(java.lang.String lastUpgradeTimestamp)` Indicates the time when the site was upgraded.
`void`	`setName(java.lang.String name)` Name of the site.
`void`	`setOverallUpgradeStatus(java.lang.String overallUpgradeStatus)` Possible values are: `OVERALL_UPGRADE_STATUS_SUCCESS` `OVERALL_UPGRADE_STATUS_FAILED` `OVERALL_UPGRADE_STATUS_IN_PROGRESS` `OVERALL_UPGRADE_STATUS_NOT_STARTED` `OVERALL_UPGRADE_STATUS_PAUSED` Status of upgrade 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`	`setSiteId(java.lang.String siteId)` This is the Site Manager generated UUID for every NSX deployment.
`void`	`setSiteIp(java.lang.String siteIp)` IP address of the site.
`void`	`setSiteType(java.lang.String siteType)` Possible values are: `SITE_TYPE_ACTIVE_GM_SITE` `SITE_TYPE_STANDBY_GM_SITE` `SITE_TYPE_NON_GM_SITE` Type of this site.
`void`	`setTargetVersion(java.lang.String targetVersion)` This is NSX target version for the site, if it is undergoing upgrade.
`java.lang.String`	`toString()`

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

- Field Detail
  - OVERALL_UPGRADE_STATUS_SUCCESS
```
public static final java.lang.String OVERALL_UPGRADE_STATUS_SUCCESS
```
    See Also:
    
    Constant Field Values
  - OVERALL_UPGRADE_STATUS_FAILED
```
public static final java.lang.String OVERALL_UPGRADE_STATUS_FAILED
```
    See Also:
    
    Constant Field Values
  - OVERALL_UPGRADE_STATUS_IN_PROGRESS
```
public static final java.lang.String OVERALL_UPGRADE_STATUS_IN_PROGRESS
```
    See Also:
    
    Constant Field Values
  - OVERALL_UPGRADE_STATUS_NOT_STARTED
```
public static final java.lang.String OVERALL_UPGRADE_STATUS_NOT_STARTED
```
    See Also:
    
    Constant Field Values
  - OVERALL_UPGRADE_STATUS_PAUSED
```
public static final java.lang.String OVERALL_UPGRADE_STATUS_PAUSED
```
    See Also:
    
    Constant Field Values
  - SITE_TYPE_ACTIVE_GM_SITE
```
public static final java.lang.String SITE_TYPE_ACTIVE_GM_SITE
```
    See Also:
    
    Constant Field Values
  - SITE_TYPE_STANDBY_GM_SITE
```
public static final java.lang.String SITE_TYPE_STANDBY_GM_SITE
```
    See Also:
    
    Constant Field Values
  - SITE_TYPE_NON_GM_SITE
```
public static final java.lang.String SITE_TYPE_NON_GM_SITE
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - FederationUpgradeSummary
```
public FederationUpgradeSummary()
```
    Default constructor.
  - FederationUpgradeSummary
```
protected FederationUpgradeSummary(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getComponentStatus
```
public java.util.List<FederationComponentUpgradeStatus> getComponentStatus()
```
    List of component statuses 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.
  - setComponentStatus
```
public void setComponentStatus(java.util.List<FederationComponentUpgradeStatus> componentStatus)
```
    List of component statuses 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:
    
    componentStatus - New value for the property.
  - getCurrentVersion
```
public java.lang.String getCurrentVersion()
```
    This is NSX version for the site. 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.
  - setCurrentVersion
```
public void setCurrentVersion(java.lang.String currentVersion)
```
    This is NSX version for the site. 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:
    
    currentVersion - New value for the property.
  - getGpmName
```
public java.lang.String getGpmName()
```
    Name of the global manager if present. 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.
  - setGpmName
```
public void setGpmName(java.lang.String gpmName)
```
    Name of the global manager if present. 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:
    
    gpmName - New value for the property.
  - getId
```
public java.lang.String getId()
```
    Unique identifier of this resource. 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.
  - setId
```
public void setId(java.lang.String id)
```
    Unique identifier of this resource. 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:
    
    id - New value for the property.
  - getLastUpgradeTimestamp
```
public java.lang.String getLastUpgradeTimestamp()
```
    Indicates the time when the site was upgraded. 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.
  - setLastUpgradeTimestamp
```
public void setLastUpgradeTimestamp(java.lang.String lastUpgradeTimestamp)
```
    Indicates the time when the site was upgraded. 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:
    
    lastUpgradeTimestamp - New value for the property.
  - getName
```
public java.lang.String getName()
```
    Name of the site. 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.
  - setName
```
public void setName(java.lang.String name)
```
    Name of the site. 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:
    
    name - New value for the property.
  - getOverallUpgradeStatus
```
public java.lang.String getOverallUpgradeStatus()
```
    Possible values are:
    Status of upgrade 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.
  - setOverallUpgradeStatus
```
public void setOverallUpgradeStatus(java.lang.String overallUpgradeStatus)
```
    Possible values are:
    Status of upgrade 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:
    
    overallUpgradeStatus - New value for the property.
  - getSiteId
```
public java.lang.String getSiteId()
```
    This is the Site Manager generated UUID for every NSX deployment. 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.
  - setSiteId
```
public void setSiteId(java.lang.String siteId)
```
    This is the Site Manager generated UUID for every NSX deployment. 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:
    
    siteId - New value for the property.
  - getSiteIp
```
public java.lang.String getSiteIp()
```
    IP address of the site. 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.
  - setSiteIp
```
public void setSiteIp(java.lang.String siteIp)
```
    IP address of the site. 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:
    
    siteIp - New value for the property.
  - getSiteType
```
public java.lang.String getSiteType()
```
    Possible values are:
    Type of this site. 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.
  - setSiteType
```
public void setSiteType(java.lang.String siteType)
```
    Possible values are:
    Type of this site. 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:
    
    siteType - New value for the property.
  - getTargetVersion
```
public java.lang.String getTargetVersion()
```
    This is NSX target version for the site, if it is undergoing upgrade. 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.
  - setTargetVersion
```
public void setTargetVersion(java.lang.String targetVersion)
```
    This is NSX target version for the site, if it is undergoing upgrade. 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:
    
    targetVersion - 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 FederationUpgradeSummary _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 FederationUpgradeSummary _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class FederationUpgradeSummary

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OVERALL_UPGRADE_STATUS_SUCCESS

OVERALL_UPGRADE_STATUS_FAILED

OVERALL_UPGRADE_STATUS_IN_PROGRESS

OVERALL_UPGRADE_STATUS_NOT_STARTED

OVERALL_UPGRADE_STATUS_PAUSED

SITE_TYPE_ACTIVE_GM_SITE

SITE_TYPE_STANDBY_GM_SITE

SITE_TYPE_NON_GM_SITE

__dynamicStructureFields

Constructor Detail

FederationUpgradeSummary

FederationUpgradeSummary

Method Detail

getComponentStatus

setComponentStatus

getCurrentVersion

setCurrentVersion

getGpmName

setGpmName

getId

setId

getLastUpgradeTimestamp

setLastUpgradeTimestamp

getName

setName

getOverallUpgradeStatus

setOverallUpgradeStatus

getSiteId

setSiteId

getSiteIp

setSiteIp

getSiteType

setSiteType

getTargetVersion

setTargetVersion

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2