IPSecVpnTunnelProfile (NSX Policy API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class IPSecVpnTunnelProfile
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
IPSec VPN tunnel profile is a reusable profile that captures phase two negotiation parameters and IPSec tunnel properties. Any changes affects all IPSec VPN sessions consuming this profile.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IPSecVpnTunnelProfile.Builder
Builder class for IPSecVpnTunnelProfile.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`DF_POLICY_CLEAR`
`static java.lang.String`	`DF_POLICY_COPY`
`static java.lang.String`	`DH_GROUPS_GROUP14`
`static java.lang.String`	`DH_GROUPS_GROUP15`
`static java.lang.String`	`DH_GROUPS_GROUP16`
`static java.lang.String`	`DH_GROUPS_GROUP19`
`static java.lang.String`	`DH_GROUPS_GROUP2`
`static java.lang.String`	`DH_GROUPS_GROUP20`
`static java.lang.String`	`DH_GROUPS_GROUP21`
`static java.lang.String`	`DH_GROUPS_GROUP5`
`static java.lang.String`	`DIGEST_ALGORITHMS_SHA1`
`static java.lang.String`	`DIGEST_ALGORITHMS_SHA2_256`
`static java.lang.String`	`DIGEST_ALGORITHMS_SHA2_384`
`static java.lang.String`	`DIGEST_ALGORITHMS_SHA2_512`
`static java.lang.String`	`ENCRYPTION_ALGORITHMS_AES_128`
`static java.lang.String`	`ENCRYPTION_ALGORITHMS_AES_256`
`static java.lang.String`	`ENCRYPTION_ALGORITHMS_AES_GCM_128`
`static java.lang.String`	`ENCRYPTION_ALGORITHMS_AES_GCM_192`
`static java.lang.String`	`ENCRYPTION_ALGORITHMS_AES_GCM_256`
`static java.lang.String`	`ENCRYPTION_ALGORITHMS_NO_ENCRYPTION`
`static java.lang.String`	`ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_128`
`static java.lang.String`	`ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_192`
`static java.lang.String`	`ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_256`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`IPSecVpnTunnelProfile()` Default constructor.
`protected`	`IPSecVpnTunnelProfile(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 IPSecVpnTunnelProfile`	`_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 IPSecVpnTunnelProfile`	`_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<com.vmware.vapi.bindings.Structure>`	`getChildren()` Subtree for this type within policy tree containing nested elements.
`java.lang.Long`	`getCreateTime()` Timestamp of resource creation 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.
`java.lang.String`	`getCreateUser()` ID of the user who created 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.
`java.lang.String`	`getDescription()` Description of this resource
`java.lang.String`	`getDfPolicy()` Possible values are: `DF_POLICY_COPY` `DF_POLICY_CLEAR` Defragmentation policy helps to handle defragmentation bit present in the inner packet.
`java.util.List<java.lang.String>`	`getDhGroups()` Possible values are: `DH_GROUPS_GROUP2` `DH_GROUPS_GROUP5` `DH_GROUPS_GROUP14` `DH_GROUPS_GROUP15` `DH_GROUPS_GROUP16` `DH_GROUPS_GROUP19` `DH_GROUPS_GROUP20` `DH_GROUPS_GROUP21` Diffie-Hellman group to be used if PFS is enabled.
`java.util.List<java.lang.String>`	`getDigestAlgorithms()` Possible values are: `DIGEST_ALGORITHMS_SHA1` `DIGEST_ALGORITHMS_SHA2_256` `DIGEST_ALGORITHMS_SHA2_384` `DIGEST_ALGORITHMS_SHA2_512` Algorithm to be used for message digest.
`java.lang.String`	`getDisplayName()` Defaults to ID if not set
`java.lang.Boolean`	`getEnablePerfectForwardSecrecy()` If true, perfect forward secrecy (PFS) is enabled.
`java.util.List<java.lang.String>`	`getEncryptionAlgorithms()` Possible values are: `ENCRYPTION_ALGORITHMS_AES_128` `ENCRYPTION_ALGORITHMS_AES_256` `ENCRYPTION_ALGORITHMS_AES_GCM_128` `ENCRYPTION_ALGORITHMS_AES_GCM_192` `ENCRYPTION_ALGORITHMS_AES_GCM_256` `ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_128` `ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_192` `ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_256` `ENCRYPTION_ALGORITHMS_NO_ENCRYPTION` Encryption algorithm to encrypt/decrypt the messages exchanged between IPSec VPN initiator and responder during tunnel negotiation.
`java.util.List<AttributeVal>`	`getExtendedAttributes()` Collection of type specific properties.
`java.lang.String`	`getId()` Unique identifier of this resource
`java.lang.Long`	`getLastModifiedTime()` Timestamp of last modification 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.
`java.lang.String`	`getLastModifiedUser()` ID of the user who last modified 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.
`java.util.List<ResourceLink>`	`getLinks()` The server will populate this field when returing the resource.
`java.lang.Boolean`	`getMarkedForDelete()` Intent objects are not directly deleted from the system when a delete is invoked on them.
`java.lang.String`	`getOriginSiteId()` This is a UUID generated by the system for knowing which site owns an object.
`java.lang.Boolean`	`getOverridden()` Global intent objects cannot be modified by the user.
`java.lang.String`	`getOwnerId()` This is a UUID generated by the system for knowing who owns this object.
`java.lang.String`	`getParentPath()` Path of its parent 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`	`getPath()` Absolute path of this object 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`	`getProtection()` Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.
`java.lang.String`	`getRealizationId()` This is a UUID generated by the system for realizing the entity object.
`java.lang.String`	`getRelativePath()` Path relative from its parent 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`	`getRemotePath()` This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers.
`java.lang.String`	`getResourceType()` The type of this resource.
`java.lang.Long`	`getRevision()` The _revision property describes the current revision of the resource.
`java.lang.Long`	`getSaLifeTime()` SA life time specifies the expiry time of security association.
`java.lang.String`	`getSchema()` Schema for 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.
`SelfResourceLink`	`getSelf()`
`java.lang.Boolean`	`getSystemOwned()` Indicates system owned 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.
`java.util.List<Tag>`	`getTags()` Opaque identifiers meaningful to the API user
`java.lang.String`	`getUniqueId()` This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.
`int`	`hashCode()`
`void`	`setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)` Subtree for this type within policy tree containing nested elements.
`void`	`setCreateTime(java.lang.Long createTime)` Timestamp of resource creation 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.
`void`	`setCreateUser(java.lang.String createUser)` ID of the user who created 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.
`void`	`setDescription(java.lang.String description)` Description of this resource
`void`	`setDfPolicy(java.lang.String dfPolicy)` Possible values are: `DF_POLICY_COPY` `DF_POLICY_CLEAR` Defragmentation policy helps to handle defragmentation bit present in the inner packet.
`void`	`setDhGroups(java.util.List<java.lang.String> dhGroups)` Possible values are: `DH_GROUPS_GROUP2` `DH_GROUPS_GROUP5` `DH_GROUPS_GROUP14` `DH_GROUPS_GROUP15` `DH_GROUPS_GROUP16` `DH_GROUPS_GROUP19` `DH_GROUPS_GROUP20` `DH_GROUPS_GROUP21` Diffie-Hellman group to be used if PFS is enabled.
`void`	`setDigestAlgorithms(java.util.List<java.lang.String> digestAlgorithms)` Possible values are: `DIGEST_ALGORITHMS_SHA1` `DIGEST_ALGORITHMS_SHA2_256` `DIGEST_ALGORITHMS_SHA2_384` `DIGEST_ALGORITHMS_SHA2_512` Algorithm to be used for message digest.
`void`	`setDisplayName(java.lang.String displayName)` Defaults to ID if not set
`void`	`setEnablePerfectForwardSecrecy(java.lang.Boolean enablePerfectForwardSecrecy)` If true, perfect forward secrecy (PFS) is enabled.
`void`	`setEncryptionAlgorithms(java.util.List<java.lang.String> encryptionAlgorithms)` Possible values are: `ENCRYPTION_ALGORITHMS_AES_128` `ENCRYPTION_ALGORITHMS_AES_256` `ENCRYPTION_ALGORITHMS_AES_GCM_128` `ENCRYPTION_ALGORITHMS_AES_GCM_192` `ENCRYPTION_ALGORITHMS_AES_GCM_256` `ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_128` `ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_192` `ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_256` `ENCRYPTION_ALGORITHMS_NO_ENCRYPTION` Encryption algorithm to encrypt/decrypt the messages exchanged between IPSec VPN initiator and responder during tunnel negotiation.
`void`	`setExtendedAttributes(java.util.List<AttributeVal> extendedAttributes)` Collection of type specific properties.
`void`	`setId(java.lang.String id)` Unique identifier of this resource
`void`	`setLastModifiedTime(java.lang.Long lastModifiedTime)` Timestamp of last modification 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.
`void`	`setLastModifiedUser(java.lang.String lastModifiedUser)` ID of the user who last modified 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.
`void`	`setLinks(java.util.List<ResourceLink> links)` The server will populate this field when returing the resource.
`void`	`setMarkedForDelete(java.lang.Boolean markedForDelete)` Intent objects are not directly deleted from the system when a delete is invoked on them.
`void`	`setOriginSiteId(java.lang.String originSiteId)` This is a UUID generated by the system for knowing which site owns an object.
`void`	`setOverridden(java.lang.Boolean overridden)` Global intent objects cannot be modified by the user.
`void`	`setOwnerId(java.lang.String ownerId)` This is a UUID generated by the system for knowing who owns this object.
`void`	`setParentPath(java.lang.String parentPath)` Path of its parent 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`	`setPath(java.lang.String path)` Absolute path of this object 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`	`setProtection(java.lang.String protection)` Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.
`void`	`setRealizationId(java.lang.String realizationId)` This is a UUID generated by the system for realizing the entity object.
`void`	`setRelativePath(java.lang.String relativePath)` Path relative from its parent 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`	`setRemotePath(java.lang.String remotePath)` This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers.
`void`	`setResourceType(java.lang.String resourceType)` The type of this resource.
`void`	`setRevision(java.lang.Long revision)` The _revision property describes the current revision of the resource.
`void`	`setSaLifeTime(java.lang.Long saLifeTime)` SA life time specifies the expiry time of security association.
`void`	`setSchema(java.lang.String schema)` Schema for 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.
`void`	`setSelf(SelfResourceLink self)`
`void`	`setSystemOwned(java.lang.Boolean systemOwned)` Indicates system owned 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.
`void`	`setTags(java.util.List<Tag> tags)` Opaque identifiers meaningful to the API user
`void`	`setUniqueId(java.lang.String uniqueId)` This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.
`java.lang.String`	`toString()`

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

- Field Detail
  - DF_POLICY_COPY
```
public static final java.lang.String DF_POLICY_COPY
```
    See Also:
    
    Constant Field Values
  - DF_POLICY_CLEAR
```
public static final java.lang.String DF_POLICY_CLEAR
```
    See Also:
    
    Constant Field Values
  - DH_GROUPS_GROUP2
```
public static final java.lang.String DH_GROUPS_GROUP2
```
    See Also:
    
    Constant Field Values
  - DH_GROUPS_GROUP5
```
public static final java.lang.String DH_GROUPS_GROUP5
```
    See Also:
    
    Constant Field Values
  - DH_GROUPS_GROUP14
```
public static final java.lang.String DH_GROUPS_GROUP14
```
    See Also:
    
    Constant Field Values
  - DH_GROUPS_GROUP15
```
public static final java.lang.String DH_GROUPS_GROUP15
```
    See Also:
    
    Constant Field Values
  - DH_GROUPS_GROUP16
```
public static final java.lang.String DH_GROUPS_GROUP16
```
    See Also:
    
    Constant Field Values
  - DH_GROUPS_GROUP19
```
public static final java.lang.String DH_GROUPS_GROUP19
```
    See Also:
    
    Constant Field Values
  - DH_GROUPS_GROUP20
```
public static final java.lang.String DH_GROUPS_GROUP20
```
    See Also:
    
    Constant Field Values
  - DH_GROUPS_GROUP21
```
public static final java.lang.String DH_GROUPS_GROUP21
```
    See Also:
    
    Constant Field Values
  - DIGEST_ALGORITHMS_SHA1
```
public static final java.lang.String DIGEST_ALGORITHMS_SHA1
```
    See Also:
    
    Constant Field Values
  - DIGEST_ALGORITHMS_SHA2_256
```
public static final java.lang.String DIGEST_ALGORITHMS_SHA2_256
```
    See Also:
    
    Constant Field Values
  - DIGEST_ALGORITHMS_SHA2_384
```
public static final java.lang.String DIGEST_ALGORITHMS_SHA2_384
```
    See Also:
    
    Constant Field Values
  - DIGEST_ALGORITHMS_SHA2_512
```
public static final java.lang.String DIGEST_ALGORITHMS_SHA2_512
```
    See Also:
    
    Constant Field Values
  - ENCRYPTION_ALGORITHMS_AES_128
```
public static final java.lang.String ENCRYPTION_ALGORITHMS_AES_128
```
    See Also:
    
    Constant Field Values
  - ENCRYPTION_ALGORITHMS_AES_256
```
public static final java.lang.String ENCRYPTION_ALGORITHMS_AES_256
```
    See Also:
    
    Constant Field Values
  - ENCRYPTION_ALGORITHMS_AES_GCM_128
```
public static final java.lang.String ENCRYPTION_ALGORITHMS_AES_GCM_128
```
    See Also:
    
    Constant Field Values
  - ENCRYPTION_ALGORITHMS_AES_GCM_192
```
public static final java.lang.String ENCRYPTION_ALGORITHMS_AES_GCM_192
```
    See Also:
    
    Constant Field Values
  - ENCRYPTION_ALGORITHMS_AES_GCM_256
```
public static final java.lang.String ENCRYPTION_ALGORITHMS_AES_GCM_256
```
    See Also:
    
    Constant Field Values
  - ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_128
```
public static final java.lang.String ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_128
```
    See Also:
    
    Constant Field Values
  - ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_192
```
public static final java.lang.String ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_192
```
    See Also:
    
    Constant Field Values
  - ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_256
```
public static final java.lang.String ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_256
```
    See Also:
    
    Constant Field Values
  - ENCRYPTION_ALGORITHMS_NO_ENCRYPTION
```
public static final java.lang.String ENCRYPTION_ALGORITHMS_NO_ENCRYPTION
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - IPSecVpnTunnelProfile
```
public IPSecVpnTunnelProfile()
```
    Default constructor.
  - IPSecVpnTunnelProfile
```
protected IPSecVpnTunnelProfile(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getLinks
```
public java.util.List<ResourceLink> getLinks()
```
    The server will populate this field when returing the resource. Ignored on PUT and POST. 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.
  - setLinks
```
public void setLinks(java.util.List<ResourceLink> links)
```
    The server will populate this field when returing the resource. Ignored on PUT and POST. 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:
    
    links - New value for the property.
  - getSchema
```
public java.lang.String getSchema()
```
    Schema for 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.
  - setSchema
```
public void setSchema(java.lang.String schema)
```
    Schema for 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:
    
    schema - New value for the property.
  - getSelf
```
public SelfResourceLink getSelf()
```
    Returns:
    
    The current value of the property.
  - setSelf
```
public void setSelf(SelfResourceLink self)
```
    Parameters:
    
    self - New value for the property.
  - getRevision
```
public java.lang.Long getRevision()
```
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
    
    Returns:
    
    The current value of the property.
  - setRevision
```
public void setRevision(java.lang.Long revision)
```
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
    
    Parameters:
    
    revision - New value for the property.
  - getCreateTime
```
public java.lang.Long getCreateTime()
```
    Timestamp of resource creation 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.
  - setCreateTime
```
public void setCreateTime(java.lang.Long createTime)
```
    Timestamp of resource creation 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:
    
    createTime - New value for the property.
  - getCreateUser
```
public java.lang.String getCreateUser()
```
    ID of the user who created 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.
  - setCreateUser
```
public void setCreateUser(java.lang.String createUser)
```
    ID of the user who created 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:
    
    createUser - New value for the property.
  - getLastModifiedTime
```
public java.lang.Long getLastModifiedTime()
```
    Timestamp of last modification 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.
  - setLastModifiedTime
```
public void setLastModifiedTime(java.lang.Long lastModifiedTime)
```
    Timestamp of last modification 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:
    
    lastModifiedTime - New value for the property.
  - getLastModifiedUser
```
public java.lang.String getLastModifiedUser()
```
    ID of the user who last modified 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.
  - setLastModifiedUser
```
public void setLastModifiedUser(java.lang.String lastModifiedUser)
```
    ID of the user who last modified 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:
    
    lastModifiedUser - New value for the property.
  - getProtection
```
public java.lang.String getProtection()
```
    Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. 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.
  - setProtection
```
public void setProtection(java.lang.String protection)
```
    Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. 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:
    
    protection - New value for the property.
  - getSystemOwned
```
public java.lang.Boolean getSystemOwned()
```
    Indicates system owned 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.
  - setSystemOwned
```
public void setSystemOwned(java.lang.Boolean systemOwned)
```
    Indicates system owned 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:
    
    systemOwned - New value for the property.
  - getDescription
```
public java.lang.String getDescription()
```
    Description of this resource
    
    Returns:
    
    The current value of the property.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Description of this resource
    
    Parameters:
    
    description - New value for the property.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Defaults to ID if not set
    
    Returns:
    
    The current value of the property.
  - setDisplayName
```
public void setDisplayName(java.lang.String displayName)
```
    Defaults to ID if not set
    
    Parameters:
    
    displayName - New value for the property.
  - getId
```
public java.lang.String getId()
```
    Unique identifier of this resource
    
    Returns:
    
    The current value of the property.
  - setId
```
public void setId(java.lang.String id)
```
    Unique identifier of this resource
    
    Parameters:
    
    id - New value for the property.
  - getResourceType
```
public java.lang.String getResourceType()
```
    The type of this resource.
    
    Returns:
    
    The current value of the property.
  - setResourceType
```
public void setResourceType(java.lang.String resourceType)
```
    The type of this resource.
    
    Parameters:
    
    resourceType - New value for the property.
  - getTags
```
public java.util.List<Tag> getTags()
```
    Opaque identifiers meaningful to the API user
    
    Returns:
    
    The current value of the property.
  - setTags
```
public void setTags(java.util.List<Tag> tags)
```
    Opaque identifiers meaningful to the API user
    
    Parameters:
    
    tags - New value for the property.
  - getOriginSiteId
```
public java.lang.String getOriginSiteId()
```
    This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+. 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.
  - setOriginSiteId
```
public void setOriginSiteId(java.lang.String originSiteId)
```
    This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+. 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:
    
    originSiteId - New value for the property.
  - getOwnerId
```
public java.lang.String getOwnerId()
```
    This is a UUID generated by the system for knowing who owns this object. This is used in NSX+. 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.
  - setOwnerId
```
public void setOwnerId(java.lang.String ownerId)
```
    This is a UUID generated by the system for knowing who owns this object. This is used in NSX+. 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:
    
    ownerId - New value for the property.
  - getParentPath
```
public java.lang.String getParentPath()
```
    Path of its parent 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.
  - setParentPath
```
public void setParentPath(java.lang.String parentPath)
```
    Path of its parent 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:
    
    parentPath - New value for the property.
  - getPath
```
public java.lang.String getPath()
```
    Absolute path of this object 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.
  - setPath
```
public void setPath(java.lang.String path)
```
    Absolute path of this object 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:
    
    path - New value for the property.
  - getRealizationId
```
public java.lang.String getRealizationId()
```
    This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent. 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.
  - setRealizationId
```
public void setRealizationId(java.lang.String realizationId)
```
    This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent. 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:
    
    realizationId - New value for the property.
  - getRelativePath
```
public java.lang.String getRelativePath()
```
    Path relative from its parent 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.
  - setRelativePath
```
public void setRelativePath(java.lang.String relativePath)
```
    Path relative from its parent 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:
    
    relativePath - New value for the property.
  - getRemotePath
```
public java.lang.String getRemotePath()
```
    This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers. 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.
  - setRemotePath
```
public void setRemotePath(java.lang.String remotePath)
```
    This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers. 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:
    
    remotePath - New value for the property.
  - getUniqueId
```
public java.lang.String getUniqueId()
```
    This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites. 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.
  - setUniqueId
```
public void setUniqueId(java.lang.String uniqueId)
```
    This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites. 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:
    
    uniqueId - New value for the property.
  - getChildren
```
public java.util.List<com.vmware.vapi.bindings.Structure> getChildren()
```
    Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.
    
    Returns:
    
    The current value of the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the property will contain all the properties defined in ChildPolicyConfigResource.
  - setChildren
```
public void setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)
```
    Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.
    
    Parameters:
    
    children - New value for the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the property will contain all the properties defined in ChildPolicyConfigResource.
  - getMarkedForDelete
```
public java.lang.Boolean getMarkedForDelete()
```
    Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. 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.
  - setMarkedForDelete
```
public void setMarkedForDelete(java.lang.Boolean markedForDelete)
```
    Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. 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:
    
    markedForDelete - New value for the property.
  - getOverridden
```
public java.lang.Boolean getOverridden()
```
    Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties. 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.
  - setOverridden
```
public void setOverridden(java.lang.Boolean overridden)
```
    Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties. 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:
    
    overridden - New value for the property.
  - getDfPolicy
```
public java.lang.String getDfPolicy()
```
    Possible values are:
    - DF_POLICY_COPY
    - DF_POLICY_CLEAR
    Defragmentation policy helps to handle defragmentation bit present in the inner packet. COPY copies the defragmentation bit from the inner IP packet into the outer packet. CLEAR ignores the defragmentation bit present in the inner packet.
    Returns:
    
    The current value of the property.
  - setDfPolicy
```
public void setDfPolicy(java.lang.String dfPolicy)
```
    Possible values are:
    - DF_POLICY_COPY
    - DF_POLICY_CLEAR
    Defragmentation policy helps to handle defragmentation bit present in the inner packet. COPY copies the defragmentation bit from the inner IP packet into the outer packet. CLEAR ignores the defragmentation bit present in the inner packet.
    Parameters:
    
    dfPolicy - New value for the property.
  - getDhGroups
```
public java.util.List<java.lang.String> getDhGroups()
```
    Possible values are:
    Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.
    Returns:
    
    The current value of the property.
  - setDhGroups
```
public void setDhGroups(java.util.List<java.lang.String> dhGroups)
```
    Possible values are:
    Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.
    Parameters:
    
    dhGroups - New value for the property.
  - getDigestAlgorithms
```
public java.util.List<java.lang.String> getDigestAlgorithms()
```
    Possible values are:
    Algorithm to be used for message digest. Default digest algorithm is implicitly covered by default encryption algorithm \"AES_GCM_128\".
    Returns:
    
    The current value of the property.
  - setDigestAlgorithms
```
public void setDigestAlgorithms(java.util.List<java.lang.String> digestAlgorithms)
```
    Possible values are:
    Algorithm to be used for message digest. Default digest algorithm is implicitly covered by default encryption algorithm \"AES_GCM_128\".
    Parameters:
    
    digestAlgorithms - New value for the property.
  - getEnablePerfectForwardSecrecy
```
public java.lang.Boolean getEnablePerfectForwardSecrecy()
```
    If true, perfect forward secrecy (PFS) is enabled.
    
    Returns:
    
    The current value of the property.
  - setEnablePerfectForwardSecrecy
```
public void setEnablePerfectForwardSecrecy(java.lang.Boolean enablePerfectForwardSecrecy)
```
    If true, perfect forward secrecy (PFS) is enabled.
    
    Parameters:
    
    enablePerfectForwardSecrecy - New value for the property.
  - getEncryptionAlgorithms
```
public java.util.List<java.lang.String> getEncryptionAlgorithms()
```
    Possible values are:
    Encryption algorithm to encrypt/decrypt the messages exchanged between IPSec VPN initiator and responder during tunnel negotiation. Default is AES_GCM_128.
    Returns:
    
    The current value of the property.
  - setEncryptionAlgorithms
```
public void setEncryptionAlgorithms(java.util.List<java.lang.String> encryptionAlgorithms)
```
    Possible values are:
    Encryption algorithm to encrypt/decrypt the messages exchanged between IPSec VPN initiator and responder during tunnel negotiation. Default is AES_GCM_128.
    Parameters:
    
    encryptionAlgorithms - New value for the property.
  - getExtendedAttributes
```
public java.util.List<AttributeVal> getExtendedAttributes()
```
    Collection of type specific properties. As of now, to hold encapsulation mode and transform protocol. 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.
  - setExtendedAttributes
```
public void setExtendedAttributes(java.util.List<AttributeVal> extendedAttributes)
```
    Collection of type specific properties. As of now, to hold encapsulation mode and transform protocol. 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:
    
    extendedAttributes - New value for the property.
  - getSaLifeTime
```
public java.lang.Long getSaLifeTime()
```
    SA life time specifies the expiry time of security association. Default is 3600 seconds. format: int64
    
    Returns:
    
    The current value of the property.
  - setSaLifeTime
```
public void setSaLifeTime(java.lang.Long saLifeTime)
```
    SA life time specifies the expiry time of security association. Default is 3600 seconds. format: int64
    
    Parameters:
    
    saLifeTime - 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 IPSecVpnTunnelProfile _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 IPSecVpnTunnelProfile _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class IPSecVpnTunnelProfile

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DF_POLICY_COPY

DF_POLICY_CLEAR

DH_GROUPS_GROUP2

DH_GROUPS_GROUP5

DH_GROUPS_GROUP14

DH_GROUPS_GROUP15

DH_GROUPS_GROUP16

DH_GROUPS_GROUP19

DH_GROUPS_GROUP20

DH_GROUPS_GROUP21

DIGEST_ALGORITHMS_SHA1

DIGEST_ALGORITHMS_SHA2_256

DIGEST_ALGORITHMS_SHA2_384

DIGEST_ALGORITHMS_SHA2_512

ENCRYPTION_ALGORITHMS_AES_128

ENCRYPTION_ALGORITHMS_AES_256

ENCRYPTION_ALGORITHMS_AES_GCM_128

ENCRYPTION_ALGORITHMS_AES_GCM_192

ENCRYPTION_ALGORITHMS_AES_GCM_256

ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_128

ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_192

ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_256

ENCRYPTION_ALGORITHMS_NO_ENCRYPTION

__dynamicStructureFields

Constructor Detail

IPSecVpnTunnelProfile

IPSecVpnTunnelProfile

Method Detail

getLinks

setLinks

getSchema

setSchema

getSelf

setSelf

getRevision

setRevision

getCreateTime

setCreateTime

getCreateUser

setCreateUser

getLastModifiedTime

setLastModifiedTime

getLastModifiedUser

setLastModifiedUser

getProtection

setProtection

getSystemOwned

setSystemOwned

getDescription

setDescription

getDisplayName

setDisplayName

getId

setId

getResourceType

setResourceType

getTags

setTags

getOriginSiteId

setOriginSiteId

getOwnerId

setOwnerId

getParentPath

setParentPath

getPath

setPath

getRealizationId

setRealizationId

getRelativePath

setRelativePath

getRemotePath

setRemotePath

getUniqueId