com.vmware.nsx_policy.model

Class IPSecVpnRule.Builder

java.lang.Object

com.vmware.nsx_policy.model.IPSecVpnRule.Builder

Enclosing class:

IPSecVpnRule

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

Builder class for IPSecVpnRule.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
IPSecVpnRule	build()
IPSecVpnRule.Builder	setAction(java.lang.String action) Possible values are: IPSecVpnRule.ACTION_PROTECT IPSecVpnRule.ACTION_BYPASS PROTECT - Protect rules are defined per policy based IPSec VPN session.
IPSecVpnRule.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
IPSecVpnRule.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.
IPSecVpnRule.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.
IPSecVpnRule.Builder	setDescription(java.lang.String description) Description of this resource
IPSecVpnRule.Builder	setDestinations(java.util.List<IPSecVpnSubnet> destinations) List of IPv4 or IPv6 peer subnets.
IPSecVpnRule.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
IPSecVpnRule.Builder	setEnabled(java.lang.Boolean enabled) A flag to enable/disable the rule.
IPSecVpnRule.Builder	setId(java.lang.String id) Unique identifier of this resource
IPSecVpnRule.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.
IPSecVpnRule.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.
IPSecVpnRule.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
IPSecVpnRule.Builder	setLogged(java.lang.Boolean logged) A flag to enable/disable the logging for the rule.
IPSecVpnRule.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
IPSecVpnRule.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
IPSecVpnRule.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
IPSecVpnRule.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing who owns this object.
IPSecVpnRule.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.
IPSecVpnRule.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.
IPSecVpnRule.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.
IPSecVpnRule.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
IPSecVpnRule.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.
IPSecVpnRule.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.
IPSecVpnRule.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
IPSecVpnRule.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
IPSecVpnRule.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.
IPSecVpnRule.Builder	setSelf(SelfResourceLink self)
IPSecVpnRule.Builder	setSequenceNumber(java.lang.Long sequenceNumber) A sequence number is used to give a priority to an IPSecVpnRule.
IPSecVpnRule.Builder	setSources(java.util.List<IPSecVpnSubnet> sources) List of IPv4 or IPv6 local subnets.
IPSecVpnRule.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.
IPSecVpnRule.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
IPSecVpnRule.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 IPSecVpnRule.

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

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

setAction

public IPSecVpnRule.Builder setAction(java.lang.String action)

Possible values are:

• IPSecVpnRule.ACTION_PROTECT
• IPSecVpnRule.ACTION_BYPASS

PROTECT - Protect rules are defined per policy based IPSec VPN session. BYPASS - Bypass rules are defined per IPSec VPN service and affects all policy based IPSec VPN sessions. Bypass rules are prioritized over protect rules. 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:

action - New value for the property.

setDestinations

public IPSecVpnRule.Builder setDestinations(java.util.List<IPSecVpnSubnet> destinations)

List of IPv4 or IPv6 peer subnets. Specifying no value is interpreted as 0.0.0.0/0, ::/0. The maximum number of IPv4 or IPv6 local subnets allowed is 128 Please note that configuring IPv6 peer subnets is not supported in the deprecated IPSecVpnSession Patch/PUT APIs.

Parameters:

destinations - New value for the property.

setEnabled

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

A flag to enable/disable the rule.

Parameters:

enabled - New value for the property.

setLogged

public IPSecVpnRule.Builder setLogged(java.lang.Boolean logged)

A flag to enable/disable the logging for the rule.

Parameters:

logged - New value for the property.

setSequenceNumber

public IPSecVpnRule.Builder setSequenceNumber(java.lang.Long sequenceNumber)

A sequence number is used to give a priority to an IPSecVpnRule. format: int32

Parameters:

sequenceNumber - New value for the property.

setSources

public IPSecVpnRule.Builder setSources(java.util.List<IPSecVpnSubnet> sources)

List of IPv4 or IPv6 local subnets. Specifying no value is interpreted as 0.0.0.0/0, ::/0. The maximum number of IPv4 or IPv6 local subnets allowed is 128 Please note that configuring IPv6 local subnets is not supported in the deprecated IPSecVpnSession Patch/PUT APIs.

Parameters:

sources - New value for the property.

build

public IPSecVpnRule build()