com.vmware.nsx.model

Class FirewallRule.Builder

java.lang.Object

com.vmware.nsx.model.FirewallRule.Builder

Enclosing class:

FirewallRule

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

Builder class for FirewallRule.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
FirewallRule	build()
FirewallRule.Builder	setAction(java.lang.String action) Possible values are: FirewallRule.ACTION_ALLOW FirewallRule.ACTION_DROP FirewallRule.ACTION_REJECT FirewallRule.ACTION_REDIRECT FirewallRule.ACTION_DO_NOT_REDIRECT FirewallRule.ACTION_DETECT FirewallRule.ACTION_ALLOW_CONTINUE FirewallRule.ACTION_DETECT_PREVENT Action enforced on the packets which matches the distributed service rule.
FirewallRule.Builder	setAppliedTos(java.util.List<ResourceReference> appliedTos) List of object where rule will be enforced.
FirewallRule.Builder	setContextProfiles(java.util.List<ResourceReference> contextProfiles) NS Profile object which accepts attributes and sub-attributes of various network services (ex.
FirewallRule.Builder	setDescription(java.lang.String description) Description of this resource
FirewallRule.Builder	setDestinations(java.util.List<ResourceReference> destinations) List of the destinations.
FirewallRule.Builder	setDestinationsExcluded(java.lang.Boolean destinationsExcluded) Negation of the destination.
FirewallRule.Builder	setDirection(java.lang.String direction) Possible values are: FirewallRule.DIRECTION_IN FirewallRule.DIRECTION_OUT FirewallRule.DIRECTION_IN_OUT Rule direction in case of stateless distributed service rules.
FirewallRule.Builder	setDisabled(java.lang.Boolean disabled) Flag to disable rule.
FirewallRule.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
FirewallRule.Builder	setExtendedSources(java.util.List<ResourceReference> extendedSources) List of NSGroups that have end point attributes like AD Groups(SID), process name, process hash etc.
FirewallRule.Builder	setId(java.lang.String id) Identifier of the 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.
FirewallRule.Builder	setIpProtocol(java.lang.String ipProtocol) Possible values are: FirewallRule.IP_PROTOCOL_IPV4 FirewallRule.IP_PROTOCOL_IPV6 FirewallRule.IP_PROTOCOL_IPV4_IPV6 Type of IP packet that should be matched while enforcing the rule.
FirewallRule.Builder	setIsDefault(java.lang.Boolean isDefault) Flag to indicate whether rule is default.
FirewallRule.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
FirewallRule.Builder	setLogged(java.lang.Boolean logged) Flag to enable packet logging.
FirewallRule.Builder	setNotes(java.lang.String notes) User notes specific to the rule.
FirewallRule.Builder	setOwner(OwnerResourceLink owner)
FirewallRule.Builder	setPriority(java.lang.Long priority) Priority of the rule.
FirewallRule.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
FirewallRule.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
FirewallRule.Builder	setRuleTag(java.lang.String ruleTag) User level field which will be printed in CLI and packet logs.
FirewallRule.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.
FirewallRule.Builder	setSectionId(java.lang.String sectionId) Section Id of the section to which this rule belongs to.
FirewallRule.Builder	setSelf(SelfResourceLink self)
FirewallRule.Builder	setServices(java.util.List<FirewallService> services) List of the services.
FirewallRule.Builder	setSources(java.util.List<ResourceReference> sources) List of sources.
FirewallRule.Builder	setSourcesExcluded(java.lang.Boolean sourcesExcluded) Negation of the source.

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

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

setOwner

public FirewallRule.Builder setOwner(OwnerResourceLink owner)

Parameters:

owner - New value for the property.

setDescription

public FirewallRule.Builder setDescription(java.lang.String description)

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Identifier of the 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:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setAction

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

Possible values are:

• FirewallRule.ACTION_ALLOW
• FirewallRule.ACTION_DROP
• FirewallRule.ACTION_REJECT
• FirewallRule.ACTION_REDIRECT
• FirewallRule.ACTION_DO_NOT_REDIRECT
• FirewallRule.ACTION_DETECT
• FirewallRule.ACTION_ALLOW_CONTINUE
• FirewallRule.ACTION_DETECT_PREVENT

Action enforced on the packets which matches the distributed service rule. Currently DS Layer supports below actions. ALLOW - Forward any packet when a rule with this action gets a match (Used by Firewall). DROP - Drop any packet when a rule with this action gets a match. Packets won't go further(Used by Firewall). REJECT - Terminate TCP connection by sending TCP reset for a packet when a rule with this action gets a match (Used by Firewall). REDIRECT - Redirect any packet to a partner appliance when a rule with this action gets a match (Used by Service Insertion). DO_NOT_REDIRECT - Do not redirect any packet to a partner appliance when a rule with this action gets a match (Used by Service Insertion). DETECT - Detect IDS Signatures. ALLOW_CONTINUE - Allows rules to jump from this rule. Action on matching rules in the destination category will decide next step. Application is default destination until new categories are supported to jump to. DETECT_PREVENT - Detect and Prevent IDS Signatures.

Parameters:

action - New value for the property.

setAppliedTos

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

List of object where rule will be enforced. The section level field overrides this one. Null will be treated as any.

Parameters:

appliedTos - New value for the property.

setDestinations

public FirewallRule.Builder setDestinations(java.util.List<ResourceReference> destinations)

List of the destinations. Null will be treated as any.

Parameters:

destinations - New value for the property.

setDestinationsExcluded

public FirewallRule.Builder setDestinationsExcluded(java.lang.Boolean destinationsExcluded)

Negation of the destination.

Parameters:

destinationsExcluded - New value for the property.

setDirection

public FirewallRule.Builder setDirection(java.lang.String direction)

Possible values are:

• FirewallRule.DIRECTION_IN
• FirewallRule.DIRECTION_OUT
• FirewallRule.DIRECTION_IN_OUT

Rule direction in case of stateless distributed service rules. This will only considered if section level parameter is set to stateless. Default to IN_OUT if not specified.

Parameters:

direction - New value for the property.

setDisabled

public FirewallRule.Builder setDisabled(java.lang.Boolean disabled)

Flag to disable rule. Disabled will only be persisted but never provisioned/realized.

Parameters:

disabled - New value for the property.

setIpProtocol

public FirewallRule.Builder setIpProtocol(java.lang.String ipProtocol)

Possible values are:

• FirewallRule.IP_PROTOCOL_IPV4
• FirewallRule.IP_PROTOCOL_IPV6
• FirewallRule.IP_PROTOCOL_IPV4_IPV6

Type of IP packet that should be matched while enforcing the rule.

Parameters:

ipProtocol - New value for the property.

setIsDefault

public FirewallRule.Builder setIsDefault(java.lang.Boolean isDefault)

Flag to indicate whether rule is default. 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:

isDefault - New value for the property.

setLogged

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

Flag to enable packet logging. Default is disabled.

Parameters:

logged - New value for the property.

setNotes

public FirewallRule.Builder setNotes(java.lang.String notes)

User notes specific to the rule.

Parameters:

notes - New value for the property.

setPriority

public FirewallRule.Builder setPriority(java.lang.Long priority)

Priority of the rule. 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:

priority - New value for the property.

setRuleTag

public FirewallRule.Builder setRuleTag(java.lang.String ruleTag)

User level field which will be printed in CLI and packet logs.

Parameters:

ruleTag - New value for the property.

setSources

public FirewallRule.Builder setSources(java.util.List<ResourceReference> sources)

List of sources. Null will be treated as any.

Parameters:

sources - New value for the property.

setSourcesExcluded

public FirewallRule.Builder setSourcesExcluded(java.lang.Boolean sourcesExcluded)

Negation of the source.

Parameters:

sourcesExcluded - New value for the property.

setContextProfiles

public FirewallRule.Builder setContextProfiles(java.util.List<ResourceReference> contextProfiles)

NS Profile object which accepts attributes and sub-attributes of various network services (ex. L7 AppId, domain name, encryption algorithm) as key value pairs.

Parameters:

contextProfiles - New value for the property.

setExtendedSources

public FirewallRule.Builder setExtendedSources(java.util.List<ResourceReference> extendedSources)

List of NSGroups that have end point attributes like AD Groups(SID), process name, process hash etc. For Flash release, only NSGroups containing AD Groups are supported.

Parameters:

extendedSources - New value for the property.

setSectionId

public FirewallRule.Builder setSectionId(java.lang.String sectionId)

Section Id of the section to which this rule belongs to. 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:

sectionId - New value for the property.

setServices

public FirewallRule.Builder setServices(java.util.List<FirewallService> services)

List of the services. Null will be treated as any.

Parameters:

services - New value for the property.

build

public FirewallRule build()