com.vmware.nsx_global_policy.model

Class IPSecVpnService.Builder

java.lang.Object

com.vmware.nsx_global_policy.model.IPSecVpnService.Builder

Enclosing class:

IPSecVpnService

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

Builder class for IPSecVpnService.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
IPSecVpnService	build()
IPSecVpnService.Builder	setBypassRules(java.util.List<IPSecVpnRule> bypassRules) Bypass policy rules are configured using VPN service.
IPSecVpnService.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
IPSecVpnService.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.
IPSecVpnService.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.
IPSecVpnService.Builder	setDescription(java.lang.String description) Description of this resource
IPSecVpnService.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
IPSecVpnService.Builder	setEnabled(java.lang.Boolean enabled) If true, enable VPN services under tier-0/tier-1.
IPSecVpnService.Builder	setHaSync(java.lang.Boolean haSync) Enable/disable IPSec HA state sync.
IPSecVpnService.Builder	setId(java.lang.String id) Unique identifier of this resource
IPSecVpnService.Builder	setIkeLogLevel(java.lang.String ikeLogLevel) Possible values are: IPSecVpnService.IKE_LOG_LEVEL_DEBUG IPSecVpnService.IKE_LOG_LEVEL_INFO IPSecVpnService.IKE_LOG_LEVEL_WARN IPSecVpnService.IKE_LOG_LEVEL_ERROR IPSecVpnService.IKE_LOG_LEVEL_EMERGENCY Log level for internet key exchange (IKE).
IPSecVpnService.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.
IPSecVpnService.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.
IPSecVpnService.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
IPSecVpnService.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
IPSecVpnService.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
IPSecVpnService.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
IPSecVpnService.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing who owns this object.
IPSecVpnService.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.
IPSecVpnService.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.
IPSecVpnService.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.
IPSecVpnService.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
IPSecVpnService.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.
IPSecVpnService.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.
IPSecVpnService.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
IPSecVpnService.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
IPSecVpnService.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.
IPSecVpnService.Builder	setSelf(SelfResourceLink self)
IPSecVpnService.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.
IPSecVpnService.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
IPSecVpnService.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 IPSecVpnService.

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

public IPSecVpnService.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 IPSecVpnService.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 IPSecVpnService.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 IPSecVpnService.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 IPSecVpnService.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 IPSecVpnService.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 IPSecVpnService.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 IPSecVpnService.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 IPSecVpnService.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 IPSecVpnService.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 IPSecVpnService.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.

setBypassRules

public IPSecVpnService.Builder setBypassRules(java.util.List<IPSecVpnRule> bypassRules)

Bypass policy rules are configured using VPN service. Bypass rules always have higher priority over protect rules and they affect all policy based vpn sessions associated with the IPSec VPN service. Protect rules are defined per policy based vpn session.

Parameters:

bypassRules - New value for the property.

setEnabled

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

If true, enable VPN services under tier-0/tier-1.

Parameters:

enabled - New value for the property.

setHaSync

public IPSecVpnService.Builder setHaSync(java.lang.Boolean haSync)

Enable/disable IPSec HA state sync. IPSec HA state sync can be disabled if in case there are performance issues w.r.t. the state sync messages.

Parameters:

haSync - New value for the property.

setIkeLogLevel

public IPSecVpnService.Builder setIkeLogLevel(java.lang.String ikeLogLevel)

Possible values are:

• IPSecVpnService.IKE_LOG_LEVEL_DEBUG
• IPSecVpnService.IKE_LOG_LEVEL_INFO
• IPSecVpnService.IKE_LOG_LEVEL_WARN
• IPSecVpnService.IKE_LOG_LEVEL_ERROR
• IPSecVpnService.IKE_LOG_LEVEL_EMERGENCY

Log level for internet key exchange (IKE).

Parameters:

ikeLogLevel - New value for the property.

build

public IPSecVpnService build()