com.vmware.nsx_policy.model

Class PolicyNatRule.Builder

java.lang.Object

com.vmware.nsx_policy.model.PolicyNatRule.Builder

Enclosing class:

PolicyNatRule

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

Builder class for PolicyNatRule.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PolicyNatRule	build()
PolicyNatRule.Builder	setAction(java.lang.String action) Possible values are: PolicyNatRule.ACTION_SNAT PolicyNatRule.ACTION_DNAT PolicyNatRule.ACTION_REFLEXIVE PolicyNatRule.ACTION_NO_SNAT PolicyNatRule.ACTION_NO_DNAT PolicyNatRule.ACTION_NAT64 Source NAT(SNAT) - translates a source IP address in an outbound packet so that the packet appears to originate from a different network.
PolicyNatRule.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
PolicyNatRule.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.
PolicyNatRule.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.
PolicyNatRule.Builder	setDescription(java.lang.String description) Description of this resource
PolicyNatRule.Builder	setDestinationNetwork(java.lang.String destinationNetwork) This supports single IP address or comma separated list of single IP addresses or CIDR.
PolicyNatRule.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
PolicyNatRule.Builder	setEnabled(java.lang.Boolean enabled) The flag, which suggests whether the NAT rule is enabled or disabled.
PolicyNatRule.Builder	setFirewallMatch(java.lang.String firewallMatch) Possible values are: PolicyNatRule.FIREWALL_MATCH_MATCH_EXTERNAL_ADDRESS PolicyNatRule.FIREWALL_MATCH_MATCH_INTERNAL_ADDRESS PolicyNatRule.FIREWALL_MATCH_BYPASS It indicates how the firewall matches the address after NATing if firewall stage is not skipped.
PolicyNatRule.Builder	setId(java.lang.String id) Unique identifier of this resource
PolicyNatRule.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.
PolicyNatRule.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.
PolicyNatRule.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
PolicyNatRule.Builder	setLogging(java.lang.Boolean logging) The flag, which suggests whether the logging of NAT rule is enabled or disabled.
PolicyNatRule.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
PolicyNatRule.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
PolicyNatRule.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
PolicyNatRule.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing who owns this object.
PolicyNatRule.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.
PolicyNatRule.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.
PolicyNatRule.Builder	setPolicyBasedVpnMode(java.lang.String policyBasedVpnMode) Possible values are: PolicyNatRule.POLICY_BASED_VPN_MODE_BYPASS PolicyNatRule.POLICY_BASED_VPN_MODE_MATCH It indicates how the NSX edge applies Nat Policy for VPN traffic.
PolicyNatRule.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.
PolicyNatRule.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
PolicyNatRule.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.
PolicyNatRule.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.
PolicyNatRule.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
PolicyNatRule.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
PolicyNatRule.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.
PolicyNatRule.Builder	setScope(java.util.List<java.lang.String> scope) Represents the array of policy paths of ProviderInterface or NetworkInterface or labels of type ProviderInterface or NetworkInterface or IPSecVpnSession on which the NAT rule should get enforced.
PolicyNatRule.Builder	setSelf(SelfResourceLink self)
PolicyNatRule.Builder	setSequenceNumber(java.lang.Long sequenceNumber) The sequence_number decides the rule_priority of a NAT rule.
PolicyNatRule.Builder	setService(java.lang.String service) It represents the path of Service on which the NAT rule will be applied.
PolicyNatRule.Builder	setSourceNetwork(java.lang.String sourceNetwork) This supports single IP address or comma separated list of single IP addresses or CIDR.
PolicyNatRule.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.
PolicyNatRule.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
PolicyNatRule.Builder	setTranslatedNetwork(java.lang.String translatedNetwork) This supports single IP address or comma separated list of single IP addresses or CIDR.
PolicyNatRule.Builder	setTranslatedPorts(java.lang.String translatedPorts) Please note, if there is service configured in this NAT rule, the translated_port will be realized on NSX Manager as the destination_port.
PolicyNatRule.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 PolicyNatRule.

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

public PolicyNatRule.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 PolicyNatRule.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 PolicyNatRule.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 PolicyNatRule.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 PolicyNatRule.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 PolicyNatRule.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 PolicyNatRule.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 PolicyNatRule.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 PolicyNatRule.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 PolicyNatRule.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 PolicyNatRule.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 PolicyNatRule.Builder setAction(java.lang.String action)

Possible values are:

• PolicyNatRule.ACTION_SNAT
• PolicyNatRule.ACTION_DNAT
• PolicyNatRule.ACTION_REFLEXIVE
• PolicyNatRule.ACTION_NO_SNAT
• PolicyNatRule.ACTION_NO_DNAT
• PolicyNatRule.ACTION_NAT64

Source NAT(SNAT) - translates a source IP address in an outbound packet so that the packet appears to originate from a different network. SNAT is only supported when the logical router is running in active-standby mode. Destination NAT(DNAT) - translates the destination IP address of inbound packets so that packets are delivered to a target address into another network. DNAT is only supported when the logical router is running in active-standby mode. Reflexive NAT(REFLEXIVE) - IP-Range and CIDR are supported to define the \"n\". The number of original networks should be exactly the same as that of translated networks. The address translation is deterministic. Reflexive is supported on both Active/Standby and Active/Active LR. NO_SNAT and NO_DNAT - These do not have support for translated_fields, only source_network and destination_network fields are supported. NAT64 - translates an external IPv6 address to a internal IPv4 address.

Parameters:

action - New value for the property.

setDestinationNetwork

public PolicyNatRule.Builder setDestinationNetwork(java.lang.String destinationNetwork)

This supports single IP address or comma separated list of single IP addresses or CIDR. This does not support IP range or IP sets. For DNAT and NO_DNAT rules, this is a mandatory field, and represents the destination network for the incoming packets. For other type of rules, optionally it can contain destination network of outgoing packets. NULL value for this field represents ANY network. For VPC DNAT NATRule, destination network address should be IPv4 address allocated from External Block associated with VPC. format: list-of-address-or-block-or-range

Parameters:

destinationNetwork - New value for the property.

setEnabled

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

The flag, which suggests whether the NAT rule is enabled or disabled. The default is True.

Parameters:

enabled - New value for the property.

setFirewallMatch

public PolicyNatRule.Builder setFirewallMatch(java.lang.String firewallMatch)

Possible values are:

• PolicyNatRule.FIREWALL_MATCH_MATCH_EXTERNAL_ADDRESS
• PolicyNatRule.FIREWALL_MATCH_MATCH_INTERNAL_ADDRESS
• PolicyNatRule.FIREWALL_MATCH_BYPASS

It indicates how the firewall matches the address after NATing if firewall stage is not skipped. MATCH_EXTERNAL_ADDRESS indicates the firewall will be applied to external address of a NAT rule. For SNAT, the external address is the translated source address after NAT is done. For DNAT, the external address is the original destination address before NAT is done. For REFLEXIVE, to egress traffic, the firewall will be applied to the translated source address after NAT is done; To ingress traffic, the firewall will be applied to the original destination address before NAT is done. MATCH_INTERNAL_ADDRESS indicates the firewall will be applied to internal address of a NAT rule. For SNAT, the internal address is the original source address before NAT is done. For DNAT, the internal address is the translated destination address after NAT is done. For REFLEXIVE, to egress traffic, the firewall will be applied to the original source address before NAT is done; To ingress traffic, the firewall will be applied to the translated destination address after NAT is done. BYPASS indicates the firewall stage will be skipped. For NO_SNAT or NO_DNAT, it must be BYPASS or leave it unassigned

Parameters:

firewallMatch - New value for the property.

setLogging

public PolicyNatRule.Builder setLogging(java.lang.Boolean logging)

The flag, which suggests whether the logging of NAT rule is enabled or disabled. The default is False.

Parameters:

logging - New value for the property.

setPolicyBasedVpnMode

public PolicyNatRule.Builder setPolicyBasedVpnMode(java.lang.String policyBasedVpnMode)

Possible values are:

• PolicyNatRule.POLICY_BASED_VPN_MODE_BYPASS
• PolicyNatRule.POLICY_BASED_VPN_MODE_MATCH

It indicates how the NSX edge applies Nat Policy for VPN traffic. It is supported only for Nat Rule action type DNAT and NO_DNAT. For all other NAT action, leave it unassigned. BYPASS - Default vpn mode. It indicates that Nat policy will be applied to the inbound traffic on Routed Based VPN tunnel, if the policy based VTI is in the \"scope\" for this rule. Default value will be set to BYPASS if MATCH - It indicates that this NAT rule will only match the Policy Based VPN traffic.

Parameters:

policyBasedVpnMode - New value for the property.

setScope

public PolicyNatRule.Builder setScope(java.util.List<java.lang.String> scope)

Represents the array of policy paths of ProviderInterface or NetworkInterface or labels of type ProviderInterface or NetworkInterface or IPSecVpnSession on which the NAT rule should get enforced. The interfaces must belong to the same router for which the NAT Rule is created.

Parameters:

scope - New value for the property.

setSequenceNumber

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

The sequence_number decides the rule_priority of a NAT rule. Sequence_number and rule_priority have 1:1 mapping.For each NAT section, there will be reserved rule_priority numbers.The valid range of rule_priority number is from 0 to 2147483647(MAX_INT). 1. INTERNAL section rule_priority reserved from 0 - 1023 (1024 rules) valid sequence_number range 0 - 1023 2. USER section rule_priority reserved from 1024 - 2147482623 (2147481600 rules) valid sequence_number range 0 - 2147481599 3. DEFAULT section rule_priority reserved from 2147482624 - 2147483647 (1024 rules) valid sequence_number range 0 - 1023 format: int32

Parameters:

sequenceNumber - New value for the property.

setService

public PolicyNatRule.Builder setService(java.lang.String service)

It represents the path of Service on which the NAT rule will be applied. If not provided or if it is blank then Policy manager will consider it as ANY. Please note, if this is a DNAT, the destination_port of the service will be realized on NSX Manager as the translated_port. And if this is a SNAT, the destination_port will be ignored.

Parameters:

service - New value for the property.

setSourceNetwork

public PolicyNatRule.Builder setSourceNetwork(java.lang.String sourceNetwork)

This supports single IP address or comma separated list of single IP addresses or CIDR. This does not support IP range or IP sets. For SNAT, NO_SNAT, NAT64 and REFLEXIVE rules, this is a mandatory field and represents the source network of the packets leaving the network. For DNAT and NO_DNAT rules, optionally it can contain source network of incoming packets. NULL value for this field represents ANY network. format: list-of-address-or-block-or-range

Parameters:

sourceNetwork - New value for the property.

setTranslatedNetwork

public PolicyNatRule.Builder setTranslatedNetwork(java.lang.String translatedNetwork)

This supports single IP address or comma separated list of single IP addresses or CIDR. If user specify the CIDR, this value is actually used as an IP pool that includes both the subnet and broadcast addresses as valid for NAT translations. This does not support IP range or IP sets. Comma separated list of single IP addresses is not suported for DNAT and REFLEXIVE rules. For SNAT, DNAT, NAT64 and REFLEXIVE rules, this ia a mandatory field, which represents the translated network address. For NO_SNAT and NO_DNAT this should be empty. For VPC SNAT and Refelexive NATRule, translated network address should be IPv4 address allocated from External Block associated with VPC. format: list-of-address-or-block-or-range

Parameters:

translatedNetwork - New value for the property.

setTranslatedPorts

public PolicyNatRule.Builder setTranslatedPorts(java.lang.String translatedPorts)

Please note, if there is service configured in this NAT rule, the translated_port will be realized on NSX Manager as the destination_port. If there is no sevice configured, the port will be ignored. format: port-or-range

Parameters:

translatedPorts - New value for the property.

build

public PolicyNatRule build()