ALBWafRule (Java SDK for NSX Global Policy API 4.1.0.2.0)

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

All Implemented Interfaces:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ALBWafRule.Builder
Builder class for ALBWafRule.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`MODE_DETECTION_ONLY`
`static java.lang.String`	`MODE_ENFORCEMENT`
`static java.lang.String`	`PHASE_CONNECTION`
`static java.lang.String`	`PHASE_LOGGING`
`static java.lang.String`	`PHASE_REQUEST_BODY`
`static java.lang.String`	`PHASE_REQUEST_HEADER`
`static java.lang.String`	`PHASE_RESPONSE_BODY`
`static java.lang.String`	`PHASE_RESPONSE_HEADER`

Constructor Summary

Constructors
Modifier Constructor and Description

ALBWafRule()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`ALBWafRule()` Default constructor.
`protected`	`ALBWafRule(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 ALBWafRule`	`_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 ALBWafRule`	`_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.util.List<java.lang.String>`	`getAviTags()` Tags for WAF rule as per Modsec language.
`java.lang.Boolean`	`getEnable()` Enable or disable WAF Rule Group.
`java.util.List<ALBWafExcludeListEntry>`	`getExcludeList()` Exclude list for the WAF rule.
`java.lang.Long`	`getIndex()` Number of index.
`java.lang.Boolean`	`getIsSensitive()` The rule field is sensitive and will not be displayed.
`java.lang.String`	`getMode()` Possible values are: `MODE_DETECTION_ONLY` `MODE_ENFORCEMENT` WAF Rule mode.
`java.lang.String`	`getName()` User-friendly optional name for a rule.
`java.lang.String`	`getPhase()` Possible values are: `PHASE_CONNECTION` `PHASE_REQUEST_HEADER` `PHASE_REQUEST_BODY` `PHASE_RESPONSE_HEADER` `PHASE_RESPONSE_BODY` `PHASE_LOGGING` The execution phase where this rule will be executed.
`java.lang.String`	`getRule()` Rule as per Modsec language.
`java.lang.String`	`getRuleId()` Identifier (id) for a rule per Modsec language.
`int`	`hashCode()`
`void`	`setAviTags(java.util.List<java.lang.String> aviTags)` Tags for WAF rule as per Modsec language.
`void`	`setEnable(java.lang.Boolean enable)` Enable or disable WAF Rule Group.
`void`	`setExcludeList(java.util.List<ALBWafExcludeListEntry> excludeList)` Exclude list for the WAF rule.
`void`	`setIndex(java.lang.Long index)` Number of index.
`void`	`setIsSensitive(java.lang.Boolean isSensitive)` The rule field is sensitive and will not be displayed.
`void`	`setMode(java.lang.String mode)` Possible values are: `MODE_DETECTION_ONLY` `MODE_ENFORCEMENT` WAF Rule mode.
`void`	`setName(java.lang.String name)` User-friendly optional name for a rule.
`void`	`setPhase(java.lang.String phase)` Possible values are: `PHASE_CONNECTION` `PHASE_REQUEST_HEADER` `PHASE_REQUEST_BODY` `PHASE_RESPONSE_HEADER` `PHASE_RESPONSE_BODY` `PHASE_LOGGING` The execution phase where this rule will be executed.
`void`	`setRule(java.lang.String rule)` Rule as per Modsec language.
`void`	`setRuleId(java.lang.String ruleId)` Identifier (id) for a rule per Modsec language.
`java.lang.String`	`toString()`

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

- Field Detail
  - 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
  - PHASE_CONNECTION
```
public static final java.lang.String PHASE_CONNECTION
```
    See Also:
    
    Constant Field Values
  - PHASE_REQUEST_HEADER
```
public static final java.lang.String PHASE_REQUEST_HEADER
```
    See Also:
    
    Constant Field Values
  - PHASE_REQUEST_BODY
```
public static final java.lang.String PHASE_REQUEST_BODY
```
    See Also:
    
    Constant Field Values
  - PHASE_RESPONSE_HEADER
```
public static final java.lang.String PHASE_RESPONSE_HEADER
```
    See Also:
    
    Constant Field Values
  - PHASE_RESPONSE_BODY
```
public static final java.lang.String PHASE_RESPONSE_BODY
```
    See Also:
    
    Constant Field Values
  - PHASE_LOGGING
```
public static final java.lang.String PHASE_LOGGING
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - ALBWafRule
```
public ALBWafRule()
```
    Default constructor.
  - ALBWafRule
```
protected ALBWafRule(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAviTags
```
public java.util.List<java.lang.String> getAviTags()
```
    Tags for WAF rule as per Modsec language. They are extracted from the tag actions in a Modsec rule. This field is generated from the rule itself and cannot be set by the user. Maximum of 64 items allowed.
    
    Returns:
    
    The current value of the property.
  - setAviTags
```
public void setAviTags(java.util.List<java.lang.String> aviTags)
```
    Tags for WAF rule as per Modsec language. They are extracted from the tag actions in a Modsec rule. This field is generated from the rule itself and cannot be set by the user. Maximum of 64 items allowed.
    
    Parameters:
    
    aviTags - New value for the property.
  - getEnable
```
public java.lang.Boolean getEnable()
```
    Enable or disable WAF Rule Group. 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 WAF Rule Group. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Parameters:
    
    enable - New value for the property.
  - getExcludeList
```
public java.util.List<ALBWafExcludeListEntry> getExcludeList()
```
    Exclude list for the WAF rule. The fields in the exclude list entry are logically and'ed to deduce the exclusion criteria. If there are multiple excludelist entries, it will be 'logical or' of them. Maximum of 64 items allowed.
    
    Returns:
    
    The current value of the property.
  - setExcludeList
```
public void setExcludeList(java.util.List<ALBWafExcludeListEntry> excludeList)
```
    Exclude list for the WAF rule. The fields in the exclude list entry are logically and'ed to deduce the exclusion criteria. If there are multiple excludelist entries, it will be 'logical or' of them. Maximum of 64 items allowed.
    
    Parameters:
    
    excludeList - New value for the property.
  - getIndex
```
public java.lang.Long getIndex()
```
    Number of index. format: int64
    
    Returns:
    
    The current value of the property.
  - setIndex
```
public void setIndex(java.lang.Long index)
```
    Number of index. format: int64
    
    Parameters:
    
    index - New value for the property.
  - getIsSensitive
```
public java.lang.Boolean getIsSensitive()
```
    The rule field is sensitive and will not be displayed. Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Returns:
    
    The current value of the property.
  - setIsSensitive
```
public void setIsSensitive(java.lang.Boolean isSensitive)
```
    The rule field is sensitive and will not be displayed. Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Parameters:
    
    isSensitive - 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()
```
    User-friendly optional name for a rule.
    
    Returns:
    
    The current value of the property.
  - setName
```
public void setName(java.lang.String name)
```
    User-friendly optional name for a rule.
    
    Parameters:
    
    name - New value for the property.
  - getPhase
```
public java.lang.String getPhase()
```
    Possible values are:
    The execution phase where this rule will be executed. Enum options - WAF_PHASE_CONNECTION, WAF_PHASE_REQUEST_HEADER, WAF_PHASE_REQUEST_BODY, WAF_PHASE_RESPONSE_HEADER, WAF_PHASE_RESPONSE_BODY, WAF_PHASE_LOGGING.
    Returns:
    
    The current value of the property.
  - setPhase
```
public void setPhase(java.lang.String phase)
```
    Possible values are:
    The execution phase where this rule will be executed. Enum options - WAF_PHASE_CONNECTION, WAF_PHASE_REQUEST_HEADER, WAF_PHASE_REQUEST_BODY, WAF_PHASE_RESPONSE_HEADER, WAF_PHASE_RESPONSE_BODY, WAF_PHASE_LOGGING.
    Parameters:
    
    phase - New value for the property.
  - getRule
```
public java.lang.String getRule()
```
    Rule as per Modsec language.
    
    Returns:
    
    The current value of the property.
  - setRule
```
public void setRule(java.lang.String rule)
```
    Rule as per Modsec language.
    
    Parameters:
    
    rule - New value for the property.
  - getRuleId
```
public java.lang.String getRuleId()
```
    Identifier (id) for a rule per Modsec language. All SecRule and SecAction directives require an id. It is extracted from the id action in a Modsec rule. Rules within a single WAF Policy are required to have unique rule_ids.
    
    Returns:
    
    The current value of the property.
  - setRuleId
```
public void setRuleId(java.lang.String ruleId)
```
    Identifier (id) for a rule per Modsec language. All SecRule and SecAction directives require an id. It is extracted from the id action in a Modsec rule. Rules within a single WAF Policy are required to have unique rule_ids.
    
    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 ALBWafRule _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 ALBWafRule _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class ALBWafRule

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MODE_DETECTION_ONLY

MODE_ENFORCEMENT

PHASE_CONNECTION

PHASE_REQUEST_HEADER

PHASE_REQUEST_BODY

PHASE_RESPONSE_HEADER

PHASE_RESPONSE_BODY

PHASE_LOGGING

__dynamicStructureFields

Constructor Detail

ALBWafRule

ALBWafRule

Method Detail

getAviTags

setAviTags

getEnable

setEnable

getExcludeList

setExcludeList

getIndex

setIndex

getIsSensitive

setIsSensitive

getMode

setMode

getName

setName

getPhase

setPhase

getRule

setRule

getRuleId

setRuleId

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2