Vpn (VMware-vmc-SDK-Java)

java.lang.Object
- com.vmware.vmc.model.Vpn

All Implemented Interfaces:: StaticStructure, Structure, java.io.Serializable

public final class Vpn
extends java.lang.Object
implements java.io.Serializable, StaticStructure

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Vpn.Builder
Builder class for Vpn.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`AUTHENTICATION_PSK`
`static java.lang.String`	`AUTHENTICATION_UNKNOWN`
`static java.lang.String`	`DH_GROUP_DH14`
`static java.lang.String`	`DH_GROUP_DH15`
`static java.lang.String`	`DH_GROUP_DH16`
`static java.lang.String`	`DH_GROUP_DH2`
`static java.lang.String`	`DH_GROUP_DH5`
`static java.lang.String`	`DH_GROUP_UNKNOWN`
`static java.lang.String`	`DIGEST_ALGORITHM_SHA_256`
`static java.lang.String`	`DIGEST_ALGORITHM_SHA1`
`static java.lang.String`	`ENCRYPTION_AES`
`static java.lang.String`	`ENCRYPTION_AES_GCM`
`static java.lang.String`	`ENCRYPTION_AES256`
`static java.lang.String`	`ENCRYPTION_TRIPLE_DES`
`static java.lang.String`	`ENCRYPTION_UNKNOWN`
`static java.lang.String`	`IKE_OPTION_IKEV1`
`static java.lang.String`	`IKE_OPTION_IKEV2`
`static java.lang.String`	`STATE_CONNECTED`
`static java.lang.String`	`STATE_DISCONNECTED`
`static java.lang.String`	`STATE_PARTIALLY_CONNECTED`
`static java.lang.String`	`STATE_UNKNOWN`

Constructor Summary

Constructors
Modifier Constructor and Description

Vpn()
Default constructor.

protected Vpn(StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`Vpn()` Default constructor.
`protected`	`Vpn(StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends Structure> T`	`_convertTo(java.lang.Class<T> clazz)` Converts this structure into an instance of the provided class structure if possible.
`java.lang.String`	`_getCanonicalName()` Returns the canonical name of the structure.
`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.
`StructValue`	`_getDataValue()` Returns this `Structure` represented in the dynamic `DataValue` model.
`DataValue`	`_getDynamicField(java.lang.String fieldName)` Get a dynamic field value, doesn't allow access to static fields (which have getters/setters).
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()` Get the names of the dynamic fields in the structure.
`com.vmware.vapi.bindings.type.StructType`	`_getType()` WARNING: Internal method, subject to change in future versions.
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends Structure> clazz)` Checks if the runtime type name of this structure matches the type represented by the specified binding class.
`static Vpn`	`_newInstance(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 Vpn`	`_newInstance2(StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, DataValue fieldValue)` Sets a dynamic field value.
`protected void`	`_updateDataValue(StructValue structValue)`
`void`	`_validate()` Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding `Structure`.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getAuthentication()` Possible values are: `AUTHENTICATION_PSK` `AUTHENTICATION_UNKNOWN`
`VpnChannelStatus`	`getChannelStatus()`
`java.lang.String`	`getDhGroup()` Possible values are: `DH_GROUP_DH2` `DH_GROUP_DH5` `DH_GROUP_DH14` `DH_GROUP_DH15` `DH_GROUP_DH16` `DH_GROUP_UNKNOWN`
`java.lang.String`	`getDigestAlgorithm()` Possible values are: `DIGEST_ALGORITHM_SHA1` `DIGEST_ALGORITHM_SHA_256`
`java.lang.Boolean`	`getEnabled()`
`java.lang.String`	`getEncryption()` Possible values are: `ENCRYPTION_AES` `ENCRYPTION_AES256` `ENCRYPTION_AES_GCM` `ENCRYPTION_TRIPLE_DES` `ENCRYPTION_UNKNOWN`
`java.lang.String`	`getId()`
`java.lang.String`	`getIkeOption()` Possible values are: `IKE_OPTION_IKEV1` `IKE_OPTION_IKEV2`
`java.util.List<java.lang.String>`	`getInternalNetworkIds()`
`java.lang.String`	`getName()`
`java.lang.String`	`getOnPremGatewayIp()`
`java.lang.String`	`getOnPremNatIp()`
`java.lang.String`	`getOnPremNetworkCidr()`
`java.lang.Boolean`	`getPfsEnabled()`
`java.lang.String`	`getPreSharedKey()`
`java.lang.String`	`getState()` Possible values are: `STATE_CONNECTED` `STATE_DISCONNECTED` `STATE_PARTIALLY_CONNECTED` `STATE_UNKNOWN`
`java.util.List<VpnTunnelStatus>`	`getTunnelStatuses()`
`java.lang.String`	`getVersion()`
`int`	`hashCode()`
`void`	`setAuthentication(java.lang.String authentication)` Possible values are: `AUTHENTICATION_PSK` `AUTHENTICATION_UNKNOWN`
`void`	`setChannelStatus(VpnChannelStatus channelStatus)`
`void`	`setDhGroup(java.lang.String dhGroup)` Possible values are: `DH_GROUP_DH2` `DH_GROUP_DH5` `DH_GROUP_DH14` `DH_GROUP_DH15` `DH_GROUP_DH16` `DH_GROUP_UNKNOWN`
`void`	`setDigestAlgorithm(java.lang.String digestAlgorithm)` Possible values are: `DIGEST_ALGORITHM_SHA1` `DIGEST_ALGORITHM_SHA_256`
`void`	`setEnabled(java.lang.Boolean enabled)`
`void`	`setEncryption(java.lang.String encryption)` Possible values are: `ENCRYPTION_AES` `ENCRYPTION_AES256` `ENCRYPTION_AES_GCM` `ENCRYPTION_TRIPLE_DES` `ENCRYPTION_UNKNOWN`
`void`	`setId(java.lang.String id)`
`void`	`setIkeOption(java.lang.String ikeOption)` Possible values are: `IKE_OPTION_IKEV1` `IKE_OPTION_IKEV2`
`void`	`setInternalNetworkIds(java.util.List<java.lang.String> internalNetworkIds)`
`void`	`setName(java.lang.String name)`
`void`	`setOnPremGatewayIp(java.lang.String onPremGatewayIp)`
`void`	`setOnPremNatIp(java.lang.String onPremNatIp)`
`void`	`setOnPremNetworkCidr(java.lang.String onPremNetworkCidr)`
`void`	`setPfsEnabled(java.lang.Boolean pfsEnabled)`
`void`	`setPreSharedKey(java.lang.String preSharedKey)`
`void`	`setState(java.lang.String state)` Possible values are: `STATE_CONNECTED` `STATE_DISCONNECTED` `STATE_PARTIALLY_CONNECTED` `STATE_UNKNOWN`
`void`	`setTunnelStatuses(java.util.List<VpnTunnelStatus> tunnelStatuses)`
`void`	`setVersion(java.lang.String version)`
`java.lang.String`	`toString()` Returns a string representation of this structure.

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

- Field Detail
  - ENCRYPTION_AES
```
public static final java.lang.String ENCRYPTION_AES
```
    See Also:
    
    Constant Field Values
  - ENCRYPTION_AES256
```
public static final java.lang.String ENCRYPTION_AES256
```
    See Also:
    
    Constant Field Values
  - ENCRYPTION_AES_GCM
```
public static final java.lang.String ENCRYPTION_AES_GCM
```
    See Also:
    
    Constant Field Values
  - ENCRYPTION_TRIPLE_DES
```
public static final java.lang.String ENCRYPTION_TRIPLE_DES
```
    See Also:
    
    Constant Field Values
  - ENCRYPTION_UNKNOWN
```
public static final java.lang.String ENCRYPTION_UNKNOWN
```
    See Also:
    
    Constant Field Values
  - STATE_CONNECTED
```
public static final java.lang.String STATE_CONNECTED
```
    See Also:
    
    Constant Field Values
  - STATE_DISCONNECTED
```
public static final java.lang.String STATE_DISCONNECTED
```
    See Also:
    
    Constant Field Values
  - STATE_PARTIALLY_CONNECTED
```
public static final java.lang.String STATE_PARTIALLY_CONNECTED
```
    See Also:
    
    Constant Field Values
  - STATE_UNKNOWN
```
public static final java.lang.String STATE_UNKNOWN
```
    See Also:
    
    Constant Field Values
  - DH_GROUP_DH2
```
public static final java.lang.String DH_GROUP_DH2
```
    See Also:
    
    Constant Field Values
  - DH_GROUP_DH5
```
public static final java.lang.String DH_GROUP_DH5
```
    See Also:
    
    Constant Field Values
  - DH_GROUP_DH14
```
public static final java.lang.String DH_GROUP_DH14
```
    See Also:
    
    Constant Field Values
  - DH_GROUP_DH15
```
public static final java.lang.String DH_GROUP_DH15
```
    See Also:
    
    Constant Field Values
  - DH_GROUP_DH16
```
public static final java.lang.String DH_GROUP_DH16
```
    See Also:
    
    Constant Field Values
  - DH_GROUP_UNKNOWN
```
public static final java.lang.String DH_GROUP_UNKNOWN
```
    See Also:
    
    Constant Field Values
  - AUTHENTICATION_PSK
```
public static final java.lang.String AUTHENTICATION_PSK
```
    See Also:
    
    Constant Field Values
  - AUTHENTICATION_UNKNOWN
```
public static final java.lang.String AUTHENTICATION_UNKNOWN
```
    See Also:
    
    Constant Field Values
  - IKE_OPTION_IKEV1
```
public static final java.lang.String IKE_OPTION_IKEV1
```
    See Also:
    
    Constant Field Values
  - IKE_OPTION_IKEV2
```
public static final java.lang.String IKE_OPTION_IKEV2
```
    See Also:
    
    Constant Field Values
  - DIGEST_ALGORITHM_SHA1
```
public static final java.lang.String DIGEST_ALGORITHM_SHA1
```
    See Also:
    
    Constant Field Values
  - DIGEST_ALGORITHM_SHA_256
```
public static final java.lang.String DIGEST_ALGORITHM_SHA_256
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected StructValue __dynamicStructureFields
```
- Constructor Detail
  - Vpn
```
public Vpn()
```
    Default constructor.
  - Vpn
```
protected Vpn(StructValue __dynamicStructureFields)
```
- Method Detail
  - getVersion
```
public java.lang.String getVersion()
```
    Returns:
    
    The current value of the property.
  - setVersion
```
public void setVersion(java.lang.String version)
```
    Parameters:
    
    version - New value for the property.
  - getOnPremGatewayIp
```
public java.lang.String getOnPremGatewayIp()
```
    Returns:
    
    The current value of the property.
  - setOnPremGatewayIp
```
public void setOnPremGatewayIp(java.lang.String onPremGatewayIp)
```
    Parameters:
    
    onPremGatewayIp - New value for the property.
  - getOnPremNetworkCidr
```
public java.lang.String getOnPremNetworkCidr()
```
    Returns:
    
    The current value of the property.
  - setOnPremNetworkCidr
```
public void setOnPremNetworkCidr(java.lang.String onPremNetworkCidr)
```
    Parameters:
    
    onPremNetworkCidr - New value for the property.
  - getPfsEnabled
```
public java.lang.Boolean getPfsEnabled()
```
    Returns:
    
    The current value of the property.
  - setPfsEnabled
```
public void setPfsEnabled(java.lang.Boolean pfsEnabled)
```
    Parameters:
    
    pfsEnabled - New value for the property.
  - getId
```
public java.lang.String getId()
```
    Returns:
    
    The current value of the property.
  - setId
```
public void setId(java.lang.String id)
```
    Parameters:
    
    id - New value for the property.
  - getChannelStatus
```
public VpnChannelStatus getChannelStatus()
```
    Returns:
    
    The current value of the property.
  - setChannelStatus
```
public void setChannelStatus(VpnChannelStatus channelStatus)
```
    Parameters:
    
    channelStatus - New value for the property.
  - getOnPremNatIp
```
public java.lang.String getOnPremNatIp()
```
    Returns:
    
    The current value of the property.
  - setOnPremNatIp
```
public void setOnPremNatIp(java.lang.String onPremNatIp)
```
    Parameters:
    
    onPremNatIp - New value for the property.
  - getName
```
public java.lang.String getName()
```
    Returns:
    
    The current value of the property.
  - setName
```
public void setName(java.lang.String name)
```
    Parameters:
    
    name - New value for the property.
  - getInternalNetworkIds
```
public java.util.List<java.lang.String> getInternalNetworkIds()
```
    Returns:
    
    The current value of the property.
  - setInternalNetworkIds
```
public void setInternalNetworkIds(java.util.List<java.lang.String> internalNetworkIds)
```
    Parameters:
    
    internalNetworkIds - New value for the property.
  - getTunnelStatuses
```
public java.util.List<VpnTunnelStatus> getTunnelStatuses()
```
    Returns:
    
    The current value of the property.
  - setTunnelStatuses
```
public void setTunnelStatuses(java.util.List<VpnTunnelStatus> tunnelStatuses)
```
    Parameters:
    
    tunnelStatuses - New value for the property.
  - getEncryption
```
public java.lang.String getEncryption()
```
    Possible values are:
    Returns:
    
    The current value of the property.
  - setEncryption
```
public void setEncryption(java.lang.String encryption)
```
    Possible values are:
    Parameters:
    
    encryption - New value for the property.
  - getEnabled
```
public java.lang.Boolean getEnabled()
```
    Returns:
    
    The current value of the property.
  - setEnabled
```
public void setEnabled(java.lang.Boolean enabled)
```
    Parameters:
    
    enabled - New value for the property.
  - getState
```
public java.lang.String getState()
```
    Possible values are:
    Returns:
    
    The current value of the property.
  - setState
```
public void setState(java.lang.String state)
```
    Possible values are:
    Parameters:
    
    state - New value for the property.
  - getDhGroup
```
public java.lang.String getDhGroup()
```
    Possible values are:
    Returns:
    
    The current value of the property.
  - setDhGroup
```
public void setDhGroup(java.lang.String dhGroup)
```
    Possible values are:
    Parameters:
    
    dhGroup - New value for the property.
  - getAuthentication
```
public java.lang.String getAuthentication()
```
    Possible values are:
    - AUTHENTICATION_PSK
    - AUTHENTICATION_UNKNOWN
    Returns:
    
    The current value of the property.
  - setAuthentication
```
public void setAuthentication(java.lang.String authentication)
```
    Possible values are:
    - AUTHENTICATION_PSK
    - AUTHENTICATION_UNKNOWN
    Parameters:
    
    authentication - New value for the property.
  - getPreSharedKey
```
public java.lang.String getPreSharedKey()
```
    Returns:
    
    The current value of the property.
  - setPreSharedKey
```
public void setPreSharedKey(java.lang.String preSharedKey)
```
    Parameters:
    
    preSharedKey - New value for the property.
  - getIkeOption
```
public java.lang.String getIkeOption()
```
    Possible values are:
    - IKE_OPTION_IKEV1
    - IKE_OPTION_IKEV2
    Returns:
    
    The current value of the property.
  - setIkeOption
```
public void setIkeOption(java.lang.String ikeOption)
```
    Possible values are:
    - IKE_OPTION_IKEV1
    - IKE_OPTION_IKEV2
    Parameters:
    
    ikeOption - New value for the property.
  - getDigestAlgorithm
```
public java.lang.String getDigestAlgorithm()
```
    Possible values are:
    - DIGEST_ALGORITHM_SHA1
    - DIGEST_ALGORITHM_SHA_256
    Returns:
    
    The current value of the property.
  - setDigestAlgorithm
```
public void setDigestAlgorithm(java.lang.String digestAlgorithm)
```
    Possible values are:
    - DIGEST_ALGORITHM_SHA1
    - DIGEST_ALGORITHM_SHA_256
    Parameters:
    
    digestAlgorithm - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Description copied from interface: StaticStructure
    
    WARNING: Internal method, subject to change in future versions. Returns StructType instance representing the static bindings type for this Structure.
    
    Specified by:
    
    _getType in interface StaticStructure
    
    Returns:
    
    the static bindings StructType
  - _getDataValue
```
public StructValue _getDataValue()
```
    Description copied from interface: Structure
    
    Returns this Structure represented in the dynamic DataValue model.
    Attempts to change the returned StructValue representation are not required to change the state of this structure. Actually the behavior is implementation dependent and is unspecified. In general the returned value shouldn't be changed.
    
    Specified by:
    
    _getDataValue in interface Structure
    
    Returns:
    
    StructValue representing this structure
  - _updateDataValue
```
protected void _updateDataValue(StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Description copied from interface: StaticStructure
    
    Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.
    More precisely, for each union: given value of the discriminant/tag field (@UnionTag in the IDL) of an union in this structure, validates that:
  - all fields of the union required for that value of the discriminant are set
  - fields of the union that are not allowed for that value of the discriminant are not set
  - any other fields of the structure (not participating in the union) do not affect the validation result

Specified by:: _validate in interface 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()
```
Description copied from interface: StaticStructure

Returns a string representation of this structure. The result is pretty printed in order to be easy to read. It is intended to be used for different debugging/tracing purposes, e.g. dumping structures into logging traces.
In general no code should depend on the format of the resulting string. E.g. there must be no attempts to parse for re-creation of the original instance.

Specified by:

toString in interface StaticStructure

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this static structure instance

_hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
```
Description copied from interface: Structure

Checks if the runtime type name of this structure matches the type represented by the specified binding class.
This can be used as efficient check to determine if this instance can be successfully converted to the target type.

Specified by:

_hasTypeNameOf in interface Structure

Parameters:

clazz - bindings class for the target structure; must not be null

Returns:

true if this structures type name matches exactly the specified class' type name.

_convertTo
```
public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)
```
Description copied from interface: Structure

Converts this structure into an instance of the provided class structure if possible. A conversion will be possible if the requested structure's fields are all present in this structure.

Specified by:

_convertTo in interface Structure

Parameters:

clazz - type of the result structure. cannot be null.

Returns:

an instance of the requested type if conversion is possible. CoreException is thrown otherwise.

_setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             DataValue fieldValue)
```
Description copied from interface: StaticStructure

Sets a dynamic field value. The dynamic filed is extra filed that is not part of the static structure definition, i.e. not represented with getter/setter.

Specified by:

_setDynamicField in interface StaticStructure

Parameters:

fieldName - canonical name of the dynamic field to set

fieldValue - the value of the field

_getDynamicField
```
public DataValue _getDynamicField(java.lang.String fieldName)
```
Description copied from interface: StaticStructure

Get a dynamic field value, doesn't allow access to static fields (which have getters/setters).

Specified by:

_getDynamicField in interface StaticStructure

Parameters:

fieldName - the canonical name of the dynamic field

Returns:

the DataValue of the dynamic field

_getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
Description copied from interface: StaticStructure

Get the names of the dynamic fields in the structure.

Specified by:

_getDynamicFieldNames in interface StaticStructure

Returns:

set of the canonical field names for the dynamic fields

_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()
```
Description copied from interface: Structure

Returns the canonical name of the structure. By default the canonical name is derived from the fully-qualified IDL name by converting to lower case and inserting underscores between words. For example org.example.FooBar would turn into org.example.foo_bar.

Specified by:

_getCanonicalName in interface Structure

Returns:

canonical name

_getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance
```
public static Vpn _newInstance(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 Vpn _newInstance2(StructValue structValue)
```
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.

Class Vpn

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ENCRYPTION_AES

ENCRYPTION_AES256

ENCRYPTION_AES_GCM

ENCRYPTION_TRIPLE_DES

ENCRYPTION_UNKNOWN

STATE_CONNECTED

STATE_DISCONNECTED

STATE_PARTIALLY_CONNECTED

STATE_UNKNOWN

DH_GROUP_DH2

DH_GROUP_DH5

DH_GROUP_DH14

DH_GROUP_DH15

DH_GROUP_DH16

DH_GROUP_UNKNOWN

AUTHENTICATION_PSK

AUTHENTICATION_UNKNOWN

IKE_OPTION_IKEV1

IKE_OPTION_IKEV2

DIGEST_ALGORITHM_SHA1

DIGEST_ALGORITHM_SHA_256

__dynamicStructureFields

Constructor Detail

Vpn

Vpn

Method Detail

getVersion

setVersion

getOnPremGatewayIp

setOnPremGatewayIp

getOnPremNetworkCidr

setOnPremNetworkCidr

getPfsEnabled

setPfsEnabled

getId

setId

getChannelStatus

setChannelStatus

getOnPremNatIp

setOnPremNatIp

getName

setName

getInternalNetworkIds

setInternalNetworkIds

getTunnelStatuses

setTunnelStatuses

getEncryption

setEncryption

getEnabled

setEnabled

getState

setState

getDhGroup

setDhGroup

getAuthentication

setAuthentication

getPreSharedKey

setPreSharedKey

getIkeOption

setIkeOption

getDigestAlgorithm

setDigestAlgorithm

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField