com.vmware.nsx_global_policy.model

Class ALBWafPolicy.Builder

java.lang.Object

com.vmware.nsx_global_policy.model.ALBWafPolicy.Builder

Enclosing class:

ALBWafPolicy

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

Builder class for ALBWafPolicy.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ALBWafPolicy	build()
ALBWafPolicy.Builder	setAllowModeDelegation(java.lang.Boolean allowModeDelegation) Allow Rules to overwrite the policy mode.
ALBWafPolicy.Builder	setApplicationSignatures(ALBWafApplicationSignatures applicationSignatures)
ALBWafPolicy.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
ALBWafPolicy.Builder	setConfidenceOverride(ALBAppLearningConfidenceOverride confidenceOverride)
ALBWafPolicy.Builder	setCreatedBy(java.lang.String createdBy) Creator name.
ALBWafPolicy.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.
ALBWafPolicy.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.
ALBWafPolicy.Builder	setCrsOverrides(java.util.List<ALBWafRuleGroupOverrides> crsOverrides) Override attributes for CRS rules.
ALBWafPolicy.Builder	setDescription(java.lang.String description) Description of this resource
ALBWafPolicy.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
ALBWafPolicy.Builder	setEnableAppLearning(java.lang.Boolean enableAppLearning) Enable Application Learning for this WAF policy.
ALBWafPolicy.Builder	setEnableAutoRuleUpdates(java.lang.Boolean enableAutoRuleUpdates) Enable Application Learning based rule updates on the WAF Profile.
ALBWafPolicy.Builder	setFailureMode(java.lang.String failureMode) Possible values are: ALBWafPolicy.FAILURE_MODE_OPEN ALBWafPolicy.FAILURE_MODE_CLOSED WAF Policy failure mode.
ALBWafPolicy.Builder	setId(java.lang.String id) Unique identifier of this resource
ALBWafPolicy.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.
ALBWafPolicy.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.
ALBWafPolicy.Builder	setLearningParams(ALBAppLearningParams learningParams)
ALBWafPolicy.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
ALBWafPolicy.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
ALBWafPolicy.Builder	setMarkers(java.util.List<ALBRoleFilterMatchLabel> markers) List of labels to be used for granular RBAC.
ALBWafPolicy.Builder	setMinConfidence(java.lang.String minConfidence) Possible values are: ALBWafPolicy.MIN_CONFIDENCE_VERY_HIGH ALBWafPolicy.MIN_CONFIDENCE_HIGH ALBWafPolicy.MIN_CONFIDENCE_PROBABLE ALBWafPolicy.MIN_CONFIDENCE_LOW ALBWafPolicy.MIN_CONFIDENCE_NONE Minimum confidence label required for auto rule updates.
ALBWafPolicy.Builder	setMode(java.lang.String mode) Possible values are: ALBWafPolicy.MODE_DETECTION_ONLY ALBWafPolicy.MODE_ENFORCEMENT WAF Policy mode.
ALBWafPolicy.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
ALBWafPolicy.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
ALBWafPolicy.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing whoes owns this object.
ALBWafPolicy.Builder	setParanoiaLevel(java.lang.String paranoiaLevel) Possible values are: ALBWafPolicy.PARANOIA_LEVEL_LOW ALBWafPolicy.PARANOIA_LEVEL_MEDIUM ALBWafPolicy.PARANOIA_LEVEL_HIGH ALBWafPolicy.PARANOIA_LEVEL_EXTREME WAF Ruleset paranoia mode.
ALBWafPolicy.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.
ALBWafPolicy.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.
ALBWafPolicy.Builder	setPositiveSecurityModel(ALBWafPositiveSecurityModel positiveSecurityModel)
ALBWafPolicy.Builder	setPostCrsGroups(java.util.List<ALBWafRuleGroup> postCrsGroups) WAF Rules are categorized in to groups based on their characterization.
ALBWafPolicy.Builder	setPreCrsGroups(java.util.List<ALBWafRuleGroup> preCrsGroups) WAF Rules are categorized in to groups based on their characterization.
ALBWafPolicy.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.
ALBWafPolicy.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
ALBWafPolicy.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.
ALBWafPolicy.Builder	setRemotePath(java.lang.String remotePath) This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.
ALBWafPolicy.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
ALBWafPolicy.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
ALBWafPolicy.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.
ALBWafPolicy.Builder	setSelf(SelfResourceLink self)
ALBWafPolicy.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.
ALBWafPolicy.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
ALBWafPolicy.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment.
ALBWafPolicy.Builder	setWafCrsPath(java.lang.String wafCrsPath) WAF core ruleset used for the CRS part of this Policy.
ALBWafPolicy.Builder	setWafProfilePath(java.lang.String wafProfilePath) WAF Profile for WAF policy.

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

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

public ALBWafPolicy.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 Pmaas 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 ALBWafPolicy.Builder setOwnerId(java.lang.String ownerId)

This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas 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 ALBWafPolicy.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 ALBWafPolicy.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 ALBWafPolicy.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 thier 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 ALBWafPolicy.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 ALBWafPolicy.Builder setRemotePath(java.lang.String remotePath)

This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS 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 ALBWafPolicy.Builder setUniqueId(java.lang.String uniqueId)

This is a UUID generated by the GM/LM to uniquely identify entites 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 ALBWafPolicy.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 ALBWafPolicy.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 ALBWafPolicy.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.

setAllowModeDelegation

public ALBWafPolicy.Builder setAllowModeDelegation(java.lang.Boolean allowModeDelegation)

Allow Rules to overwrite the policy mode. This must be set if the policy mode is set to enforcement. Default value when not specified in API or module is interpreted by ALB Controller as true.

Parameters:

allowModeDelegation - New value for the property.

setApplicationSignatures

public ALBWafPolicy.Builder setApplicationSignatures(ALBWafApplicationSignatures applicationSignatures)

Parameters:

applicationSignatures - New value for the property.

setConfidenceOverride

public ALBWafPolicy.Builder setConfidenceOverride(ALBAppLearningConfidenceOverride confidenceOverride)

Parameters:

confidenceOverride - New value for the property.

setCreatedBy

public ALBWafPolicy.Builder setCreatedBy(java.lang.String createdBy)

Creator name.

Parameters:

createdBy - New value for the property.

setCrsOverrides

public ALBWafPolicy.Builder setCrsOverrides(java.util.List<ALBWafRuleGroupOverrides> crsOverrides)

Override attributes for CRS rules.

Parameters:

crsOverrides - New value for the property.

setEnableAppLearning

public ALBWafPolicy.Builder setEnableAppLearning(java.lang.Boolean enableAppLearning)

Enable Application Learning for this WAF policy. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

enableAppLearning - New value for the property.

setEnableAutoRuleUpdates

public ALBWafPolicy.Builder setEnableAutoRuleUpdates(java.lang.Boolean enableAutoRuleUpdates)

Enable Application Learning based rule updates on the WAF Profile. Rules will be programmed in dedicated WAF learning group. Default value when not specified in API or module is interpreted by ALB Controller as true.

Parameters:

enableAutoRuleUpdates - New value for the property.

setFailureMode

public ALBWafPolicy.Builder setFailureMode(java.lang.String failureMode)

Possible values are:

• ALBWafPolicy.FAILURE_MODE_OPEN
• ALBWafPolicy.FAILURE_MODE_CLOSED

WAF Policy failure mode. This can be 'Open' or 'Closed'. Enum options - WAF_FAILURE_MODE_OPEN, WAF_FAILURE_MODE_CLOSED. Default value when not specified in API or module is interpreted by ALB Controller as WAF_FAILURE_MODE_OPEN.

Parameters:

failureMode - New value for the property.

setLearningParams

public ALBWafPolicy.Builder setLearningParams(ALBAppLearningParams learningParams)

Parameters:

learningParams - New value for the property.

setMarkers

public ALBWafPolicy.Builder setMarkers(java.util.List<ALBRoleFilterMatchLabel> markers)

List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.

Parameters:

markers - New value for the property.

setMinConfidence

public ALBWafPolicy.Builder setMinConfidence(java.lang.String minConfidence)

Possible values are:

• ALBWafPolicy.MIN_CONFIDENCE_VERY_HIGH
• ALBWafPolicy.MIN_CONFIDENCE_HIGH
• ALBWafPolicy.MIN_CONFIDENCE_PROBABLE
• ALBWafPolicy.MIN_CONFIDENCE_LOW
• ALBWafPolicy.MIN_CONFIDENCE_NONE

Minimum confidence label required for auto rule updates. Enum options - CONFIDENCE_VERY_HIGH, CONFIDENCE_HIGH, CONFIDENCE_PROBABLE, CONFIDENCE_LOW, CONFIDENCE_NONE. Default value when not specified in API or module is interpreted by ALB Controller as CONFIDENCE_VERY_HIGH.

Parameters:

minConfidence - New value for the property.

setMode

public ALBWafPolicy.Builder setMode(java.lang.String mode)

Possible values are:

• ALBWafPolicy.MODE_DETECTION_ONLY
• ALBWafPolicy.MODE_ENFORCEMENT

WAF Policy mode. This can be detection or enforcement. It can be overwritten by rules if allow_mode_delegation is set. Enum options - WAF_MODE_DETECTION_ONLY, WAF_MODE_ENFORCEMENT. Default value when not specified in API or module is interpreted by ALB Controller as WAF_MODE_DETECTION_ONLY.

Parameters:

mode - New value for the property.

setParanoiaLevel

public ALBWafPolicy.Builder setParanoiaLevel(java.lang.String paranoiaLevel)

Possible values are:

• ALBWafPolicy.PARANOIA_LEVEL_LOW
• ALBWafPolicy.PARANOIA_LEVEL_MEDIUM
• ALBWafPolicy.PARANOIA_LEVEL_HIGH
• ALBWafPolicy.PARANOIA_LEVEL_EXTREME

WAF Ruleset paranoia mode. This is used to select Rules based on the paranoia-level tag. Enum options - WAF_PARANOIA_LEVEL_LOW, WAF_PARANOIA_LEVEL_MEDIUM, WAF_PARANOIA_LEVEL_HIGH, WAF_PARANOIA_LEVEL_EXTREME. Default value when not specified in API or module is interpreted by ALB Controller as WAF_PARANOIA_LEVEL_LOW.

Parameters:

paranoiaLevel - New value for the property.

setPositiveSecurityModel

public ALBWafPolicy.Builder setPositiveSecurityModel(ALBWafPositiveSecurityModel positiveSecurityModel)

Parameters:

positiveSecurityModel - New value for the property.

setPostCrsGroups

public ALBWafPolicy.Builder setPostCrsGroups(java.util.List<ALBWafRuleGroup> postCrsGroups)

WAF Rules are categorized in to groups based on their characterization. These groups are created by the user and will be enforced after the CRS groups.

Parameters:

postCrsGroups - New value for the property.

setPreCrsGroups

public ALBWafPolicy.Builder setPreCrsGroups(java.util.List<ALBWafRuleGroup> preCrsGroups)

WAF Rules are categorized in to groups based on their characterization. These groups are created by the user and will be enforced before the CRS groups.

Parameters:

preCrsGroups - New value for the property.

setWafCrsPath

public ALBWafPolicy.Builder setWafCrsPath(java.lang.String wafCrsPath)

WAF core ruleset used for the CRS part of this Policy. It is a reference to an object of type WafCRS.

Parameters:

wafCrsPath - New value for the property.

setWafProfilePath

public ALBWafPolicy.Builder setWafProfilePath(java.lang.String wafProfilePath)

WAF Profile for WAF policy. It is a reference to an object of type WafProfile.

Parameters:

wafProfilePath - New value for the property.

build

public ALBWafPolicy build()