Package com.vmware.nsx_policy.model
Class LBHttpRequestHeaderCondition
- java.lang.Object
-
- com.vmware.nsx_policy.model.LBHttpRequestHeaderCondition
-
- All Implemented Interfaces:
com.vmware.vapi.bindings.StaticStructure
,com.vmware.vapi.bindings.Structure
,java.io.Serializable
public final class LBHttpRequestHeaderCondition extends java.lang.Object implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
This condition is used to match HTTP request messages by HTTP header fields. HTTP header fields are components of the header section of HTTP request and response messages. They define the operating parameters of an HTTP transaction. For example, Cookie, Authorization, User-Agent, etc. One condition can be used to match one header field, to match multiple header fields, multiple conditions must be specified. The match_type field defines how header_value field is used to match HTTP requests. The header_name field does not support match types.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
LBHttpRequestHeaderCondition.Builder
Builder class forLBHttpRequestHeaderCondition
.
-
Field Summary
Fields Modifier and Type Field 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 Description LBHttpRequestHeaderCondition()
Default constructor.protected
LBHttpRequestHeaderCondition(com.vmware.vapi.data.StructValue __dynamicStructureFields)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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 LBHttpRequestHeaderCondition
_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 LBHttpRequestHeaderCondition
_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 HTTP header value.java.lang.String
getHeaderName()
Name of HTTP headerjava.lang.String
getHeaderValue()
Value of HTTP headerjava.lang.Boolean
getInverse()
A flag to indicate whether reverse the match result of this conditionjava.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 HTTP header valuejava.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"LBHttpRequestHeaderCondition"
.int
hashCode()
void
setCaseSensitive(java.lang.Boolean caseSensitive)
If true, case is significant when comparing HTTP header value.void
setHeaderName(java.lang.String headerName)
Name of HTTP headervoid
setHeaderValue(java.lang.String headerValue)
Value of HTTP headervoid
setInverse(java.lang.Boolean inverse)
A flag to indicate whether reverse the match result of this conditionvoid
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 HTTP header valuejava.lang.String
toString()
-
-
-
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
-
-
Method Detail
-
getCaseSensitive
public java.lang.Boolean getCaseSensitive()
If true, case is significant when comparing HTTP header value.- Returns:
- The current value of the property.
-
setCaseSensitive
public void setCaseSensitive(java.lang.Boolean caseSensitive)
If true, case is significant when comparing HTTP header value.- Parameters:
caseSensitive
- New value for the property.
-
getHeaderName
public java.lang.String getHeaderName()
Name of HTTP header- Returns:
- The current value of the property.
-
setHeaderName
public void setHeaderName(java.lang.String headerName)
Name of HTTP header- Parameters:
headerName
- New value for the property.
-
getHeaderValue
public java.lang.String getHeaderValue()
Value of HTTP header- Returns:
- The current value of the property.
-
setHeaderValue
public void setHeaderValue(java.lang.String headerValue)
Value of HTTP header- Parameters:
headerValue
- New value for the property.
-
getMatchType
public java.lang.String getMatchType()
Possible values are: Match type of HTTP header value- Returns:
- The current value of the property.
-
setMatchType
public void setMatchType(java.lang.String matchType)
Possible values are: Match type of HTTP header value- Parameters:
matchType
- 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:-
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
"LBHttpRequestHeaderCondition"
.- Returns:
- The current value of the property.
-
-
_getType
public com.vmware.vapi.bindings.type.StructType _getType()
- Specified by:
_getType
in interfacecom.vmware.vapi.bindings.StaticStructure
-
_getDataValue
public com.vmware.vapi.data.StructValue _getDataValue()
- Specified by:
_getDataValue
in interfacecom.vmware.vapi.bindings.Structure
-
_updateDataValue
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
-
_validate
public void _validate()
- Specified by:
_validate
in interfacecom.vmware.vapi.bindings.StaticStructure
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Specified by:
toString
in interfacecom.vmware.vapi.bindings.StaticStructure
- Overrides:
toString
in classjava.lang.Object
-
_hasTypeNameOf
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
- Specified by:
_hasTypeNameOf
in interfacecom.vmware.vapi.bindings.Structure
-
_convertTo
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
- Specified by:
_convertTo
in interfacecom.vmware.vapi.bindings.Structure
-
_setDynamicField
public void _setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)
- Specified by:
_setDynamicField
in interfacecom.vmware.vapi.bindings.StaticStructure
-
_getDynamicField
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
- Specified by:
_getDynamicField
in interfacecom.vmware.vapi.bindings.StaticStructure
-
_getDynamicFieldNames
public java.util.Set<java.lang.String> _getDynamicFieldNames()
- Specified by:
_getDynamicFieldNames
in interfacecom.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 thisStructure
.
-
_getCanonicalName
public java.lang.String _getCanonicalName()
- Specified by:
_getCanonicalName
in interfacecom.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 LBHttpRequestHeaderCondition _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 LBHttpRequestHeaderCondition _newInstance2(com.vmware.vapi.data.StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.
-
-