LBHttpRequestUriCondition (NSX Policy API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx_policy.model.LBHttpRequestUriCondition

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class LBHttpRequestUriCondition
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
This condition is used to match URIs(Uniform Resource Identifier) of HTTP request messages. The URI field can be specified as a regular expression. If an HTTP request message is requesting an URI which matches specified regular expression, it matches the condition. The syntax of whole URI looks like this: scheme:[//[user[:password]@]host[:port]][/path][?query][#fragment] This condition matches only the path part of entire URI. When match_type field is specified as REGEX, the uri field is used as a regular expression to match URI path of HTTP requests. For example, to match any URI that has \"/image/\" or \"/images/\", uri field can be specified as: \"/image[s]?/\". Named capturing groups can be used in the uri field to capture substrings of matched URIs and store them in variables for use in LBRuleAction. For example, specify uri field as: \"/news/(?<year>\\d+)/(?<month>\\d+)/(?<article>.*)\" If the URI path is /articles/news/2017/06/xyz.html, then substring \"2017\" is captured in variable year, \"06\" is captured in variable month, and \"xyz.html\" is captured in variable article. These variables can then be used in an LBRuleAction field which supports variables, such as uri field of LBHttpRequestUriRewriteAction. For example, set the uri field of LBHttpRequestUriRewriteAction as: \"/articles/news/$year-$month-$article\" Then the URI path /articles/news/2017/06/xyz.html is rewritten to: \"/articles/news/2017-06-xyz.html\"

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LBHttpRequestUriCondition.Builder
Builder class for LBHttpRequestUriCondition.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`_TYPE_IDENTIFIER` Identifier denoting this class, when it is used in polymorphic context.
`static java.lang.String`	`MATCH_TYPE_CONTAINS`
`static java.lang.String`	`MATCH_TYPE_ENDS_WITH`
`static java.lang.String`	`MATCH_TYPE_EQUALS`
`static java.lang.String`	`MATCH_TYPE_REGEX`
`static java.lang.String`	`MATCH_TYPE_STARTS_WITH`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`LBHttpRequestUriCondition()` Default constructor.
`protected`	`LBHttpRequestUriCondition(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 LBHttpRequestUriCondition`	`_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 LBHttpRequestUriCondition`	`_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.Boolean`	`getCaseSensitive()` If true, case is significant when comparing URI.
`java.lang.Boolean`	`getInverse()` A flag to indicate whether reverse the match result of this condition
`java.lang.String`	`getMatchType()` Possible values are: `MATCH_TYPE_STARTS_WITH` `MATCH_TYPE_ENDS_WITH` `MATCH_TYPE_EQUALS` `MATCH_TYPE_CONTAINS` `MATCH_TYPE_REGEX` Match type of URI
`java.lang.String`	`getType()` Possible values are: `LBRuleCondition.TYPE_LBHTTPREQUESTURICONDITION` `LBRuleCondition.TYPE_LBHTTPREQUESTHEADERCONDITION` `LBRuleCondition.TYPE_LBHTTPREQUESTMETHODCONDITION` `LBRuleCondition.TYPE_LBHTTPREQUESTURIARGUMENTSCONDITION` `LBRuleCondition.TYPE_LBHTTPREQUESTVERSIONCONDITION` `LBRuleCondition.TYPE_LBHTTPREQUESTCOOKIECONDITION` `LBRuleCondition.TYPE_LBHTTPREQUESTBODYCONDITION` `LBRuleCondition.TYPE_LBHTTPRESPONSEHEADERCONDITION` `LBRuleCondition.TYPE_LBTCPHEADERCONDITION` `LBRuleCondition.TYPE_LBIPHEADERCONDITION` `LBRuleCondition.TYPE_LBVARIABLECONDITION` `LBRuleCondition.TYPE_LBHTTPSSLCONDITION` `LBRuleCondition.TYPE_LBSSLSNICONDITION` Type of load balancer rule condition The value of this property is automatically populated to `"LBHttpRequestUriCondition"`.
`java.lang.String`	`getUri()` A string used to identify resource
`int`	`hashCode()`
`void`	`setCaseSensitive(java.lang.Boolean caseSensitive)` If true, case is significant when comparing URI.
`void`	`setInverse(java.lang.Boolean inverse)` A flag to indicate whether reverse the match result of this condition
`void`	`setMatchType(java.lang.String matchType)` Possible values are: `MATCH_TYPE_STARTS_WITH` `MATCH_TYPE_ENDS_WITH` `MATCH_TYPE_EQUALS` `MATCH_TYPE_CONTAINS` `MATCH_TYPE_REGEX` Match type of URI
`void`	`setUri(java.lang.String uri)` A string used to identify resource
`java.lang.String`	`toString()`

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

- Field Detail
  - _TYPE_IDENTIFIER
```
public static final java.lang.String _TYPE_IDENTIFIER
```
    Identifier denoting this class, when it is used in polymorphic context.
    This value should be assigned to the property which is used to discriminate the actual type used in the polymorphic context.
    
    See Also:
    
    Constant Field Values
  - MATCH_TYPE_STARTS_WITH
```
public static final java.lang.String MATCH_TYPE_STARTS_WITH
```
    See Also:
    
    Constant Field Values
  - MATCH_TYPE_ENDS_WITH
```
public static final java.lang.String MATCH_TYPE_ENDS_WITH
```
    See Also:
    
    Constant Field Values
  - MATCH_TYPE_EQUALS
```
public static final java.lang.String MATCH_TYPE_EQUALS
```
    See Also:
    
    Constant Field Values
  - MATCH_TYPE_CONTAINS
```
public static final java.lang.String MATCH_TYPE_CONTAINS
```
    See Also:
    
    Constant Field Values
  - MATCH_TYPE_REGEX
```
public static final java.lang.String MATCH_TYPE_REGEX
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - LBHttpRequestUriCondition
```
public LBHttpRequestUriCondition()
```
    Default constructor.
  - LBHttpRequestUriCondition
```
protected LBHttpRequestUriCondition(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getCaseSensitive
```
public java.lang.Boolean getCaseSensitive()
```
    If true, case is significant when comparing URI.
    
    Returns:
    
    The current value of the property.
  - setCaseSensitive
```
public void setCaseSensitive(java.lang.Boolean caseSensitive)
```
    If true, case is significant when comparing URI.
    
    Parameters:
    
    caseSensitive - New value for the property.
  - getMatchType
```
public java.lang.String getMatchType()
```
    Possible values are:
    Match type of URI
    Returns:
    
    The current value of the property.
  - setMatchType
```
public void setMatchType(java.lang.String matchType)
```
    Possible values are:
    Match type of URI
    Parameters:
    
    matchType - New value for the property.
  - getUri
```
public java.lang.String getUri()
```
    A string used to identify resource
    
    Returns:
    
    The current value of the property.
  - setUri
```
public void setUri(java.lang.String uri)
```
    A string used to identify resource
    
    Parameters:
    
    uri - New value for the property.
  - getInverse
```
public java.lang.Boolean getInverse()
```
    A flag to indicate whether reverse the match result of this condition
    
    Returns:
    
    The current value of the property.
  - setInverse
```
public void setInverse(java.lang.Boolean inverse)
```
    A flag to indicate whether reverse the match result of this condition
    
    Parameters:
    
    inverse - New value for the property.
  - getType
```
public java.lang.String getType()
```
    Possible values are:
    Type of load balancer rule condition The value of this property is automatically populated to "LBHttpRequestUriCondition".
    Returns:
    
    The current value of 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 LBHttpRequestUriCondition _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 LBHttpRequestUriCondition _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class LBHttpRequestUriCondition

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_TYPE_IDENTIFIER

MATCH_TYPE_STARTS_WITH

MATCH_TYPE_ENDS_WITH

MATCH_TYPE_EQUALS

MATCH_TYPE_CONTAINS

MATCH_TYPE_REGEX

__dynamicStructureFields

Constructor Detail

LBHttpRequestUriCondition

LBHttpRequestUriCondition

Method Detail

getCaseSensitive

setCaseSensitive

getMatchType

setMatchType

getUri

setUri

getInverse

setInverse

getType

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2