Package com.vmware.nsx_policy.model
Class IPSecVpnTunnelProfile.Builder
- java.lang.Object
-
- com.vmware.nsx_policy.model.IPSecVpnTunnelProfile.Builder
-
- Enclosing class:
- IPSecVpnTunnelProfile
public static final class IPSecVpnTunnelProfile.Builder extends java.lang.Object
Builder class forIPSecVpnTunnelProfile
.
-
-
Constructor Summary
Constructors Constructor Description Builder()
Constructor with parameters for the required properties ofIPSecVpnTunnelProfile
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IPSecVpnTunnelProfile
build()
IPSecVpnTunnelProfile.Builder
setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)
Subtree for this type within policy tree containing nested elements.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 resourceIPSecVpnTunnelProfile.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 setIPSecVpnTunnelProfile.Builder
setEnablePerfectForwardSecrecy(java.lang.Boolean enablePerfectForwardSecrecy)
If true, perfect forward secrecy (PFS) is enabled.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
setExtendedAttributes(java.util.List<AttributeVal> extendedAttributes)
Collection of type specific properties.IPSecVpnTunnelProfile.Builder
setId(java.lang.String id)
Unique identifier of this resourceIPSecVpnTunnelProfile.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
setMarkedForDelete(java.lang.Boolean markedForDelete)
Intent objects are not directly deleted from the system when a delete is invoked on them.IPSecVpnTunnelProfile.Builder
setOriginSiteId(java.lang.String originSiteId)
This is a UUID generated by the system for knowing which site owns an object.IPSecVpnTunnelProfile.Builder
setOverridden(java.lang.Boolean overridden)
Global intent objects cannot be modified by the user.IPSecVpnTunnelProfile.Builder
setOwnerId(java.lang.String ownerId)
This is a UUID generated by the system for knowing who owns this object.IPSecVpnTunnelProfile.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.IPSecVpnTunnelProfile.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.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
setRealizationId(java.lang.String realizationId)
This is a UUID generated by the system for realizing the entity object.IPSecVpnTunnelProfile.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.IPSecVpnTunnelProfile.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.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 userIPSecVpnTunnelProfile.Builder
setUniqueId(java.lang.String uniqueId)
This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.
-
-
-
Constructor Detail
-
Builder
public Builder()
Constructor with parameters for the required properties ofIPSecVpnTunnelProfile
.
-
-
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.
-
setOriginSiteId
public IPSecVpnTunnelProfile.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 IPSecVpnTunnelProfile.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 IPSecVpnTunnelProfile.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 IPSecVpnTunnelProfile.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 IPSecVpnTunnelProfile.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 IPSecVpnTunnelProfile.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 IPSecVpnTunnelProfile.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 IPSecVpnTunnelProfile.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 IPSecVpnTunnelProfile.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 inChildPolicyConfigResource
. When methods return a value of this class as a return value, the property will contain all the properties defined inChildPolicyConfigResource
.
-
setMarkedForDelete
public IPSecVpnTunnelProfile.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 IPSecVpnTunnelProfile.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.
-
setDfPolicy
public IPSecVpnTunnelProfile.Builder setDfPolicy(java.lang.String dfPolicy)
Possible values are: 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
- Parameters:
dhGroups
- New value for the property.
-
-
setDigestAlgorithms
public IPSecVpnTunnelProfile.Builder 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.
-
setEnablePerfectForwardSecrecy
public IPSecVpnTunnelProfile.Builder setEnablePerfectForwardSecrecy(java.lang.Boolean enablePerfectForwardSecrecy)
If true, perfect forward secrecy (PFS) is enabled.- Parameters:
enablePerfectForwardSecrecy
- 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
- Parameters:
encryptionAlgorithms
- New value for the property.
-
-
setExtendedAttributes
public IPSecVpnTunnelProfile.Builder 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.
-
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.
-
build
public IPSecVpnTunnelProfile build()
-
-