com.vmware.nsx.model

Class IPSecVPNTunnelProfile.Builder

java.lang.Object

com.vmware.nsx.model.IPSecVPNTunnelProfile.Builder

Enclosing class:

IPSecVPNTunnelProfile

public static final class IPSecVPNTunnelProfile.Builder
extends java.lang.Object

Builder class for IPSecVPNTunnelProfile.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor with parameters for the required properties of IPSecVPNTunnelProfile.

Method Summary

Modifier and Type	Method and Description
IPSecVPNTunnelProfile	build()
IPSecVPNTunnelProfile.Builder	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.
IPSecVPNTunnelProfile.Builder	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.
IPSecVPNTunnelProfile.Builder	setDescription(java.lang.String description) Description of this resource
IPSecVPNTunnelProfile.Builder	setDfPolicy(java.lang.String dfPolicy) Possible values are: IPSecVPNTunnelProfile.DF_POLICY_COPY IPSecVPNTunnelProfile.DF_POLICY_CLEAR Defragmentation policy helps to handle defragmentation bit present in the inner packet.
IPSecVPNTunnelProfile.Builder	setDhGroups(java.util.List<java.lang.String> dhGroups) Possible values are: IPSecVPNTunnelProfile.DH_GROUPS_GROUP2 IPSecVPNTunnelProfile.DH_GROUPS_GROUP5 IPSecVPNTunnelProfile.DH_GROUPS_GROUP14 IPSecVPNTunnelProfile.DH_GROUPS_GROUP15 IPSecVPNTunnelProfile.DH_GROUPS_GROUP16 IPSecVPNTunnelProfile.DH_GROUPS_GROUP19 IPSecVPNTunnelProfile.DH_GROUPS_GROUP20 IPSecVPNTunnelProfile.DH_GROUPS_GROUP21 Diffie-Hellman group to be used if PFS is enabled.
IPSecVPNTunnelProfile.Builder	setDigestAlgorithms(java.util.List<java.lang.String> digestAlgorithms) Possible values are: IPSecVPNTunnelProfile.DIGEST_ALGORITHMS_SHA1 IPSecVPNTunnelProfile.DIGEST_ALGORITHMS_SHA2_256 IPSecVPNTunnelProfile.DIGEST_ALGORITHMS_SHA2_384 IPSecVPNTunnelProfile.DIGEST_ALGORITHMS_SHA2_512 Algorithm to be used for message digest.
IPSecVPNTunnelProfile.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
IPSecVPNTunnelProfile.Builder	setEnablePerfectForwardSecrecy(java.lang.Boolean enablePerfectForwardSecrecy) If true, perfect forward secrecy (PFS) is enabled.
IPSecVPNTunnelProfile.Builder	setEncapsulationMode(java.lang.String encapsulationMode) Possible values are: IPSecVPNTunnelProfile.ENCAPSULATION_MODE_MODE Encapsulation Mode to be used for encryption of packet.
IPSecVPNTunnelProfile.Builder	setEncryptionAlgorithms(java.util.List<java.lang.String> encryptionAlgorithms) Possible values are: IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_AES_128 IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_AES_256 IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_AES_GCM_128 IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_AES_GCM_192 IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_AES_GCM_256 IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_128 IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_192 IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_256 IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_NO_ENCRYPTION Encryption algorithm to encrypt/decrypt the messages exchanged between IPSec VPN initiator and responder during tunnel negotiation.
IPSecVPNTunnelProfile.Builder	setId(java.lang.String id) Unique identifier of this resource
IPSecVPNTunnelProfile.Builder	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.
IPSecVPNTunnelProfile.Builder	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.
IPSecVPNTunnelProfile.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
IPSecVPNTunnelProfile.Builder	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.
IPSecVPNTunnelProfile.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
IPSecVPNTunnelProfile.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
IPSecVPNTunnelProfile.Builder	setSaLifeTime(java.lang.Long saLifeTime) SA life time specifies the expiry time of security association.
IPSecVPNTunnelProfile.Builder	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.
IPSecVPNTunnelProfile.Builder	setSelf(SelfResourceLink self)
IPSecVPNTunnelProfile.Builder	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.
IPSecVPNTunnelProfile.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
IPSecVPNTunnelProfile.Builder	setTransformProtocol(java.lang.String transformProtocol) Possible values are: IPSecVPNTunnelProfile.TRANSFORM_PROTOCOL_ESP IPSec transform specifies IPSec security protocol.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Constructor with parameters for the required properties of IPSecVPNTunnelProfile.

Method Detail

setLinks

public IPSecVPNTunnelProfile.Builder 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.

setSchema

public IPSecVPNTunnelProfile.Builder 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.

setSelf

public IPSecVPNTunnelProfile.Builder setSelf(SelfResourceLink self)

Parameters:

self - New value for the property.

setRevision

public IPSecVPNTunnelProfile.Builder 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.

setCreateTime

public IPSecVPNTunnelProfile.Builder 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.

setCreateUser

public IPSecVPNTunnelProfile.Builder 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.

setLastModifiedTime

public IPSecVPNTunnelProfile.Builder 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.

setLastModifiedUser

public IPSecVPNTunnelProfile.Builder 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.

setProtection

public IPSecVPNTunnelProfile.Builder 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.

setSystemOwned

public IPSecVPNTunnelProfile.Builder 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.

setDescription

public IPSecVPNTunnelProfile.Builder setDescription(java.lang.String description)

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

public IPSecVPNTunnelProfile.Builder setDisplayName(java.lang.String displayName)

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

public IPSecVPNTunnelProfile.Builder setId(java.lang.String id)

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

public IPSecVPNTunnelProfile.Builder setResourceType(java.lang.String resourceType)

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

public IPSecVPNTunnelProfile.Builder setTags(java.util.List<Tag> tags)

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setDfPolicy

public IPSecVPNTunnelProfile.Builder setDfPolicy(java.lang.String dfPolicy)

Possible values are:

• IPSecVPNTunnelProfile.DF_POLICY_COPY
• IPSecVPNTunnelProfile.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.

setDhGroups

public IPSecVPNTunnelProfile.Builder setDhGroups(java.util.List<java.lang.String> dhGroups)

Possible values are:

• IPSecVPNTunnelProfile.DH_GROUPS_GROUP2
• IPSecVPNTunnelProfile.DH_GROUPS_GROUP5
• IPSecVPNTunnelProfile.DH_GROUPS_GROUP14
• IPSecVPNTunnelProfile.DH_GROUPS_GROUP15
• IPSecVPNTunnelProfile.DH_GROUPS_GROUP16
• IPSecVPNTunnelProfile.DH_GROUPS_GROUP19
• IPSecVPNTunnelProfile.DH_GROUPS_GROUP20
• IPSecVPNTunnelProfile.DH_GROUPS_GROUP21

Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.

Parameters:

dhGroups - New value for the property.

setDigestAlgorithms

public IPSecVPNTunnelProfile.Builder setDigestAlgorithms(java.util.List<java.lang.String> digestAlgorithms)

Possible values are:

• IPSecVPNTunnelProfile.DIGEST_ALGORITHMS_SHA1
• IPSecVPNTunnelProfile.DIGEST_ALGORITHMS_SHA2_256
• IPSecVPNTunnelProfile.DIGEST_ALGORITHMS_SHA2_384
• IPSecVPNTunnelProfile.DIGEST_ALGORITHMS_SHA2_512

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.

setEnablePerfectForwardSecrecy

public IPSecVPNTunnelProfile.Builder setEnablePerfectForwardSecrecy(java.lang.Boolean enablePerfectForwardSecrecy)

If true, perfect forward secrecy (PFS) is enabled.

Parameters:

enablePerfectForwardSecrecy - New value for the property.

setEncapsulationMode

public IPSecVPNTunnelProfile.Builder setEncapsulationMode(java.lang.String encapsulationMode)

Possible values are:

• IPSecVPNTunnelProfile.ENCAPSULATION_MODE_MODE

Encapsulation Mode to be used for encryption of packet. Tunnel mode protects internal routing information by encrypting IP header of original packet. 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:

encapsulationMode - New value for the property.

setEncryptionAlgorithms

public IPSecVPNTunnelProfile.Builder setEncryptionAlgorithms(java.util.List<java.lang.String> encryptionAlgorithms)

Possible values are:

• IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_AES_128
• IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_AES_256
• IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_AES_GCM_128
• IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_AES_GCM_192
• IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_AES_GCM_256
• IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_128
• IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_192
• IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_256
• IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_NO_ENCRYPTION

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.

setSaLifeTime

public IPSecVPNTunnelProfile.Builder 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.

setTransformProtocol

public IPSecVPNTunnelProfile.Builder setTransformProtocol(java.lang.String transformProtocol)

Possible values are:

• IPSecVPNTunnelProfile.TRANSFORM_PROTOCOL_ESP

IPSec transform specifies IPSec security 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:

transformProtocol - New value for the property.

build

public IPSecVPNTunnelProfile build()