com.vmware.nsx_policy.model

Class L3Vpn.Builder

java.lang.Object

com.vmware.nsx_policy.model.L3Vpn.Builder

Enclosing class:

L3Vpn

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

Builder class for L3Vpn.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
L3Vpn	build()
L3Vpn.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
L3Vpn.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.
L3Vpn.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.
L3Vpn.Builder	setDescription(java.lang.String description) Description of this resource
L3Vpn.Builder	setDhGroups(java.util.List<java.lang.String> dhGroups) Possible values are: L3Vpn.DH_GROUPS_GROUP2 L3Vpn.DH_GROUPS_GROUP5 L3Vpn.DH_GROUPS_GROUP14 L3Vpn.DH_GROUPS_GROUP15 L3Vpn.DH_GROUPS_GROUP16 Diffie-Hellman group to be used if PFS is enabled.
L3Vpn.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
L3Vpn.Builder	setEnabled(java.lang.Boolean enabled) Flag to enable L3Vpn.
L3Vpn.Builder	setEnablePerfectForwardSecrecy(java.lang.Boolean enablePerfectForwardSecrecy) If true, perfect forward secrecy (PFS) is enabled.
L3Vpn.Builder	setId(java.lang.String id) Unique identifier of this resource
L3Vpn.Builder	setIkeDigestAlgorithms(java.util.List<java.lang.String> ikeDigestAlgorithms) Possible values are: L3Vpn.IKE_DIGEST_ALGORITHMS_SHA1 L3Vpn.IKE_DIGEST_ALGORITHMS_SHA2_256 L3Vpn.IKE_DIGEST_ALGORITHMS_SHA2_384 L3Vpn.IKE_DIGEST_ALGORITHMS_SHA2_512 Algorithm to be used for message digest during Internet Key Exchange(IKE) negotiation.
L3Vpn.Builder	setIkeEncryptionAlgorithms(java.util.List<java.lang.String> ikeEncryptionAlgorithms) Possible values are: L3Vpn.IKE_ENCRYPTION_ALGORITHMS_128 L3Vpn.IKE_ENCRYPTION_ALGORITHMS_256 L3Vpn.IKE_ENCRYPTION_ALGORITHMS_GCM_128 L3Vpn.IKE_ENCRYPTION_ALGORITHMS_GCM_192 L3Vpn.IKE_ENCRYPTION_ALGORITHMS_GCM_256 Algorithm to be used during Internet Key Exchange(IKE) negotiation.
L3Vpn.Builder	setIkeVersion(java.lang.String ikeVersion) Possible values are: L3Vpn.IKE_VERSION_V1 L3Vpn.IKE_VERSION_V2 L3Vpn.IKE_VERSION_FLEX IKE protocol version to be used.
L3Vpn.Builder	setL3vpnSession(com.vmware.vapi.bindings.Structure l3vpnSession)
L3Vpn.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.
L3Vpn.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.
L3Vpn.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
L3Vpn.Builder	setLocalAddress(java.lang.String localAddress) IPv4 address of local gateway format: ipv4
L3Vpn.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
L3Vpn.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
L3Vpn.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
L3Vpn.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing who owns this object.
L3Vpn.Builder	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.
L3Vpn.Builder	setPassphrases(java.util.List<java.lang.String> passphrases) List of IPSec pre-shared keys used for IPSec authentication.
L3Vpn.Builder	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.
L3Vpn.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.
L3Vpn.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
L3Vpn.Builder	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.
L3Vpn.Builder	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.
L3Vpn.Builder	setRemotePrivateAddress(java.lang.String remotePrivateAddress) This field is used to resolve conflicts in case of a remote site being behind NAT as remote public ip address is not enough.
L3Vpn.Builder	setRemotePublicAddress(java.lang.String remotePublicAddress) Public IPv4 address of remote gateway format: ipv4
L3Vpn.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
L3Vpn.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
L3Vpn.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.
L3Vpn.Builder	setSelf(SelfResourceLink self)
L3Vpn.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.
L3Vpn.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
L3Vpn.Builder	setTunnelDigestAlgorithms(java.util.List<java.lang.String> tunnelDigestAlgorithms) Possible values are: L3Vpn.TUNNEL_DIGEST_ALGORITHMS_SHA1 L3Vpn.TUNNEL_DIGEST_ALGORITHMS_SHA2_256 L3Vpn.TUNNEL_DIGEST_ALGORITHMS_SHA2_384 L3Vpn.TUNNEL_DIGEST_ALGORITHMS_SHA2_512 Algorithm to be used for message digest during tunnel establishment.
L3Vpn.Builder	setTunnelEncryptionAlgorithms(java.util.List<java.lang.String> tunnelEncryptionAlgorithms) Possible values are: L3Vpn.TUNNEL_ENCRYPTION_ALGORITHMS_128 L3Vpn.TUNNEL_ENCRYPTION_ALGORITHMS_256 L3Vpn.TUNNEL_ENCRYPTION_ALGORITHMS_GCM_128 L3Vpn.TUNNEL_ENCRYPTION_ALGORITHMS_GCM_192 L3Vpn.TUNNEL_ENCRYPTION_ALGORITHMS_GCM_256 Encryption algorithm to encrypt/decrypt the messages exchanged between IPSec VPN initiator and responder during tunnel negotiation.
L3Vpn.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.

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 L3Vpn.

Method Detail

setLinks

public L3Vpn.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 L3Vpn.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 L3Vpn.Builder setSelf(SelfResourceLink self)

Parameters:

self - New value for the property.

setRevision

public L3Vpn.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 L3Vpn.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 L3Vpn.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 L3Vpn.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 L3Vpn.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 L3Vpn.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 L3Vpn.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 L3Vpn.Builder setDescription(java.lang.String description)

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

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

setOwnerId

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

setParentPath

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

setPath

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

setRealizationId

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

setRelativePath

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

setRemotePath

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

setUniqueId

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

setChildren

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

setMarkedForDelete

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

setOverridden

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

setDhGroups

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

Possible values are:

• L3Vpn.DH_GROUPS_GROUP2
• L3Vpn.DH_GROUPS_GROUP5
• L3Vpn.DH_GROUPS_GROUP14
• L3Vpn.DH_GROUPS_GROUP15
• L3Vpn.DH_GROUPS_GROUP16

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

Parameters:

dhGroups - New value for the property.

setEnablePerfectForwardSecrecy

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

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

Parameters:

enablePerfectForwardSecrecy - New value for the property.

setEnabled

public L3Vpn.Builder setEnabled(java.lang.Boolean enabled)

Flag to enable L3Vpn. Default is enabled.

Parameters:

enabled - New value for the property.

setIkeDigestAlgorithms

public L3Vpn.Builder setIkeDigestAlgorithms(java.util.List<java.lang.String> ikeDigestAlgorithms)

Possible values are:

• L3Vpn.IKE_DIGEST_ALGORITHMS_SHA1
• L3Vpn.IKE_DIGEST_ALGORITHMS_SHA2_256
• L3Vpn.IKE_DIGEST_ALGORITHMS_SHA2_384
• L3Vpn.IKE_DIGEST_ALGORITHMS_SHA2_512

Algorithm to be used for message digest during Internet Key Exchange(IKE) negotiation. Default is SHA2_256.

Parameters:

ikeDigestAlgorithms - New value for the property.

setIkeEncryptionAlgorithms

public L3Vpn.Builder setIkeEncryptionAlgorithms(java.util.List<java.lang.String> ikeEncryptionAlgorithms)

Possible values are:

• L3Vpn.IKE_ENCRYPTION_ALGORITHMS_128
• L3Vpn.IKE_ENCRYPTION_ALGORITHMS_256
• L3Vpn.IKE_ENCRYPTION_ALGORITHMS_GCM_128
• L3Vpn.IKE_ENCRYPTION_ALGORITHMS_GCM_192
• L3Vpn.IKE_ENCRYPTION_ALGORITHMS_GCM_256

Algorithm to be used during Internet Key Exchange(IKE) negotiation. Default is AES_128.

Parameters:

ikeEncryptionAlgorithms - New value for the property.

setIkeVersion

public L3Vpn.Builder setIkeVersion(java.lang.String ikeVersion)

Possible values are:

• L3Vpn.IKE_VERSION_V1
• L3Vpn.IKE_VERSION_V2
• L3Vpn.IKE_VERSION_FLEX

IKE protocol version to be used. IKE-Flex will initiate IKE-V2 and responds to both IKE-V1 and IKE-V2.

Parameters:

ikeVersion - New value for the property.

setL3vpnSession

public L3Vpn.Builder setL3vpnSession(com.vmware.vapi.bindings.Structure l3vpnSession)

Parameters:

l3vpnSession - 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 L3VpnSession. When methods return a value of this class as a return value, the property will contain all the properties defined in L3VpnSession.

setLocalAddress

public L3Vpn.Builder setLocalAddress(java.lang.String localAddress)

IPv4 address of local gateway format: ipv4

Parameters:

localAddress - New value for the property.

setPassphrases

public L3Vpn.Builder setPassphrases(java.util.List<java.lang.String> passphrases)

List of IPSec pre-shared keys used for IPSec authentication. If not specified, the older passphrase values are retained if there are any.

Parameters:

passphrases - New value for the property.

setRemotePrivateAddress

public L3Vpn.Builder setRemotePrivateAddress(java.lang.String remotePrivateAddress)

This field is used to resolve conflicts in case of a remote site being behind NAT as remote public ip address is not enough. If it is not the case the remote public address should be provided here. If not provided, the value of this field is set to remote_public_address.

Parameters:

remotePrivateAddress - New value for the property.

setRemotePublicAddress

public L3Vpn.Builder setRemotePublicAddress(java.lang.String remotePublicAddress)

Public IPv4 address of remote gateway format: ipv4

Parameters:

remotePublicAddress - New value for the property.

setTunnelDigestAlgorithms

public L3Vpn.Builder setTunnelDigestAlgorithms(java.util.List<java.lang.String> tunnelDigestAlgorithms)

Possible values are:

• L3Vpn.TUNNEL_DIGEST_ALGORITHMS_SHA1
• L3Vpn.TUNNEL_DIGEST_ALGORITHMS_SHA2_256
• L3Vpn.TUNNEL_DIGEST_ALGORITHMS_SHA2_384
• L3Vpn.TUNNEL_DIGEST_ALGORITHMS_SHA2_512

Algorithm to be used for message digest during tunnel establishment. Default algorithm is empty.

Parameters:

tunnelDigestAlgorithms - New value for the property.

setTunnelEncryptionAlgorithms

public L3Vpn.Builder setTunnelEncryptionAlgorithms(java.util.List<java.lang.String> tunnelEncryptionAlgorithms)

Possible values are:

• L3Vpn.TUNNEL_ENCRYPTION_ALGORITHMS_128
• L3Vpn.TUNNEL_ENCRYPTION_ALGORITHMS_256
• L3Vpn.TUNNEL_ENCRYPTION_ALGORITHMS_GCM_128
• L3Vpn.TUNNEL_ENCRYPTION_ALGORITHMS_GCM_192
• L3Vpn.TUNNEL_ENCRYPTION_ALGORITHMS_GCM_256

Encryption algorithm to encrypt/decrypt the messages exchanged between IPSec VPN initiator and responder during tunnel negotiation. Default is AES_GCM_128.

Parameters:

tunnelEncryptionAlgorithms - New value for the property.

build

public L3Vpn build()