ALBWafPSMRule (Java SDK for NSX Global Policy API 4.1.0.2.0)

java.lang.Object
- com.vmware.nsx_global_policy.model.ALBWafPSMRule

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class ALBWafPSMRule
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Advanced load balancer WafPSMRule object

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ALBWafPSMRule.Builder
Builder class for ALBWafPSMRule.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ALBWafPSMRule.Builder` Builder class for `ALBWafPSMRule`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`MATCH_CASE_INSENSITIVE`
`static java.lang.String`	`MATCH_CASE_SENSITIVE`
`static java.lang.String`	`MODE_DETECTION_ONLY`
`static java.lang.String`	`MODE_ENFORCEMENT`
`static java.lang.String`	`PARANOIA_LEVEL_EXTREME`
`static java.lang.String`	`PARANOIA_LEVEL_HIGH`
`static java.lang.String`	`PARANOIA_LEVEL_LOW`
`static java.lang.String`	`PARANOIA_LEVEL_MEDIUM`

Constructor Summary

Constructors
Modifier Constructor and Description

ALBWafPSMRule()
Default constructor.

protected ALBWafPSMRule(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`ALBWafPSMRule()` Default constructor.
`protected`	`ALBWafPSMRule(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends com.vmware.vapi.bindings.Structure> T`	`_convertTo(java.lang.Class<T> clazz)`
`java.lang.String`	`_getCanonicalName()`
`static java.lang.String`	`_getCanonicalTypeName()` Returns the canonical type name.
`static com.vmware.vapi.bindings.type.StructType`	`_getClassType()` WARNING: Internal method, subject to change in future versions.
`com.vmware.vapi.data.StructValue`	`_getDataValue()`
`com.vmware.vapi.data.DataValue`	`_getDynamicField(java.lang.String fieldName)`
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()`
`com.vmware.vapi.bindings.type.StructType`	`_getType()`
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)`
`static ALBWafPSMRule`	`_newInstance(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
`static ALBWafPSMRule`	`_newInstance2(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)`
`protected void`	`_updateDataValue(com.vmware.vapi.data.StructValue structValue)`
`void`	`_validate()`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getDescription()` Free-text comment about this rule.
`java.lang.Boolean`	`getEnable()` Enable or disable this rule.
`java.lang.Long`	`getIndex()` Rule index, this is used to determine the order of the rules.
`java.lang.String`	`getMatchCase()` Possible values are: `MATCH_CASE_SENSITIVE` `MATCH_CASE_INSENSITIVE` The field match_value_pattern regular expression is case sensitive.
`java.util.List<ALBWafPSMMatchElement>`	`getMatchElements()` The match elements, for example ARGS id or ARGS\|!ARGS password.
`java.lang.Long`	`getMatchValueMaxLength()` The maximum allowed length of the match_value.
`java.lang.String`	`getMatchValuePattern()` A regular expression which describes the expected value.
`java.lang.String`	`getMode()` Possible values are: `MODE_DETECTION_ONLY` `MODE_ENFORCEMENT` WAF Rule mode.
`java.lang.String`	`getName()` Name of the rule.
`java.lang.String`	`getParanoiaLevel()` Possible values are: `PARANOIA_LEVEL_LOW` `PARANOIA_LEVEL_MEDIUM` `PARANOIA_LEVEL_HIGH` `PARANOIA_LEVEL_EXTREME` WAF Ruleset paranoia mode.
`java.lang.String`	`getRuleId()` Id field which is used for log and metric generation.
`int`	`hashCode()`
`void`	`setDescription(java.lang.String description)` Free-text comment about this rule.
`void`	`setEnable(java.lang.Boolean enable)` Enable or disable this rule.
`void`	`setIndex(java.lang.Long index)` Rule index, this is used to determine the order of the rules.
`void`	`setMatchCase(java.lang.String matchCase)` Possible values are: `MATCH_CASE_SENSITIVE` `MATCH_CASE_INSENSITIVE` The field match_value_pattern regular expression is case sensitive.
`void`	`setMatchElements(java.util.List<ALBWafPSMMatchElement> matchElements)` The match elements, for example ARGS id or ARGS\|!ARGS password.
`void`	`setMatchValueMaxLength(java.lang.Long matchValueMaxLength)` The maximum allowed length of the match_value.
`void`	`setMatchValuePattern(java.lang.String matchValuePattern)` A regular expression which describes the expected value.
`void`	`setMode(java.lang.String mode)` Possible values are: `MODE_DETECTION_ONLY` `MODE_ENFORCEMENT` WAF Rule mode.
`void`	`setName(java.lang.String name)` Name of the rule.
`void`	`setParanoiaLevel(java.lang.String paranoiaLevel)` Possible values are: `PARANOIA_LEVEL_LOW` `PARANOIA_LEVEL_MEDIUM` `PARANOIA_LEVEL_HIGH` `PARANOIA_LEVEL_EXTREME` WAF Ruleset paranoia mode.
`void`	`setRuleId(java.lang.String ruleId)` Id field which is used for log and metric generation.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MATCH_CASE_SENSITIVE
```
public static final java.lang.String MATCH_CASE_SENSITIVE
```
    See Also:
    
    Constant Field Values
  - MATCH_CASE_INSENSITIVE
```
public static final java.lang.String MATCH_CASE_INSENSITIVE
```
    See Also:
    
    Constant Field Values
  - MODE_DETECTION_ONLY
```
public static final java.lang.String MODE_DETECTION_ONLY
```
    See Also:
    
    Constant Field Values
  - MODE_ENFORCEMENT
```
public static final java.lang.String MODE_ENFORCEMENT
```
    See Also:
    
    Constant Field Values
  - PARANOIA_LEVEL_LOW
```
public static final java.lang.String PARANOIA_LEVEL_LOW
```
    See Also:
    
    Constant Field Values
  - PARANOIA_LEVEL_MEDIUM
```
public static final java.lang.String PARANOIA_LEVEL_MEDIUM
```
    See Also:
    
    Constant Field Values
  - PARANOIA_LEVEL_HIGH
```
public static final java.lang.String PARANOIA_LEVEL_HIGH
```
    See Also:
    
    Constant Field Values
  - PARANOIA_LEVEL_EXTREME
```
public static final java.lang.String PARANOIA_LEVEL_EXTREME
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - ALBWafPSMRule
```
public ALBWafPSMRule()
```
    Default constructor.
  - ALBWafPSMRule
```
protected ALBWafPSMRule(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getDescription
```
public java.lang.String getDescription()
```
    Free-text comment about this rule.
    
    Returns:
    
    The current value of the property.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Free-text comment about this rule.
    
    Parameters:
    
    description - New value for the property.
  - getEnable
```
public java.lang.Boolean getEnable()
```
    Enable or disable this rule. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Returns:
    
    The current value of the property.
  - setEnable
```
public void setEnable(java.lang.Boolean enable)
```
    Enable or disable this rule. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Parameters:
    
    enable - New value for the property.
  - getIndex
```
public java.lang.Long getIndex()
```
    Rule index, this is used to determine the order of the rules. format: int64
    
    Returns:
    
    The current value of the property.
  - setIndex
```
public void setIndex(java.lang.Long index)
```
    Rule index, this is used to determine the order of the rules. format: int64
    
    Parameters:
    
    index - New value for the property.
  - getMatchCase
```
public java.lang.String getMatchCase()
```
    Possible values are:
    - MATCH_CASE_SENSITIVE
    - MATCH_CASE_INSENSITIVE
    The field match_value_pattern regular expression is case sensitive. Enum options - SENSITIVE, INSENSITIVE. Default value when not specified in API or module is interpreted by ALB Controller as INSENSITIVE.
    Returns:
    
    The current value of the property.
  - setMatchCase
```
public void setMatchCase(java.lang.String matchCase)
```
    Possible values are:
    - MATCH_CASE_SENSITIVE
    - MATCH_CASE_INSENSITIVE
    The field match_value_pattern regular expression is case sensitive. Enum options - SENSITIVE, INSENSITIVE. Default value when not specified in API or module is interpreted by ALB Controller as INSENSITIVE.
    Parameters:
    
    matchCase - New value for the property.
  - getMatchElements
```
public java.util.List<ALBWafPSMMatchElement> getMatchElements()
```
    The match elements, for example ARGS id or ARGS|!ARGS password. Maximum of 64 items allowed.
    
    Returns:
    
    The current value of the property.
  - setMatchElements
```
public void setMatchElements(java.util.List<ALBWafPSMMatchElement> matchElements)
```
    The match elements, for example ARGS id or ARGS|!ARGS password. Maximum of 64 items allowed.
    
    Parameters:
    
    matchElements - New value for the property.
  - getMatchValueMaxLength
```
public java.lang.Long getMatchValueMaxLength()
```
    The maximum allowed length of the match_value. If this is not set, the length will not be checked. format: int64
    
    Returns:
    
    The current value of the property.
  - setMatchValueMaxLength
```
public void setMatchValueMaxLength(java.lang.Long matchValueMaxLength)
```
    The maximum allowed length of the match_value. If this is not set, the length will not be checked. format: int64
    
    Parameters:
    
    matchValueMaxLength - New value for the property.
  - getMatchValuePattern
```
public java.lang.String getMatchValuePattern()
```
    A regular expression which describes the expected value.
    
    Returns:
    
    The current value of the property.
  - setMatchValuePattern
```
public void setMatchValuePattern(java.lang.String matchValuePattern)
```
    A regular expression which describes the expected value.
    
    Parameters:
    
    matchValuePattern - New value for the property.
  - getMode
```
public java.lang.String getMode()
```
    Possible values are:
    - MODE_DETECTION_ONLY
    - MODE_ENFORCEMENT
    WAF Rule mode. This can be detection or enforcement. If this is not set, the Policy mode is used. This only takes effect if the policy allows delegation. Enum options - WAF_MODE_DETECTION_ONLY, WAF_MODE_ENFORCEMENT.
    Returns:
    
    The current value of the property.
  - setMode
```
public void setMode(java.lang.String mode)
```
    Possible values are:
    - MODE_DETECTION_ONLY
    - MODE_ENFORCEMENT
    WAF Rule mode. This can be detection or enforcement. If this is not set, the Policy mode is used. This only takes effect if the policy allows delegation. Enum options - WAF_MODE_DETECTION_ONLY, WAF_MODE_ENFORCEMENT.
    Parameters:
    
    mode - New value for the property.
  - getName
```
public java.lang.String getName()
```
    Name of the rule.
    
    Returns:
    
    The current value of the property.
  - setName
```
public void setName(java.lang.String name)
```
    Name of the rule.
    
    Parameters:
    
    name - New value for the property.
  - getParanoiaLevel
```
public java.lang.String getParanoiaLevel()
```
    Possible values are:
    WAF Ruleset paranoia mode. This is used to select Rules based on the paranoia-level. 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.
    Returns:
    
    The current value of the property.
  - setParanoiaLevel
```
public void setParanoiaLevel(java.lang.String paranoiaLevel)
```
    Possible values are:
    WAF Ruleset paranoia mode. This is used to select Rules based on the paranoia-level. 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.
  - getRuleId
```
public java.lang.String getRuleId()
```
    Id field which is used for log and metric generation. This id must be unique for all rules in this group.
    
    Returns:
    
    The current value of the property.
  - setRuleId
```
public void setRuleId(java.lang.String ruleId)
```
    Id field which is used for log and metric generation. This id must be unique for all rules in this group.
    
    Parameters:
    
    ruleId - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Specified by:
    
    _getType in interface com.vmware.vapi.bindings.StaticStructure
  - _getDataValue
```
public com.vmware.vapi.data.StructValue _getDataValue()
```
    Specified by:
    
    _getDataValue in interface com.vmware.vapi.bindings.Structure
  - _updateDataValue
```
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Specified by:
    
    _validate in interface com.vmware.vapi.bindings.StaticStructure
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
```
    Specified by:
    
    _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
  - _convertTo
```
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
```
    Specified by:
    
    _convertTo in interface com.vmware.vapi.bindings.Structure
  - _setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
```
    Specified by:
    
    _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicField
```
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
```
    Specified by:
    
    _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
    Specified by:
    
    _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
  - _getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
    WARNING: Internal method, subject to change in future versions.
    
    Returns:
    
    StructType instance representing the static bindings type for this Structure.
  - _getCanonicalName
```
public java.lang.String _getCanonicalName()
```
    Specified by:
    
    _getCanonicalName in interface com.vmware.vapi.bindings.Structure
  - _getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
    Returns the canonical type name. See _getCanonicalName().
    
    Returns:
    
    canonical type name
  - _newInstance
```
public static ALBWafPSMRule _newInstance(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Returns new instance of this binding class and injects the provided data value.
    WARNING: The returned object is not fully initialized.
    
    Parameters:
    
    structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.
    
    Returns:
    
    the static bindings StructType
  - _newInstance2
```
public static ALBWafPSMRule _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class ALBWafPSMRule

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MATCH_CASE_SENSITIVE

MATCH_CASE_INSENSITIVE

MODE_DETECTION_ONLY

MODE_ENFORCEMENT

PARANOIA_LEVEL_LOW

PARANOIA_LEVEL_MEDIUM

PARANOIA_LEVEL_HIGH

PARANOIA_LEVEL_EXTREME

__dynamicStructureFields

Constructor Detail

ALBWafPSMRule

ALBWafPSMRule

Method Detail

getDescription

setDescription

getEnable

setEnable

getIndex

setIndex

getMatchCase

setMatchCase

getMatchElements

setMatchElements

getMatchValueMaxLength

setMatchValueMaxLength

getMatchValuePattern

setMatchValuePattern

getMode

setMode

getName

setName

getParanoiaLevel

setParanoiaLevel

getRuleId

setRuleId

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2