com.vmware.nsx.model

Class NatRule.Builder

java.lang.Object

com.vmware.nsx.model.NatRule.Builder

Enclosing class:

NatRule

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

Builder class for NatRule.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
NatRule	build()
NatRule.Builder	setAction(java.lang.String action) Possible values are: NatRule.ACTION_SNAT NatRule.ACTION_DNAT NatRule.ACTION_REFLEXIVE NatRule.ACTION_NO_SNAT NatRule.ACTION_NO_DNAT NatRule.ACTION_NAT64 Valid actions: SNAT, DNAT, NO_SNAT, NO_DNAT, REFLEXIVE, NAT64.
NatRule.Builder	setAppliedTos(java.util.List<ResourceReference> appliedTos) Holds the list of LogicalRouterPort Ids that a NAT rule can be applied to.
NatRule.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.
NatRule.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.
NatRule.Builder	setDescription(java.lang.String description) Description of this resource
NatRule.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
NatRule.Builder	setEnabled(java.lang.Boolean enabled) Indicator to enable/disable the rule.
NatRule.Builder	setFirewallMatch(java.lang.String firewallMatch) Possible values are: NatRule.FIREWALL_MATCH_MATCH_EXTERNAL_ADDRESS NatRule.FIREWALL_MATCH_MATCH_INTERNAL_ADDRESS NatRule.FIREWALL_MATCH_BYPASS Indicate how firewall is applied to a traffic packet.
NatRule.Builder	setId(java.lang.String id) Unique identifier of this resource
NatRule.Builder	setInternalRuleId(java.lang.String internalRuleId) Internal NAT rule uuid for debug used in Controller and backend.
NatRule.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.
NatRule.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.
NatRule.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
NatRule.Builder	setLogging(java.lang.Boolean logging) Enable/disable the logging of rule.
NatRule.Builder	setLogicalRouterId(java.lang.String logicalRouterId) The logical router id which the nat rule runs on.
NatRule.Builder	setMatchDestinationNetwork(java.lang.String matchDestinationNetwork) IP Address | CIDR | (null implies Any)
NatRule.Builder	setMatchService(com.vmware.vapi.bindings.Structure matchService)
NatRule.Builder	setMatchSourceNetwork(java.lang.String matchSourceNetwork) IP Address | CIDR | (null implies Any)
NatRule.Builder	setPbVpnMode(java.lang.String pbVpnMode) Possible values are: NatRule.PB_VPN_MODE_BYPASS NatRule.PB_VPN_MODE_EXCLUSIVE Indicate how the rule applies to Policy-Based VPN traffic.
NatRule.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.
NatRule.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
NatRule.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
NatRule.Builder	setRulePriority(java.lang.Long rulePriority) Ascending, valid range [0-2147483647].
NatRule.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.
NatRule.Builder	setSelf(SelfResourceLink self)
NatRule.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.
NatRule.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
NatRule.Builder	setTranslatedNetwork(java.lang.String translatedNetwork) The translated address for the matched IP packet.
NatRule.Builder	setTranslatedPorts(java.lang.String translatedPorts) The translated port(s) for the mtached IP packet.

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

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setAction

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

Possible values are:

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

Valid actions: SNAT, DNAT, NO_SNAT, NO_DNAT, REFLEXIVE, NAT64. All rules in a logical router are either stateless or stateful. Mix is not supported. SNAT and DNAT are stateful, can NOT be supported when the logical router is running at active-active HA mode; REFLEXIVE is stateless. NO_SNAT and NO_DNAT have no translated_fields, only match fields are supported.

Parameters:

action - New value for the property.

setAppliedTos

public NatRule.Builder setAppliedTos(java.util.List<ResourceReference> appliedTos)

Holds the list of LogicalRouterPort Ids that a NAT rule can be applied to. The LogicalRouterPort used must belong to the same LogicalRouter for which the NAT Rule is created. As of now a NAT rule can only have a single LogicalRouterPort as applied_tos. When applied_tos is not set, the NAT rule is applied to all LogicalRouterPorts beloging to the LogicalRouter.

Parameters:

appliedTos - New value for the property.

setEnabled

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

Indicator to enable/disable the rule.

Parameters:

enabled - New value for the property.

setFirewallMatch

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

Possible values are:

• NatRule.FIREWALL_MATCH_MATCH_EXTERNAL_ADDRESS
• NatRule.FIREWALL_MATCH_MATCH_INTERNAL_ADDRESS
• NatRule.FIREWALL_MATCH_BYPASS

Indicate how firewall is applied to a traffic packet. Firewall can be bypassed, or be applied to external/internal address of NAT rule.

Parameters:

firewallMatch - New value for the property.

setInternalRuleId

public NatRule.Builder setInternalRuleId(java.lang.String internalRuleId)

Internal NAT rule uuid for debug used in Controller and backend. 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:

internalRuleId - New value for the property.

setLogging

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

Enable/disable the logging of rule.

Parameters:

logging - New value for the property.

setLogicalRouterId

public NatRule.Builder setLogicalRouterId(java.lang.String logicalRouterId)

The logical router id which the nat rule runs on. 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:

logicalRouterId - New value for the property.

setMatchDestinationNetwork

public NatRule.Builder setMatchDestinationNetwork(java.lang.String matchDestinationNetwork)

IP Address | CIDR | (null implies Any)

Parameters:

matchDestinationNetwork - New value for the property.

setMatchService

public NatRule.Builder setMatchService(com.vmware.vapi.bindings.Structure matchService)

Parameters:

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

setMatchSourceNetwork

public NatRule.Builder setMatchSourceNetwork(java.lang.String matchSourceNetwork)

IP Address | CIDR | (null implies Any)

Parameters:

matchSourceNetwork - New value for the property.

setPbVpnMode

public NatRule.Builder setPbVpnMode(java.lang.String pbVpnMode)

Possible values are:

• NatRule.PB_VPN_MODE_BYPASS
• NatRule.PB_VPN_MODE_EXCLUSIVE

Indicate how the rule applies to Policy-Based VPN traffic. It's supported only for NAT rule action type DNAT and NO_DNAT. BYPASS indicates that NAT rule is applied to the traffic received on Routed-Based VPN tunnel. EXCLUSIVE indicates that NAT rule is applied to the inbound traffic received on Policy-Based VPN tunnel only.

Parameters:

pbVpnMode - New value for the property.

setRulePriority

public NatRule.Builder setRulePriority(java.lang.Long rulePriority)

Ascending, valid range [0-2147483647]. If multiple rules have the same priority, evaluation sequence is undefined. format: int64

Parameters:

rulePriority - New value for the property.

setTranslatedNetwork

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

The translated address for the matched IP packet. For a SNAT, it can be a single ip address, an ip range, or a CIDR block. For a DNAT and a REFLEXIVE, it can be a single ip address or a CIDR block. Translated network is not supported for NO_SNAT or NO_DNAT.

Parameters:

translatedNetwork - New value for the property.

setTranslatedPorts

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

The translated port(s) for the mtached IP packet. It can be a single port or a port range. Please note, port translating is supported only for DNAT.

Parameters:

translatedPorts - New value for the property.

build

public NatRule build()