IPSecVPNSessionStatus (Java SDK for NSX Manager API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class IPSecVPNSessionStatus
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
IKE session traffic summary provides IKE session status and aggregate of traffic across all tunnel.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IPSecVPNSessionStatus.Builder
Builder class for IPSecVPNSessionStatus.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`SESSION_STATUS_DEGRADED`
`static java.lang.String`	`SESSION_STATUS_DOWN`
`static java.lang.String`	`SESSION_STATUS_UP`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`IPSecVPNSessionStatus()` Default constructor.
`protected`	`IPSecVPNSessionStatus(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 IPSecVPNSessionStatus`	`_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 IPSecVPNSessionStatus`	`_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)`
`IPSecVPNTrafficCounters`	`getAggregateTrafficCounters()`
`java.lang.String`	`getDisplayName()` Display name of vpn session.
`java.lang.Long`	`getFailedTunnels()` Number of failed tunnels.
`IPSecVPNIKESessionStatus`	`getIkeStatus()`
`java.lang.String`	`getIpsecVpnSessionId()` UUID of vpn session.
`java.lang.Long`	`getLastUpdateTimestamp()` Timestamp when the data was last updated.
`java.lang.Long`	`getNegotiatedTunnels()` Number of negotiated tunnels.
`java.lang.String`	`getSessionStatus()` Possible values are: `SESSION_STATUS_UP` `SESSION_STATUS_DOWN` `SESSION_STATUS_DEGRADED` Gives session status consolidated using IKE status and tunnel status.
`java.lang.Long`	`getTotalTunnels()` Total number of tunnels.
`int`	`hashCode()`
`void`	`setAggregateTrafficCounters(IPSecVPNTrafficCounters aggregateTrafficCounters)`
`void`	`setDisplayName(java.lang.String displayName)` Display name of vpn session.
`void`	`setFailedTunnels(java.lang.Long failedTunnels)` Number of failed tunnels.
`void`	`setIkeStatus(IPSecVPNIKESessionStatus ikeStatus)`
`void`	`setIpsecVpnSessionId(java.lang.String ipsecVpnSessionId)` UUID of vpn session.
`void`	`setLastUpdateTimestamp(java.lang.Long lastUpdateTimestamp)` Timestamp when the data was last updated.
`void`	`setNegotiatedTunnels(java.lang.Long negotiatedTunnels)` Number of negotiated tunnels.
`void`	`setSessionStatus(java.lang.String sessionStatus)` Possible values are: `SESSION_STATUS_UP` `SESSION_STATUS_DOWN` `SESSION_STATUS_DEGRADED` Gives session status consolidated using IKE status and tunnel status.
`void`	`setTotalTunnels(java.lang.Long totalTunnels)` Total number of tunnels.
`java.lang.String`	`toString()`

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

- Field Detail
  - SESSION_STATUS_UP
```
public static final java.lang.String SESSION_STATUS_UP
```
    See Also:
    
    Constant Field Values
  - SESSION_STATUS_DOWN
```
public static final java.lang.String SESSION_STATUS_DOWN
```
    See Also:
    
    Constant Field Values
  - SESSION_STATUS_DEGRADED
```
public static final java.lang.String SESSION_STATUS_DEGRADED
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - IPSecVPNSessionStatus
```
public IPSecVPNSessionStatus()
```
    Default constructor.
  - IPSecVPNSessionStatus
```
protected IPSecVPNSessionStatus(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAggregateTrafficCounters
```
public IPSecVPNTrafficCounters getAggregateTrafficCounters()
```
    Returns:
    
    The current value of the property.
  - setAggregateTrafficCounters
```
public void setAggregateTrafficCounters(IPSecVPNTrafficCounters aggregateTrafficCounters)
```
    Parameters:
    
    aggregateTrafficCounters - New value for the property.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Display name of vpn session. 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.
  - setDisplayName
```
public void setDisplayName(java.lang.String displayName)
```
    Display name of vpn session. 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:
    
    displayName - New value for the property.
  - getFailedTunnels
```
public java.lang.Long getFailedTunnels()
```
    Number of failed tunnels. format: int64 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.
  - setFailedTunnels
```
public void setFailedTunnels(java.lang.Long failedTunnels)
```
    Number of failed tunnels. format: int64 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:
    
    failedTunnels - New value for the property.
  - getIkeStatus
```
public IPSecVPNIKESessionStatus getIkeStatus()
```
    Returns:
    
    The current value of the property.
  - setIkeStatus
```
public void setIkeStatus(IPSecVPNIKESessionStatus ikeStatus)
```
    Parameters:
    
    ikeStatus - New value for the property.
  - getIpsecVpnSessionId
```
public java.lang.String getIpsecVpnSessionId()
```
    UUID of vpn session. 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.
  - setIpsecVpnSessionId
```
public void setIpsecVpnSessionId(java.lang.String ipsecVpnSessionId)
```
    UUID of vpn session. 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:
    
    ipsecVpnSessionId - New value for the property.
  - getLastUpdateTimestamp
```
public java.lang.Long getLastUpdateTimestamp()
```
    Timestamp when the data was last updated. format: int64 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.
  - setLastUpdateTimestamp
```
public void setLastUpdateTimestamp(java.lang.Long lastUpdateTimestamp)
```
    Timestamp when the data was last updated. format: int64 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:
    
    lastUpdateTimestamp - New value for the property.
  - getNegotiatedTunnels
```
public java.lang.Long getNegotiatedTunnels()
```
    Number of negotiated tunnels. format: int64 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.
  - setNegotiatedTunnels
```
public void setNegotiatedTunnels(java.lang.Long negotiatedTunnels)
```
    Number of negotiated tunnels. format: int64 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:
    
    negotiatedTunnels - New value for the property.
  - getSessionStatus
```
public java.lang.String getSessionStatus()
```
    Possible values are:
    Gives session status consolidated using IKE status and tunnel status. It can be UP, DOWN, DEGRADED. If IKE and all tunnels are UP status will be UP, if all down it will be DOWN, otherwise it will be DEGRADED. 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.
  - setSessionStatus
```
public void setSessionStatus(java.lang.String sessionStatus)
```
    Possible values are:
    Gives session status consolidated using IKE status and tunnel status. It can be UP, DOWN, DEGRADED. If IKE and all tunnels are UP status will be UP, if all down it will be DOWN, otherwise it will be DEGRADED. 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:
    
    sessionStatus - New value for the property.
  - getTotalTunnels
```
public java.lang.Long getTotalTunnels()
```
    Total number of tunnels. format: int64 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.
  - setTotalTunnels
```
public void setTotalTunnels(java.lang.Long totalTunnels)
```
    Total number of tunnels. format: int64 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:
    
    totalTunnels - 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 IPSecVPNSessionStatus _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 IPSecVPNSessionStatus _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class IPSecVPNSessionStatus

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SESSION_STATUS_UP

SESSION_STATUS_DOWN

SESSION_STATUS_DEGRADED

__dynamicStructureFields

Constructor Detail

IPSecVPNSessionStatus

IPSecVPNSessionStatus

Method Detail

getAggregateTrafficCounters

setAggregateTrafficCounters

getDisplayName

setDisplayName

getFailedTunnels

setFailedTunnels

getIkeStatus

setIkeStatus

getIpsecVpnSessionId

setIpsecVpnSessionId

getLastUpdateTimestamp

setLastUpdateTimestamp

getNegotiatedTunnels

setNegotiatedTunnels

getSessionStatus

setSessionStatus

getTotalTunnels

setTotalTunnels

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2