FederationSite (Java SDK for NSX Manager API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class FederationSite
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Site information.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FederationSite.Builder
Builder class for FederationSite.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`ACTIVE_GM_ACTIVE`
`static java.lang.String`	`ACTIVE_GM_INVALID`
`static java.lang.String`	`ACTIVE_GM_NONE`
`static java.lang.String`	`ACTIVE_GM_STANDBY`
`static java.lang.String`	`NODE_TYPE_GM`
`static java.lang.String`	`NODE_TYPE_GM_AND_LM`
`static java.lang.String`	`NODE_TYPE_LM`

Constructor Summary

Constructors
Modifier Constructor and Description

FederationSite()
Default constructor.

protected FederationSite(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`FederationSite()` Default constructor.
`protected`	`FederationSite(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 FederationSite`	`_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 FederationSite`	`_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.String`	`getActiveGm()` Possible values are: `ACTIVE_GM_ACTIVE` `ACTIVE_GM_STANDBY` `ACTIVE_GM_NONE` `ACTIVE_GM_INVALID` Does site have active GM
`java.util.List<AphInfo>`	`getAphList()` Aph services in the site
`java.lang.String`	`getCertHash()` Hash of the trustManagerCert
`java.lang.String`	`getClusterId()` Cluster id
`java.lang.Long`	`getConfigVersion()` Site config version format: int64
`java.lang.String`	`getId()` Id of the site
`java.lang.Boolean`	`getIsFederated()` Is site federated
`java.lang.Boolean`	`getIsLocal()` Is site local
`java.lang.String`	`getName()` Name of the site
`java.lang.String`	`getNodeType()` Possible values are: `NODE_TYPE_GM` `NODE_TYPE_LM` `NODE_TYPE_GM_AND_LM` Type of node
`java.lang.String`	`getSiteVersion()` Version of the site
`java.lang.Boolean`	`getSplitBrain()` Split brain
`java.lang.Long`	`getSystemId()` System id format: int64
`java.lang.String`	`getTrustManagerCert()` Cert string from trust manager
`java.lang.String`	`getVipIp()` Vip ip
`int`	`hashCode()`
`void`	`setActiveGm(java.lang.String activeGm)` Possible values are: `ACTIVE_GM_ACTIVE` `ACTIVE_GM_STANDBY` `ACTIVE_GM_NONE` `ACTIVE_GM_INVALID` Does site have active GM
`void`	`setAphList(java.util.List<AphInfo> aphList)` Aph services in the site
`void`	`setCertHash(java.lang.String certHash)` Hash of the trustManagerCert
`void`	`setClusterId(java.lang.String clusterId)` Cluster id
`void`	`setConfigVersion(java.lang.Long configVersion)` Site config version format: int64
`void`	`setId(java.lang.String id)` Id of the site
`void`	`setIsFederated(java.lang.Boolean isFederated)` Is site federated
`void`	`setIsLocal(java.lang.Boolean isLocal)` Is site local
`void`	`setName(java.lang.String name)` Name of the site
`void`	`setNodeType(java.lang.String nodeType)` Possible values are: `NODE_TYPE_GM` `NODE_TYPE_LM` `NODE_TYPE_GM_AND_LM` Type of node
`void`	`setSiteVersion(java.lang.String siteVersion)` Version of the site
`void`	`setSplitBrain(java.lang.Boolean splitBrain)` Split brain
`void`	`setSystemId(java.lang.Long systemId)` System id format: int64
`void`	`setTrustManagerCert(java.lang.String trustManagerCert)` Cert string from trust manager
`void`	`setVipIp(java.lang.String vipIp)` Vip ip
`java.lang.String`	`toString()`

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

- Field Detail
  - ACTIVE_GM_ACTIVE
```
public static final java.lang.String ACTIVE_GM_ACTIVE
```
    See Also:
    
    Constant Field Values
  - ACTIVE_GM_STANDBY
```
public static final java.lang.String ACTIVE_GM_STANDBY
```
    See Also:
    
    Constant Field Values
  - ACTIVE_GM_NONE
```
public static final java.lang.String ACTIVE_GM_NONE
```
    See Also:
    
    Constant Field Values
  - ACTIVE_GM_INVALID
```
public static final java.lang.String ACTIVE_GM_INVALID
```
    See Also:
    
    Constant Field Values
  - NODE_TYPE_GM
```
public static final java.lang.String NODE_TYPE_GM
```
    See Also:
    
    Constant Field Values
  - NODE_TYPE_LM
```
public static final java.lang.String NODE_TYPE_LM
```
    See Also:
    
    Constant Field Values
  - NODE_TYPE_GM_AND_LM
```
public static final java.lang.String NODE_TYPE_GM_AND_LM
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - FederationSite
```
public FederationSite()
```
    Default constructor.
  - FederationSite
```
protected FederationSite(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getActiveGm
```
public java.lang.String getActiveGm()
```
    Possible values are:
    Does site have active GM
    Returns:
    
    The current value of the property.
  - setActiveGm
```
public void setActiveGm(java.lang.String activeGm)
```
    Possible values are:
    Does site have active GM
    Parameters:
    
    activeGm - New value for the property.
  - getAphList
```
public java.util.List<AphInfo> getAphList()
```
    Aph services in the site
    
    Returns:
    
    The current value of the property.
  - setAphList
```
public void setAphList(java.util.List<AphInfo> aphList)
```
    Aph services in the site
    
    Parameters:
    
    aphList - New value for the property.
  - getCertHash
```
public java.lang.String getCertHash()
```
    Hash of the trustManagerCert
    
    Returns:
    
    The current value of the property.
  - setCertHash
```
public void setCertHash(java.lang.String certHash)
```
    Hash of the trustManagerCert
    
    Parameters:
    
    certHash - New value for the property.
  - getClusterId
```
public java.lang.String getClusterId()
```
    Cluster id
    
    Returns:
    
    The current value of the property.
  - setClusterId
```
public void setClusterId(java.lang.String clusterId)
```
    Cluster id
    
    Parameters:
    
    clusterId - New value for the property.
  - getConfigVersion
```
public java.lang.Long getConfigVersion()
```
    Site config version format: int64
    
    Returns:
    
    The current value of the property.
  - setConfigVersion
```
public void setConfigVersion(java.lang.Long configVersion)
```
    Site config version format: int64
    
    Parameters:
    
    configVersion - New value for the property.
  - getId
```
public java.lang.String getId()
```
    Id of the site
    
    Returns:
    
    The current value of the property.
  - setId
```
public void setId(java.lang.String id)
```
    Id of the site
    
    Parameters:
    
    id - New value for the property.
  - getIsFederated
```
public java.lang.Boolean getIsFederated()
```
    Is site federated
    
    Returns:
    
    The current value of the property.
  - setIsFederated
```
public void setIsFederated(java.lang.Boolean isFederated)
```
    Is site federated
    
    Parameters:
    
    isFederated - New value for the property.
  - getIsLocal
```
public java.lang.Boolean getIsLocal()
```
    Is site local
    
    Returns:
    
    The current value of the property.
  - setIsLocal
```
public void setIsLocal(java.lang.Boolean isLocal)
```
    Is site local
    
    Parameters:
    
    isLocal - New value for the property.
  - getName
```
public java.lang.String getName()
```
    Name of the site
    
    Returns:
    
    The current value of the property.
  - setName
```
public void setName(java.lang.String name)
```
    Name of the site
    
    Parameters:
    
    name - New value for the property.
  - getNodeType
```
public java.lang.String getNodeType()
```
    Possible values are:
    Type of node
    Returns:
    
    The current value of the property.
  - setNodeType
```
public void setNodeType(java.lang.String nodeType)
```
    Possible values are:
    Type of node
    Parameters:
    
    nodeType - New value for the property.
  - getSiteVersion
```
public java.lang.String getSiteVersion()
```
    Version of the site
    
    Returns:
    
    The current value of the property.
  - setSiteVersion
```
public void setSiteVersion(java.lang.String siteVersion)
```
    Version of the site
    
    Parameters:
    
    siteVersion - New value for the property.
  - getSplitBrain
```
public java.lang.Boolean getSplitBrain()
```
    Split brain
    
    Returns:
    
    The current value of the property.
  - setSplitBrain
```
public void setSplitBrain(java.lang.Boolean splitBrain)
```
    Split brain
    
    Parameters:
    
    splitBrain - New value for the property.
  - getSystemId
```
public java.lang.Long getSystemId()
```
    System id format: int64
    
    Returns:
    
    The current value of the property.
  - setSystemId
```
public void setSystemId(java.lang.Long systemId)
```
    System id format: int64
    
    Parameters:
    
    systemId - New value for the property.
  - getTrustManagerCert
```
public java.lang.String getTrustManagerCert()
```
    Cert string from trust manager
    
    Returns:
    
    The current value of the property.
  - setTrustManagerCert
```
public void setTrustManagerCert(java.lang.String trustManagerCert)
```
    Cert string from trust manager
    
    Parameters:
    
    trustManagerCert - New value for the property.
  - getVipIp
```
public java.lang.String getVipIp()
```
    Vip ip
    
    Returns:
    
    The current value of the property.
  - setVipIp
```
public void setVipIp(java.lang.String vipIp)
```
    Vip ip
    
    Parameters:
    
    vipIp - 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 FederationSite _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 FederationSite _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class FederationSite

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACTIVE_GM_ACTIVE

ACTIVE_GM_STANDBY

ACTIVE_GM_NONE

ACTIVE_GM_INVALID

NODE_TYPE_GM

NODE_TYPE_LM

NODE_TYPE_GM_AND_LM

__dynamicStructureFields

Constructor Detail

FederationSite

FederationSite

Method Detail

getActiveGm

setActiveGm

getAphList

setAphList

getCertHash

setCertHash

getClusterId

setClusterId

getConfigVersion

setConfigVersion

getId

setId

getIsFederated

setIsFederated

getIsLocal

setIsLocal

getName

setName

getNodeType

setNodeType

getSiteVersion

setSiteVersion

getSplitBrain

setSplitBrain

getSystemId

setSystemId

getTrustManagerCert

setTrustManagerCert

getVipIp

setVipIp

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2